Soniox
Docs
API referenceREST APITranscriptions

Get transcription transcript

Retrieves the full transcript text and detailed tokens for a completed transcription. Only available for successfully completed transcriptions.

GET
/v1/transcriptions/{transcription_id}/transcript

Headers

AuthorizationRequiredBearer <SONIOX_API_KEY>

Path parameters

transcription_idRequiredstring
Format: "uuid"

Response

200

Transcription transcript.

idRequiredstring

Unique identifier of the transcription this transcript belongs to.

Format: "uuid"
textRequiredstring

Complete transcribed text content.

tokensRequiredarray<object>

List of detailed token information with timestamps and metadata.

Errors

Transcription transcript.

{
  "id": "19b6d61d-02db-4c25-bc71-b4094dc310c8",
  "text": "Hello",
  "tokens": [
    {
      "text": "Hel",
      "start_ms": 10,
      "end_ms": 90,
      "confidence": 0.95
    },
    {
      "text": "lo",
      "start_ms": 110,
      "end_ms": 160,
      "confidence": 0.98
    }
  ]
}

Authentication error.

{
  "status_code": 401,
  "error_type": "unauthenticated",
  "message": "Incorrect API key provided. You can get an API key at https://console.soniox.com",
  "validation_errors": [],
  "request_id": "3d37a3bd-5078-47ee-a369-b204e3bbedda"
}

Transcription not found.

Error types:

  • transcription_not_found: Transcription could not be found.

{
  "status_code": 400,
  "error_type": "transcription_not_found",
  "message": "Transcription could not be found.",
  "validation_errors": [],
  "request_id": "3d37a3bd-5078-47ee-a369-b204e3bbedda"
}

Invalid transcription state.

Error types:

  • transcription_invalid_state:
    • Can only get transcript with completed status.
    • File transcription has failed.
    • Transcript no longer available.

{
  "status_code": 400,
  "error_type": "transcription_invalid_state",
  "message": "Can only get transcript with completed status.",
  "validation_errors": [],
  "request_id": "3d37a3bd-5078-47ee-a369-b204e3bbedda"
}

Internal server error.

{
  "status_code": 500,
  "error_type": "internal_error",
  "message": "The server encountered an error. Please try again. If the issue persists contact support@soniox.com.",
  "validation_errors": [],
  "request_id": "3d37a3bd-5078-47ee-a369-b204e3bbedda"
}