Soniox
Docs
API reference/REST API/Transcriptions

Get transcription

Retrieves detailed information about a specific transcription.

GET
/v1/transcriptions/{transcription_id}

Headers

AuthorizationRequiredBearer <SONIOX_API_KEY>

Path parameters

transcription_idRequiredstring
Format: "uuid"

Response

200

Transcription details.

idRequiredstring

Unique identifier for the transcription request.

Format: "uuid"
statusRequiredstring

Transcription status.

Accepted values: "queued" | "processing" | "completed" | "error"
created_atRequiredstring

UTC timestamp indicating when the transcription was created.

Format: "date-time"
modelRequiredstring

Speech-to-text model used for the transcription.

audio_urlstring

URL of the file being transcribed.

file_idstring

ID of the file being transcribed.

Format: "uuid"
filenameRequiredstring

Name of the file being transcribed.

language_hintsarray<string>

Expected languages in the audio. If not specified, languages are automatically detected.

enable_speaker_diarizationRequiredboolean

When true, speakers are identified and separated in the transcription output.

contextstring

Additional context to improve transcription accuracy and formatting of specialized terms.

audio_duration_msinteger

Duration of the audio in milliseconds. Only available after processing begins.

error_messagestring

Error message if transcription failed. null for successful or in-progress transcriptions.

webhook_urlstring

URL to receive webhook notifications when transcription is completed or fails.

webhook_auth_header_namestring

Name of the authentication header sent with webhook notifications.

webhook_auth_header_valuestring

Authentication header value. Always returned masked as ******************.

webhook_status_codeinteger

HTTP status code received from your server when webhook was delivered. null if not yet sent.

client_reference_idstring

Tracking identifier string.

Errors

Transcription details.

{
  "id": "73d4357d-cad2-4338-a60d-ec6f2044f721",
  "status": "completed",
  "created_at": "2024-11-26T00:00:00Z",
  "model": "stt-async-preview",
  "audio_url": "https://soniox.com/media/examples/coffee_shop.mp3",
  "file_id": null,
  "filename": "coffee_shop.mp3",
  "language_hints": [
    "en",
    "fr"
  ],
  "context": "extra context for the transcription",
  "audio_duration_ms": 16079,
  "error_message": null,
  "webhook_url": "https://example.com/webhook",
  "webhook_auth_header_name": "Authorization",
  "webhook_auth_header_value": "******************",
  "webhook_status_code": null,
  "client_reference_id": "some_internal_id"
}

Delete transcription DELETE

Permanently deletes a transcription and its associated files. Cannot delete transcriptions that are currently processing.

Get transcription transcript GET

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