Sign in

v1

latestOpenAPI 3.0.12026-07-2649123153.6 KB
/api/v1/transcription/session

Create transcription session

Creates a transcription session for real-time speech-to-text over WebSocket. Returns a transcription_session_id to use when connecting to /ws/transcribe.

post/api/v1/transcription/session/create

Headers

sdp_provider_idstring
Example:provider-123

Optional for standard partners.

Required for:

  • Bearer authentication. Use the same provider_id returned by the Login or Register API.
  • Single Auth Token authentication. Include the same provider_id on every request as sdp_provider_id.

Request body

transcription_session_idstring

Optional - UUID format. If not provided, a session ID will be automatically generated.

Example request

{
  "audio_config": {
    "audio_encoding": "LINEAR16",
    "audio_language": "en-US",
    "sample_rate_hertz": 16000
  },
  "transcription_session_id": "123dfg-456dfg-789dfg-012dfg"
}

Response

Resource created successfully.

transcription_session_idstring

Unique identifier for the transcription session

Example response

{
  "transcription_session_id": "123dfg-456dfg-789dfg-012dfg"
}