Skip to main content

API Platform

The API Platform is the developer-facing layer of TFI Studio. It exposes project discovery, job submission, polling, retriggering, and signed output delivery, while the studio remains the operational control plane behind those workflows.

Core capabilities

  • API-key authentication with account-scoped access
  • Project discovery for active branded workflows
  • Mapping-field discovery so clients can build forms dynamically
  • Async job creation and retrieval for queued workflows
  • Signed URL generation for secure output delivery

Operational advantages

  • Brand logic stays in projects rather than hardcoded in every client integration
  • Async processing and retriggering reduce operational fragility
  • Studio-side monitoring and billing keep engineering and operations aligned

Common integration pattern

  1. Authenticate with x-api-key
  2. Discover active projects
  3. Fetch mapping fields for the selected project
  4. Submit a job to /jobs/v2
  5. Poll the job and generate a signed URL for output delivery

Best-fit teams

  • Product engineering teams embedding media generation in applications
  • Internal platform teams building brand-safe campaign tooling
  • Agencies automating client delivery through a shared integration layer