API Documentation
Upload
Pre-recorded endpoints
Live endpoints
Live WS actions
Live WS messages
- Realtime messages
- Post-processing messages
- Acknowledgment messages
- Lifecycle messages
Live callbacks
- Realtime messages
- Post-processing messages
- Acknowledgment messages
- Lifecycle messages
Live webhooks
- Lifecycle messages
Live endpoints
Initiate a session
Initiate a live transcription job. Use the returned ws url
to connect to the websocket and start sending audio chunks. Use the returned id
and the GET /v2/live/:id endpoint to obtain the status and results.
POST
/
v2
/
live
curl --request POST \
--url https://api.gladia.io/v2/live \
--header 'Content-Type: application/json' \
--header 'x-gladia-key: <api-key>' \
--data '{
"encoding": "wav/pcm",
"bit_depth": 16,
"sample_rate": 16000,
"channels": 1,
"custom_metadata": {
"user": "John Doe"
},
"model": "solaria-1",
"endpointing": 0.05,
"maximum_duration_without_endpointing": 5,
"language_config": {
"languages": [],
"code_switching": false
},
"pre_processing": {
"audio_enhancer": false,
"speech_threshold": 0.6
},
"realtime_processing": {
"words_accurate_timestamps": false,
"custom_vocabulary": false,
"custom_vocabulary_config": {
"vocabulary": [
"Westeros",
{
"value": "Stark"
},
{
"value": "Night'\''s Watch",
"pronunciations": [
"Nightz Watch"
],
"intensity": 0.4,
"language": "en"
}
],
"default_intensity": 0.5
},
"custom_spelling": false,
"custom_spelling_config": {
"spelling_dictionary": {
"Gettleman": [
"gettleman"
],
"SQL": [
"Sequel"
]
}
},
"translation": false,
"translation_config": {
"target_languages": [
"en"
],
"model": "base",
"match_original_utterances": true,
"lipsync": true
},
"named_entity_recognition": false,
"sentiment_analysis": false
},
"post_processing": {
"summarization": false,
"summarization_config": {
"type": "general"
},
"chapterization": false
},
"messages_config": {
"receive_final_transcripts": true,
"receive_speech_events": true,
"receive_pre_processing_events": true,
"receive_realtime_processing_events": true,
"receive_post_processing_events": true,
"receive_acknowledgments": true,
"receive_errors": true,
"receive_lifecycle_events": false
},
"callback": false,
"callback_config": {
"url": "https://callback.example",
"receive_final_transcripts": true,
"receive_speech_events": false,
"receive_pre_processing_events": true,
"receive_realtime_processing_events": true,
"receive_post_processing_events": true,
"receive_acknowledgments": false,
"receive_errors": false,
"receive_lifecycle_events": true
}
}'
{
"id": "45463597-20b7-4af7-b3b3-f5fb778203ab",
"url": "wss://api.gladia.io/v2/live?token=4a39145c-2844-4557-8f34-34883f7be7d9"
}
Authorizations
Your personal Gladia API key
Body
application/json
Response
201
application/json
The live job has been initiated
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.gladia.io/v2/live \
--header 'Content-Type: application/json' \
--header 'x-gladia-key: <api-key>' \
--data '{
"encoding": "wav/pcm",
"bit_depth": 16,
"sample_rate": 16000,
"channels": 1,
"custom_metadata": {
"user": "John Doe"
},
"model": "solaria-1",
"endpointing": 0.05,
"maximum_duration_without_endpointing": 5,
"language_config": {
"languages": [],
"code_switching": false
},
"pre_processing": {
"audio_enhancer": false,
"speech_threshold": 0.6
},
"realtime_processing": {
"words_accurate_timestamps": false,
"custom_vocabulary": false,
"custom_vocabulary_config": {
"vocabulary": [
"Westeros",
{
"value": "Stark"
},
{
"value": "Night'\''s Watch",
"pronunciations": [
"Nightz Watch"
],
"intensity": 0.4,
"language": "en"
}
],
"default_intensity": 0.5
},
"custom_spelling": false,
"custom_spelling_config": {
"spelling_dictionary": {
"Gettleman": [
"gettleman"
],
"SQL": [
"Sequel"
]
}
},
"translation": false,
"translation_config": {
"target_languages": [
"en"
],
"model": "base",
"match_original_utterances": true,
"lipsync": true
},
"named_entity_recognition": false,
"sentiment_analysis": false
},
"post_processing": {
"summarization": false,
"summarization_config": {
"type": "general"
},
"chapterization": false
},
"messages_config": {
"receive_final_transcripts": true,
"receive_speech_events": true,
"receive_pre_processing_events": true,
"receive_realtime_processing_events": true,
"receive_post_processing_events": true,
"receive_acknowledgments": true,
"receive_errors": true,
"receive_lifecycle_events": false
},
"callback": false,
"callback_config": {
"url": "https://callback.example",
"receive_final_transcripts": true,
"receive_speech_events": false,
"receive_pre_processing_events": true,
"receive_realtime_processing_events": true,
"receive_post_processing_events": true,
"receive_acknowledgments": false,
"receive_errors": false,
"receive_lifecycle_events": true
}
}'
{
"id": "45463597-20b7-4af7-b3b3-f5fb778203ab",
"url": "wss://api.gladia.io/v2/live?token=4a39145c-2844-4557-8f34-34883f7be7d9"
}
Assistant
Responses are generated using AI and may contain mistakes.