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
Transcription (deprecated)
Initiate a transcription
(Deprecated) Prefer the more specific pre-recorded endpoint.
Initiate a pre-recorded transcription job. Use the returned id and the GET /v2/transcription/:id endpoint to obtain the results.
POST
https://api.gladia.io/
/
v2
/
transcription
curl --request POST \
--url https://api.gladia.io/v2/transcription \
--header 'Content-Type: application/json' \
--header 'x-gladia-key: <api-key>' \
--data '{
"context_prompt": "<string>",
"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
},
"detect_language": true,
"enable_code_switching": false,
"code_switching_config": {
"languages": []
},
"language": "en",
"callback_url": "http://callback.example",
"callback": false,
"callback_config": {
"url": "http://callback.example",
"method": "POST"
},
"subtitles": false,
"subtitles_config": {
"formats": [
"srt"
],
"minimum_duration": 1,
"maximum_duration": 15.5,
"maximum_characters_per_row": 2,
"maximum_rows_per_caption": 3,
"style": "default"
},
"diarization": false,
"diarization_config": {
"number_of_speakers": 2,
"min_speakers": 1,
"max_speakers": 2,
"enhanced": false
},
"translation": false,
"translation_config": {
"target_languages": [
"en"
],
"model": "base",
"match_original_utterances": true,
"lipsync": true
},
"summarization": false,
"summarization_config": {
"type": "general"
},
"moderation": false,
"named_entity_recognition": false,
"chapterization": false,
"name_consistency": false,
"custom_spelling": false,
"custom_spelling_config": {
"spelling_dictionary": {
"Gettleman": [
"gettleman"
],
"SQL": [
"Sequel"
]
}
},
"structured_data_extraction": false,
"structured_data_extraction_config": {
"classes": [
"Persons",
"Organizations"
]
},
"sentiment_analysis": false,
"audio_to_llm": false,
"audio_to_llm_config": {
"prompts": [
"Extract the key points from the transcription"
]
},
"custom_metadata": {},
"sentences": false,
"display_mode": false,
"punctuation_enhanced": false,
"language_config": {
"languages": [],
"code_switching": false
},
"audio_url": "http://files.gladia.io/example/audio-transcription/split_infinity.wav"
}'
{
"id": "45463597-20b7-4af7-b3b3-f5fb778203ab",
"result_url": "https://api.gladia.io/v2/transcription/45463597-20b7-4af7-b3b3-f5fb778203ab"
}
Authorizations
Your personal Gladia API key
Body
application/json
Response
201
application/json
The transcription job has been initiated
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.gladia.io/v2/transcription \
--header 'Content-Type: application/json' \
--header 'x-gladia-key: <api-key>' \
--data '{
"context_prompt": "<string>",
"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
},
"detect_language": true,
"enable_code_switching": false,
"code_switching_config": {
"languages": []
},
"language": "en",
"callback_url": "http://callback.example",
"callback": false,
"callback_config": {
"url": "http://callback.example",
"method": "POST"
},
"subtitles": false,
"subtitles_config": {
"formats": [
"srt"
],
"minimum_duration": 1,
"maximum_duration": 15.5,
"maximum_characters_per_row": 2,
"maximum_rows_per_caption": 3,
"style": "default"
},
"diarization": false,
"diarization_config": {
"number_of_speakers": 2,
"min_speakers": 1,
"max_speakers": 2,
"enhanced": false
},
"translation": false,
"translation_config": {
"target_languages": [
"en"
],
"model": "base",
"match_original_utterances": true,
"lipsync": true
},
"summarization": false,
"summarization_config": {
"type": "general"
},
"moderation": false,
"named_entity_recognition": false,
"chapterization": false,
"name_consistency": false,
"custom_spelling": false,
"custom_spelling_config": {
"spelling_dictionary": {
"Gettleman": [
"gettleman"
],
"SQL": [
"Sequel"
]
}
},
"structured_data_extraction": false,
"structured_data_extraction_config": {
"classes": [
"Persons",
"Organizations"
]
},
"sentiment_analysis": false,
"audio_to_llm": false,
"audio_to_llm_config": {
"prompts": [
"Extract the key points from the transcription"
]
},
"custom_metadata": {},
"sentences": false,
"display_mode": false,
"punctuation_enhanced": false,
"language_config": {
"languages": [],
"code_switching": false
},
"audio_url": "http://files.gladia.io/example/audio-transcription/split_infinity.wav"
}'
{
"id": "45463597-20b7-4af7-b3b3-f5fb778203ab",
"result_url": "https://api.gladia.io/v2/transcription/45463597-20b7-4af7-b3b3-f5fb778203ab"
}
Assistant
Responses are generated using AI and may contain mistakes.