jobs

Submit one source

post/v1/jobs

Request

  • Base URL: https://api.transcriptdock.com
  • URL: https://api.transcriptdock.com/v1/jobs
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sb-access-token

Headers

Idempotency-Keystring required

Workspace plus endpoint scoped replay key, 8 to 128 ASCII chars

Request body

mode'captions_only' | 'auto' | 'transcribe' required
languagestring nullable

Only applies to AI transcription (auto/transcribe).

caption_languagesstring[]

BCP 47 tags in preference order for the caption track, e.g. ["en", "es"]. Empty means the video default.

caption_preference'prefer_creator' | 'creator_only' | 'automatic_only'
recognition_profile'standard'

Only applies to AI transcription (auto/transcribe).

max_creditsinteger

Optional ceiling in credits for auto/transcribe. AI transcription costs transcribe_credits_per_minute per started minute after minimum_billable_seconds (see GET /v1/capabilities); a job whose measured cost exceeds the ceiling fails with BUDGET_EXCEEDED before any provider spend. Default covers max_duration_ms. Ignored for captions_only.

webhook_endpoint_idstring uuid nullable

Endpoint from POST /v1/webhooks that receives job.succeeded / job.failed for this job.

metadataobject

Response

Reused a retained same workspace result for free

idstring uuid required

Job id; use with GET /v1/jobs/{id}.

status'queued' | 'processing' | 'awaiting_provider' | 'succeeded' | 'failed' | 'cancelled' required
stage'resolve' | 'captions' | 'acquire_audio' | 'submit_asr' | 'wait_asr' | 'finalize' | 'null' nullable required

Current pipeline step while in flight; null once final.

result_idstring uuid nullable required

Transcript id once status is succeeded; fetch with GET /v1/transcripts/{id}. Null otherwise.

created_atstring date-time required

Submission time, UTC.

Changes

No recorded changes to this operation across all 1 revision of this API.