Skip to main content
POST
Fetch every video of a batch

Request

Send a POST request to below endpoint to return every request of a batch. Where {id} is the batch_id returned by the Video Batch endpoint. This endpoint does not generate new video, it reports the current state of the batch.
curl

Body

json

Response

status is processing while any request is still running, success once every request has succeeded, and failed once every request has failed. output collects every finished video across the batch, in request order, so it grows as videos land. Each entry in results is the same body the single Fetch Video endpoint returns for that request, plus its index and track_id.
json
A failed entry carries refunded: true when its charge was reversed, which is the case for every request the 8-minute batch timeout fails. An unknown batch_id, or one that belongs to another account, answers:
json

Path Parameters

id
integer<int64>
required

The batch_id returned by POST /video/batch

Body

application/json
key
string
required

Your API Key used for request authorization

Response

Batch status. An unknown batch id answers status failed with message "Batch not found".

Keyed like a single video response (status, id, output, message, tip) with the batch fields on top

status
enum<string>

processing on submit and while any request is still running; success once all succeeded; failed once all failed

Available options:
processing,
success,
failed
id
integer

The batch id. Same value as batch_id; drawn from the same counter as video ids so the two never collide

batch_id
integer
message
string
tip
string
output
string<uri>[]

Every finished video across the batch in request order; empty on submit

On submit: the URL every request will publish to, in request order

fetch_result
string<uri>

On submit: URL to poll the whole batch

eta
integer

On submit: the largest per-request estimate, in seconds

meta
object

On submit: the envelope inputs (model_id, track_id, webhook)

timeout_minutes
integer

On submit: requests not finished by then are failed and refunded

discount
number

On submit: fraction taken off every request's single-request price

request_counts
object
results
object[]