API reference
Transcribe audio
POST
Submit a transcription job. The audio is an https URL in the JSON body, not a file upload.
bearerAuthheader
AuthorizationBearer <token>Your API key, sent as Authorization: Bearer <key>.
Idempotency-Key?stringAny string you choose. A retry with the same key and body returns the first result instead of running again. The same key with a different body is a 409 idempotency_conflict.
model plus the inputs the model accepts, at the top level. Each model's inputs are listed on its page under /models.
application/json- body
model*stringmodels?array<string>Items
items <= 5retry_of?stringThe id of an earlier job this one retries.
provider?How the request is routed. Each option can only narrow it.
op?[key: string]?anyThe job was accepted and is stored. Poll it or wait for the webhook.
application/json- response
id*stringgeneration_id*stringobject*stringstate*stringValue in
"queued""processing""succeeded""failed""canceled"modality*stringmodel*stringcreated_at*stringFormat
date-timestarted_at?stringFormat
date-timecompleted_at?stringFormat
date-timeprogress*output?array<>usage?error?retry_of?stringop_metadata*curl -X POST "https://example.com/v1/audio/transcriptions" \ -H "Authorization: Bearer $OP_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "model": "string" }'{ "id": "string", "generation_id": "string", "object": "job", "state": "queued", "modality": "string", "model": "string", "created_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z", "progress": { "percent": 0, "phase": "string", "queue_position": 0 }, "output": [ { "url": "string", "url_expires_at": "2019-08-24T14:15:22Z", "type": "string", "bytes": 0, "checksum_sha256": "string", "purged_at": "2019-08-24T14:15:22Z" } ], "usage": { "units": { "property1": 0, "property2": 0 }, "cost": { "billing_usd": 0, "cost_source": "string", "cost_status": "string", "price_version": "string" } }, "error": { "code": "string", "kind": "string", "scope": "string", "message": "string" }, "retry_of": "string", "op_metadata": { "generation_id": "string", "requested_model": "string", "retention_class": "string", "region": "string", "policy": [ "string" ] }}