Skip to main content
Use the API reference when you need exact request fields, response schemas, and endpoint behavior.

Base URL

Authentication

Send your API key in the Authorization header as a bearer token.

Core endpoints

  • POST /v1/files creates an upload slot for an asset.
  • POST /v1/jobs creates an asynchronous FFmpeg or FFprobe job.
  • GET /v1/jobs lists your jobs.
  • GET /v1/jobs/{id} returns job details.
  • GET /v1/jobs/{id}/result returns the terminal result payload.
  • POST /v1/webhooks/test sends a signed test callback to your endpoint.

Response model

Most workflows follow the same pattern:
  1. Create a resource with POST.
  2. Receive a JSON response immediately.
  3. Poll job endpoints or receive a webhook when processing completes.
The endpoint pages in this tab are generated from the same OpenAPI document that is produced from the server-side schemas.