Sign in

v1

latestOpenAPI 3.0.1Proprietary and protectedraw.githubusercontent.com2026-05-062893.1 KB
V3Transcriptions

Creates a new transcription from either a sourceId or a mediaUrl. Either sourceId or mediaUrl must be provided, but not both.

post/v3/Transcriptions

Headers

Idempotency-Keystring
Example:01926e40-a5e2-7000-8000-2b2c5a4e5d7b

A unique key to ensure idempotency. We recommend using UUID v7. Requests with the same key within the idempotency window return the original response.

Request body

OR

Example request

{
  "transcriptionConfigurationId": "voice_transcriptionconfiguration_5pe8jw3ahdmsh7zr06yh4d45x1",
  "inputSource": "SOURCE_ID",
  "sourceId": "RExxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "participants": [
    {
      "type": "CUSTOMER",
      "address": "+15551234567",
      "name": "Jane Doe",
      "audioChannelIndex": 1
    }
  ]
}

Response

Transcription request accepted and will be processed asynchronously. Poll the statusUrl (or Location header) to track progress.

status'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED' required

Current status of the long-running operation. PENDING: accepted but not yet started. RUNNING: currently in progress. COMPLETED: successfully completed. FAILED: failed and cannot be completed.

statusUrlstring uri required

URI to poll for operation status. Mirrors the Location response header. Provided as a body field for programmatic access by JSON-parsing clients (RFC 9110 Section 15.3.3).

Example response

{
  "status": "PENDING",
  "statusUrl": "https://voice.twilio.com/v3/Transcriptions/voice_transcription_5pe8jw3ahdmsh7zr06yh4d45x1",
  "transcription": {
    "id": "voice_transcription_5pe8jw3ahdmsh7zr06yh4d45x1",
    "accountId": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "status": "PENDING",
    "transcriptionConfigurationId": "voice_transcriptionconfiguration_5pe8jw3ahdmsh7zr06yh4d45x1",
    "mediaUrl": "http://mymedia.com",
    "sourceId": "RExxxxx",
    "audioStartedAt": "2025-11-19T19:42:16Z",
    "conversationId": "conv_conversation_01k1etx3jbfx88476ccja0889c",
    "participants": [
      {
        "type": "CUSTOMER",
        "address": "+15551234567",
        "name": "Jane Doe",
        "audioChannelIndex": 1
      }
    ],
    "duration": 1000,
    "resolvedConfiguration": {
      "transcriptionEngine": "deepgram",
      "speechModel": "nova-3",
      "language": "multi",
      "transcriptionStatusCallback": {
        "url": "https://example.com/transcriptions/default-webhook",
        "method": "POST",
        "events": [
          "COMPLETED"
        ]
      },
      "conversationConfigurationId": "conv_configuration_01k1etx3jbfx88476ccja0889c",
      "participantDefaults": [
        {
          "audioChannelIndex": 1,
          "type": "CUSTOMER"
        }
      ]
    },
    "createdAt": "2025-11-19T19:42:16Z",
    "updatedAt": "2025-11-19T19:42:16Z",
    "url": "https://voice.twilio.com/v3/Transcriptions/voice_transcription_5pe8jw3ahdmsh7zr06yh4d45x1"
  }
}