Get captions

Download the latest caption revision

GET https://api.el.ai/v1/jobs/{id}/captions

Authorization

Authorization header · string Required

Bearer el_live_…, a workspace API key. About keys

Path parameters

id string · uuid Required

Query parameters

format string

srt: timed SubRip captions; vtt: WebVTT for web players; txt: transcript grouped by speaker; docx: Word transcript; json: structured cues for rendering or search.

One of

srt
vtt
txt
docx
json

Default

srt
timestamps boolean

Include timestamps in txt/docx transcripts.

Default

false

Response · 200

application/x-subrip · text/vtt · text/plain · application/vnd.openxmlformats-officedocument.wordprocessingml.document · application/json

Latest revision. Word transcripts support English, Spanish and French. Download links require bearer authentication..

job_id string · uuid
language string · nullable
revision integer
captions array of object
- start number
- end number
- speaker string · nullable
- text string

Headers

request-id string

Support request identifier.
cache-control string

One of

no-store
ETag string

Quoted caption revision ID.
Content-Disposition string

Attachment filename, omitted for JSON.

Errors

Errors share one shape: an error object with a stable code and a human-readable message. See Errors and retries.

400	Invalid request
401	Missing, invalid or revoked API key
402	Insufficient funds or budget
403	Key or workspace does not allow this operation
404	Resource not found in this workspace
409	Conflict
413	JSON body exceeds 64 KiB
415	Unsupported content type
422	Media or format cannot be processed. A job cancelled for a duration mismatch returns unsupported_media.
429	Shared read limit per API key or write limit per workspace exceeded
500	Internal error
503	temporarily_unavailable: request limit enforcement is unavailable, or job submission is busy. Retry after 5 seconds.

curl "https://api.el.ai/v1/jobs/cec18557-248a-4916-938a-4cb386bedcb9/captions?format=srt" \
  -H "Authorization: Bearer $ECHO_API_KEY" \
  -o captions.srt

import os
import requests

response = requests.get(
    "https://api.el.ai/v1/jobs/cec18557-248a-4916-938a-4cb386bedcb9/captions",
    headers={
        "Authorization": f"Bearer {os.environ['ECHO_API_KEY']}",
    },
    params={
        "format": "srt",
    },
)
response.raise_for_status()
print(response.text)

const response = await fetch("https://api.el.ai/v1/jobs/cec18557-248a-4916-938a-4cb386bedcb9/captions?format=srt", {
  headers: {
    Authorization: `Bearer ${process.env.ECHO_API_KEY}`,
  },
});
const text = await response.text();
console.log(text);

Response

200

1
00:00:12,480 --> 00:00:15,900
[DR. OKAFOR] Let's start with consumer choice.

Error

{
  "error": {
    "code": "invalid_request",
    "message": "Send exactly one of media_url or upload_id.",
    "param": "media_url"
  }
}