Sign in
Jobs

Create a job (generic)

Create a new media processing job. Specify the job type, input files, and processing parameters. Use GET /jobs/types to discover available types.

post/jobs

Request body

typestring required

Job type identifier (e.g., watermark.apply, transcode)

inputsobject

Input files (e.g., { source: 'https://...' })

paramsobject

Job-specific parameters (validated per job type)

forceAsyncboolean

Force async dispatch even for sync-eligible job types

idempotencyKeystring

Idempotency key to prevent duplicate job creation

destinationsstring[]

Where to deliver the output once the job completes, as storage://<id>[/<folder or path template>]. A bare id uses the connection's output path template. A folder (storage://prod-media/exports) keeps that template's file name inside the folder. A path containing a token ({job_id} {ext} {source_name} {date}) or ending in a file name is used as written.

Response

Job completed synchronously or duplicate (idempotent)

idstring required

Job ID

status'complete' required

Completed synchronously

urlstring

Data URL of the result

Changes