Skip to main content
POST
Create a batch
Attach one file per request, or submit up to 100 URL inputs. You can mix one upload with up to 99 URLs. Default limits are 3 hours and 1 GiB per recording, with a 512 KiB manifest. See Batch limits for request limits and per-file failure behavior.

Authorizations

chariotai-api-key
string
header
required

Your Chariot API key, generated from the dashboard. Send it in the chariotai-api-key header on every request.

Headers

Idempotency-Key
string

Reuse the same key and identical manifest and file bytes to recover the original batch after a submission timeout. A changed request with the same key returns 409.

Maximum string length: 128

Body

inputs
BatchInput · object[]
required
Required array length: 1 - 100 elements
webhook_url
string | null
Maximum string length: 2048
webhook_events
enum<string>[]
Available options:
transcription.completed,
transcription.failed,
transcription.cancelled,
batch.completed,
batch.partially_completed,
batch.failed,
batch.cancelled

Response

Accepted.

id
string<uuid>
required
status
enum<string>
required
Available options:
queued,
processing,
cancelling,
completed,
partially_completed,
failed,
cancelled
created_at
string<date-time>
required
started_at
string<date-time> | null
required
finished_at
string<date-time> | null
required
cancel_requested_at
string<date-time> | null
required
counts
Counts · object
required
items_url
string
required
items
BatchItemReference · object[]
required

Input-to-transcription ID mapping in submission order. Preserved on matching idempotent retries.

webhook_signing_secret
string | null