Endpoint reference
Transcription
POST /v1/audio/transcribe · Synchronous
This route accepts strict JSON. Unknown fields, malformed values, wrong-operation keys, and package settings outside the locked configuration are rejected before provider execution.
Required headers
| Header | Value | Notes |
|---|---|---|
Authorization | Bearer $URTHEPRODUCT_API_KEY | Required. Must be sent from a trusted server. |
Idempotency-Key | 8–128 safe characters | Required on POST. Reuse only for retries of the same logical request. |
Content-Type | application/json | Required on POST. |
Request fields
| Field | Type | Required | Rules |
|---|---|---|---|
input_upload_id | upload ID | Yes | Verified, owned audio/video upload. |
language | language tag | No | Two/three-letter language with optional region. |
timestamps | enum | No | none or segment; package settings control acceptance. |
Request example
curl "https://urtheproduct.com/v1/audio/transcribe" \
+ -X POST \
+ -H "Authorization: Bearer $URTHEPRODUCT_API_KEY" \
+ -H "Idempotency-Key: logical-request-001" \
+ -H "Content-Type: application/json" \
+ -d '{ "input_upload_id": "upl_example_identifier", "language": "en", "timestamps": "segment"}'{
"input_upload_id": "upl_example_identifier",
"language": "en",
"timestamps": "segment"
}Success response
{
"id": "usage-event-id",
"object": "generation",
"operation": "audio.transcribe",
"output": { "text": "...", "segments": [] },
"usage": { "charged_units": 1, "remaining_units": 19 }
}Operation-specific behavior
- Complete the private upload flow before calling this route.
- Upload only audio/video you are authorized to process and disclose recording/transcription where required.
Failures and retries
Schema failures return 422 validation_error without charging quota. Wrong scope returns 403 forbidden. Rate/concurrency pressure returns 429 rate_limited. Provider safety pauses return 503 provider_unavailable. Follow the error and retry table and reuse the same idempotency key for the same logical request.