v1

latestOpenAPI 3.1.02026-07-2665164286.3 KB

Batches

Create Video Batch

Submit up to 100 video creation payloads in one request and return a batch id immediately. Videos are created asynchronously; poll GET /v3/videos/batches/{batch_id} for per-item video ids and statuses.

post/v3/videos/batches

Headers

Idempotency-Keystring

Optional client-supplied key for safely retrying mutations. Subsequent calls within 24 hours that share this key replay the original response — even if the request body differs slightly (a warning is logged). A retry that arrives while the original is still in flight gets a 409 request_in_progress. Keys must be 1–255 characters from [A-Za-z0-9_:.-]; a UUID is a safe default. Scope is per-endpoint and per-resource: the same key on a different route or path parameter is independent.

Request body

titlestring nullable

Display name for the batch, shown in the HeyGen app.

callback_urlstring nullable

Webhook URL invoked once when every item in the batch reaches a terminal state.

Response

Accepted — submission acknowledged; poll for completion.