v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB

Transcribe

Create a transcribe

Starts a transcription of the given reference (call, confbridge, or recording) and returns the result. Duplicate behavior differs by reference type: for a recording that already has a transcribe in the requested language, the existing transcribe is returned (200); for a call/confbridge that already has a progressing live transcribe in the requested language, the request is rejected with 409. Stop the existing transcribe first, or start with a different language.

post/transcribes

Request body

reference_type'unknown' | 'recording' | 'call' | 'confbridge' required

reference_idstring required

The ID of the reference for the transcription.

languagestring required

The language of the transcription.

direction'both' | 'in' | 'out'

provider'' | 'gcp' | 'aws'

on_end_flow_idstring uuid

The flow to execute when the transcription ends. The flow ID returned from the POST /flows or GET /flows response. If omitted, no follow-up flow is executed.

Example request

{
  "reference_type": "call",
  "direction": "both",
  "provider": "gcp",
  "on_end_flow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012"
}

Response

The created transcribe details.

idstring uuid

The unique identifier of the transcribe session. Returned from the POST /transcribes or GET /transcribes response.

customer_idstring uuid

The unique identifier of the customer who owns this transcribe session. Returned from the GET /customers response.

activeflow_idstring uuid

The unique identifier of the activeflow associated with this transcribe session. Returned from the POST /activeflows or GET /activeflows response.

on_end_flow_idstring uuid

The unique identifier of the flow to execute when the transcribe session ends. Returned from the POST /flows or GET /flows response.

reference_type'unknown' | 'recording' | 'call' | 'confbridge'

reference_idstring uuid

The unique identifier of the resource being transcribed (call, conference, or recording). Returned from the corresponding resource endpoint.

status'progressing' | 'done'

languagestring

BCP47 type's language code.

direction'both' | 'in' | 'out'

provider'' | 'gcp' | 'aws'

tm_createstring date-time

Timestamp when created

tm_updatestring date-time

Timestamp when updated

tm_deletestring date-time

Timestamp when deleted

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  "on_end_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "reference_type": "call",
  "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "progressing",
  "language": "en-US",
  "direction": "both",
  "provider": "gcp",
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-16T14:20:00.000000Z",
  "tm_delete": "2026-01-17T18:45:00.000000Z"
}