Skip to content

Transcription

Queue Transcription

POST /api/v1/recordings/{id}/transcribe

Queues a transcription job for the specified recording.

Request

{
"room_id": "room_abc123",
"provider": "whisper"
}
FieldTypeRequiredDescription
room_idstringYesID of the room
providerstringNoTranscription provider (uses default if not specified)

Response

{
"transcript_id": "txn_abc123",
"status": "pending"
}

Get Transcript by Recording ID

GET /api/v1/recordings/{id}/transcript

Retrieves the transcript for a specific recording.

Response

{
"data": {
"id": "txn_abc123",
"recording_id": "rec_abc123",
"room_id": "room_abc123",
"status": "completed",
"provider": "whisper",
"content": {
"segments": [
{
"start": 0.0,
"end": 5.2,
"text": "Welcome to today's lecture.",
"speaker": "speaker_1"
}
]
},
"created_at": "2026-01-06T12:00:00Z",
"completed_at": "2026-01-06T12:05:00Z"
}
}

Get Transcript by ID

GET /api/v1/transcription/{id}

Retrieves a transcript by its transcript ID.

Response

{
"data": {
"id": "txn_abc123",
"recording_id": "rec_abc123",
"room_id": "room_abc123",
"status": "completed",
"provider": "whisper",
"content": {
"segments": [
{
"start": 0.0,
"end": 5.2,
"text": "Welcome to today's lecture.",
"speaker": "speaker_1"
}
]
},
"created_at": "2026-01-06T12:00:00Z",
"completed_at": "2026-01-06T12:05:00Z"
}
}

List Providers

GET /api/v1/transcription/providers

Lists available transcription providers.

Response

{
"providers": [
{
"id": "whisper",
"name": "OpenAI Whisper",
"supported_languages": ["en", "es", "fr", "de", "ar"]
},
{
"id": "deepgram",
"name": "Deepgram",
"supported_languages": ["en", "es", "fr"]
}
],
"default_provider": "whisper"
}

List Room Transcripts

GET /api/v1/rooms/{id}/post-meeting-transcripts

Lists all post-meeting transcripts for a specific room.

Response

{
"data": [
{
"id": "txn_abc123",
"recording_id": "rec_abc123",
"status": "completed",
"provider": "whisper",
"created_at": "2026-01-06T12:00:00Z"
},
{
"id": "txn_def456",
"recording_id": "rec_def456",
"status": "pending",
"provider": "whisper",
"created_at": "2026-01-07T10:00:00Z"
}
]
}

Transcript Status

StatusDescription
pendingJob queued, waiting to start
processingTranscription in progress
completedTranscript ready
failedTranscription failed