Skip to main content
GET
Node.js

Authorizations

x-api-key
string
header
required

Path Parameters

jobId
string
required

The batch job ID

Query Parameters

limit
integer

Return at most this many results (with offset, pages through a completed batch). Omit both to receive all results in one streamed response.

Required range: 1 <= x <= 500
offset
integer

Skip this many results (in submission order) before returning a page.

Required range: x >= 0

Response

Successfully retrieved the status and results (if completed)

Response for batch job results

status
enum<string>
required

Current status of the batch job

Available options:
queued,
active,
completed,
failed
Example:

"completed"

results
object[]
required

Array of results for each video in the batch

stats
object
required

Statistics about the batch job progress

errorCode
enum<string>

Set to job-expired when the batch aged out before finishing; its results are no longer available.

Available options:
job-expired
Example:

"job-expired"

completedAt
string<date-time> | null

Timestamp when the job completed, if status is completed

Example:

"2025-04-03T06:59:53.428Z"