Jobs

Create a new job

Create a new video processing job with specified parameters. The job is created with pending status and waits for scheduler admission before processing. Pending jobs are admitted oldest first across all projects in the team as vCPU capacity becomes available.

POST
/api/jobs

Authorization

Authorization
header
string
required

Enter the project access token with the Bearer prefix, e.g. "Bearer project_access_token"

Bodyapplication/json

Job creation parameters

format
object
required

Required format configuration, one and only one valid format configuration must be provided. If you want to use a format without specifying any configuration, use an empty object in the corresponding field.

FFmpeg encoding parameters specific to MP4 with AV1 encoding.

source_id
string
required

The ID of the source file to transcode

Examples:
src_UioP9I876hjKlNBH78ILp0mo56t
hls_manifest_id
string

Optional HLS manifest configuration Use the same hls manifest ID to group multiple jobs into a single HLS manifest By default, it's automatically generated if no set for HLS jobs

Examples:
hls_2v6EIgcNAycdS5g0IUm0TXBjvHV
metadata
object

Optional metadata to attach to the job, the maximum size allowed is 2048 bytes

Examples:
map[key:value key2:value2]
storage
object

Optional storage configuration

transcoder
object

Optional transcoder configuration. If not provided, the system will automatically calculate the optimal quantity and CPU type based on the source file specifications and output requirements. This auto-scaling ensures efficient resource utilization.

Responses

application/json
data
object
required

Data contains the response object

status
"success"
string
required

Status indicates the response status "success"

The job was created successfully