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
List transcriptions
(Deprecated) Prefer the more specific pre-recorded endpoint.
List all the transcriptions matching the parameters.
Your personal Gladia API key
The starting point for pagination. A value of 0 starts from the first item.
The maximum number of items to return. Useful for pagination and controlling data payload size.
Filter items relevant to a specific date in ISO format (YYYY-MM-DD).
Include items that occurred before the specified date in ISO format.
Filter for items after the specified date. Use with before_date for a range. Date in ISO format.
Filter the list based on item status. Accepts multiple values from the predefined list.
Filter the list based on the item type. Supports multiple values from the predefined list.
Authorizations
Your personal Gladia API key
Query Parameters
The starting point for pagination. A value of 0 starts from the first item.
x > 0The maximum number of items to return. Useful for pagination and controlling data payload size.
x > 1Filter items relevant to a specific date in ISO format (YYYY-MM-DD).
Include items that occurred before the specified date in ISO format.
Filter for items after the specified date. Use with before_date for a range. Date in ISO format.
Filter the list based on item status. Accepts multiple values from the predefined list.
queued, processing, done, error Filter the list based on the item type. Supports multiple values from the predefined list.
pre-recorded, live Response
URL to fetch the first page
URL to fetch the current page
URL to fetch the next page
List of transcriptions
Id of the job
Debug id
API version
"queued": the job has been queued. "processing": the job is being processed. "done": the job has been processed and the result is available. "error": an error occurred during the job's processing.
queued, processing, done, error Creation date
Completion date when status is "done" or "error"
Custom metadata given in the initial request
HTTP status code of the error if status is "error"
400 < x < 599pre-recorded The file data you uploaded. Can be null if status is "error"
The file id
The name of the uploaded file
The link used to download the file if audio_url was used
Duration of the audio file
Number of channels in the audio file
x > 1Parameters used for this pre-recorded transcription. Can be null if status is "error"
[Alpha] Context to feed the transcription model with for possible better accuracy
[Alpha] Specific vocabulary list to feed the transcription model with
Detect the language from the given audio
Detect multiple languages in the given audio
Specify the configuration for code switching
Specify the languages you want to use when detecting multiple languages
af, sq, am, ar, hy, as, az, ba, eu, be, bn, bs, br, bg, ca, zh, hr, cs, da, nl, en, et, fo, fi, fr, gl, ka, de, el, gu, ht, ha, haw, he, hi, hu, is, id, it, ja, jv, kn, kk, km, ko, lo, la, lv, ln, lt, lb, mk, mg, ms, ml, mt, mi, mr, mn, mymr, ne, no, nn, oc, ps, fa, pl, pt, pa, ro, ru, sa, sr, sn, sd, si, sk, sl, so, es, su, sw, sv, tl, tg, ta, tt, te, th, bo, tr, tk, uk, ur, uz, vi, cy, yi, yo, jp Set the spoken language for the given audio (ISO 639 standard)
af, sq, am, ar, hy, as, az, ba, eu, be, bn, bs, br, bg, ca, zh, hr, cs, da, nl, en, et, fo, fi, fr, gl, ka, de, el, gu, ht, ha, haw, he, hi, hu, is, id, it, ja, jv, kn, kk, km, ko, lo, la, lv, ln, lt, lb, mk, mg, ms, ml, mt, mi, mr, mn, mymr, ne, no, nn, oc, ps, fa, pl, pt, pa, ro, ru, sa, sr, sn, sd, si, sk, sl, so, es, su, sw, sv, tl, tg, ta, tt, te, th, bo, tr, tk, uk, ur, uz, vi, cy, yi, yo, jp Callback URL we will do a POST request to with the result of the transcription
Enable subtitles generation for this transcription
Configuration for subtitles generation if subtitles is enabled
srt, vtt Minimum duration of a subtitle in seconds
x > 0Maximum duration of a subtitle in seconds
1 < x < 30Maximum number of characters per row in a subtitle
x > 1Maximum number of rows per caption
1 < x < 5Style of the subtitles. Compliance mode refers to : https://loc.gov/preservation/digital/formats//fdd/fdd000569.shtml#:~:text=SRT%20files%20are%20basic%20text,alongside%2C%20example%3A%20%22MyVideo123
default, compliance Enable speaker recognition (diarization) for this audio
Speaker recognition configuration, if diarization is enabled
Exact number of speakers in the audio
x > 0Minimum number of speakers in the audio
x > 0Maximum number of speakers in the audio
x > 0[Alpha] Use enhanced diarization for this audio
[Beta] Enable translation for this audio
[Beta] Translation configuration, if translation is enabled
af, sq, am, ar, hy, as, ast, az, ba, eu, be, bn, bs, br, bg, my, ca, ceb, zh, hr, cs, da, nl, en, et, fo, fi, nl, fr, fy, ff, gd, gl, lg, ka, de, el, gu, ht, ha, haw, he, hi, hu, is, ig, ilo, id, ga, it, ja, jp, jv, kn, kk, km, ko, lo, la, lv, ln, lt, lb, mk, mg, ms, ml, mt, mi, mr, mo, mn, mymr, ne, no, nn, oc, or, pa, ps, fa, pl, pt, pa, ro, ru, sa, sr, sn, sd, si, sk, sl, so, es, su, sw, ss, sv, tl, tg, ta, tt, te, th, bo, tn, tr, tk, uk, ur, uz, vi, cy, wo, xh, yi, yo, zu Model you want the translation model to use to translate
base, enhanced Align translated utterances with the original ones
[Beta] Enable summarization for this audio
[Beta] Summarization configuration, if summarization is enabled
The type of summarization to apply
general, bullet_points, concise [Alpha] Enable moderation for this audio
[Alpha] Enable named entity recognition for this audio
[Alpha] Enable chapterization for this audio
[Alpha] Enable names consistency for this audio
[Alpha] Enable custom spelling for this audio
[Alpha] Custom spelling configuration, if custom_spelling is enabled
The list of spelling applied on the audio transcription
[Alpha] Enable structured data extraction for this audio
[Alpha] Structured data extraction configuration, if structured_data_extraction is enabled
The list of classes to extract from the audio transcription
[Alpha] Enable sentiment analysis for this audio
[Alpha] Enable audio to llm processing for this audio
[Alpha] Audio to llm configuration, if audio_to_llm is enabled
The list of prompts applied on the audio transcription
Enable sentences for this audio
[Alpha] Allows to change the output display_mode for this audio. The output will be reordered, creating new utterances when speakers overlapped
[Alpha] Use enhanced punctuation for this audio
Pre-recorded transcription's result when status is "done"
Metadata for the given transcription & audio file
Duration of the transcribed audio file
Number of distinct channels in the transcribed audio file
x > 1Billed duration in seconds (audio_duration * number_of_distinct_channels)
Duration of the transcription in seconds
Transcription of the audio speech
All transcription on text format without any other information
af, sq, am, ar, hy, as, ast, az, ba, eu, be, bn, bs, br, bg, my, ca, ceb, zh, hr, cs, da, nl, en, et, fo, fi, fr, fy, ff, gd, gl, lg, ka, de, el, gu, ht, ha, haw, he, hi, hu, is, ig, ilo, id, ga, it, ja, jv, kn, kk, km, ko, lo, la, lv, ln, lt, lb, mk, mg, ms, ml, mt, mi, mr, mo, mn, mymr, ne, no, nn, oc, or, pa, ps, fa, pl, pt, pa, ro, ru, sa, sr, sn, sd, si, sk, sl, so, es, su, sw, ss, sv, tl, tg, ta, tt, te, th, bo, tn, tr, tk, uk, ur, uz, vi, cy, wo, xh, yi, yo, zu Transcribed speech utterances present in the audio
All the detected languages in the audio sorted from the most detected to the less detected
af, sq, am, ar, hy, as, ast, az, ba, eu, be, bn, bs, br, bg, my, ca, ceb, zh, hr, cs, da, nl, en, et, fo, fi, fr, fy, ff, gd, gl, lg, ka, de, el, gu, ht, ha, haw, he, hi, hu, is, ig, ilo, id, ga, it, ja, jv, kn, kk, km, ko, lo, la, lv, ln, lt, lb, mk, mg, ms, ml, mt, mi, mr, mo, mn, mymr, ne, no, nn, oc, or, pa, ps, fa, pl, pt, pa, ro, ru, sa, sr, sn, sd, si, sk, sl, so, es, su, sw, ss, sv, tl, tg, ta, tt, te, th, bo, tn, tr, tk, uk, ur, uz, vi, cy, wo, xh, yi, yo, zu Start timestamp in seconds of this utterance
End timestamp in seconds of this utterance
Confidence on the transcribed utterance (1 = 100% confident)
Audio channel of where this utterance has been transcribed from
x > 0If diarization enabled, speaker identification number
x > 0List of words of the utterance, split by timestamp
Transcription for this utterance
If sentences has been enabled, sentences results
The audio intelligence model succeeded to get a valid output
The audio intelligence model returned an empty value
Time audio intelligence model took to complete the task
null if success is true. Contains the error details of the failed model
If sentences has been enabled, transcription as sentences.
If subtitles has been enabled, subtitles results
If translation has been enabled, translation of the audio speech transcription
The audio intelligence model succeeded to get a valid output
The audio intelligence model returned an empty value
Time audio intelligence model took to complete the task
null if success is true. Contains the error details of the failed model
List of translated transcriptions, one for each target_languages
Contains the error details of the failed addon
All transcription on text format without any other information
af, sq, am, ar, hy, as, ast, az, ba, eu, be, bn, bs, br, bg, my, ca, ceb, zh, hr, cs, da, nl, en, et, fo, fi, fr, fy, ff, gd, gl, lg, ka, de, el, gu, ht, ha, haw, he, hi, hu, is, ig, ilo, id, ga, it, ja, jv, kn, kk, km, ko, lo, la, lv, ln, lt, lb, mk, mg, ms, ml, mt, mi, mr, mo, mn, mymr, ne, no, nn, oc, or, pa, ps, fa, pl, pt, pa, ro, ru, sa, sr, sn, sd, si, sk, sl, so, es, su, sw, ss, sv, tl, tg, ta, tt, te, th, bo, tn, tr, tk, uk, ur, uz, vi, cy, wo, xh, yi, yo, zu If sentences has been enabled, sentences results for this translation
If subtitles has been enabled, subtitles results for this translation
Transcribed speech utterances present in the audio
If summarization has been enabled, summarization of the audio speech transcription
The audio intelligence model succeeded to get a valid output
The audio intelligence model returned an empty value
Time audio intelligence model took to complete the task
null if success is true. Contains the error details of the failed model
If summarization has been enabled, summary of the transcription
If moderation has been enabled, moderation of the audio speech transcription
The audio intelligence model succeeded to get a valid output
The audio intelligence model returned an empty value
Time audio intelligence model took to complete the task
null if success is true. Contains the error details of the failed model
If moderation has been enabled, moderated transcription
If named_entity_recognition has been enabled, the detected entities
The audio intelligence model succeeded to get a valid output
The audio intelligence model returned an empty value
Time audio intelligence model took to complete the task
null if success is true. Contains the error details of the failed model
If named_entity_recognition has been enabled, the detected entities.
If name_consistency has been enabled, Gladia will improve consistency of the names accross the transcription
The audio intelligence model succeeded to get a valid output
The audio intelligence model returned an empty value
Time audio intelligence model took to complete the task
null if success is true. Contains the error details of the failed model
If name_consistency has been enabled, Gladia will improve the consistency of the names across the transcription
If custom_spelling has been enabled, Gladia will correct the spelling of the transcription
The audio intelligence model succeeded to get a valid output
The audio intelligence model returned an empty value
Time audio intelligence model took to complete the task
null if success is true. Contains the error details of the failed model
If custom_spelling has been enabled, Gladia will correct the spelling of the transcription
If structured_data_extraction has been enabled, structured data extraction results
The audio intelligence model succeeded to get a valid output
The audio intelligence model returned an empty value
Time audio intelligence model took to complete the task
null if success is true. Contains the error details of the failed model
Status code of the addon error
Reason of the addon error
Detailed message of the addon error
If structured_data_extraction has been enabled, results of the AI structured data extraction for the defined classes.
If sentiment_analysis has been enabled, sentiment analysis of the audio speech transcription
The audio intelligence model succeeded to get a valid output
The audio intelligence model returned an empty value
Time audio intelligence model took to complete the task
null if success is true. Contains the error details of the failed model
If sentiment_analysis has been enabled, Gladia will analyze the sentiments and emotions of the audio
If audio_to_llm has been enabled, audio to llm results of the audio speech transcription
The audio intelligence model succeeded to get a valid output
The audio intelligence model returned an empty value
Time audio intelligence model took to complete the task
null if success is true. Contains the error details of the failed model
If audio_to_llm has been enabled, results of the AI custom analysis
The audio intelligence model succeeded to get a valid output
The audio intelligence model returned an empty value
Time audio intelligence model took to complete the task
null if success is true. Contains the error details of the failed model
The result from a specific prompt
If sentences has been enabled, sentences of the audio speech transcription. Deprecated: content will move to the transcription object.
The audio intelligence model succeeded to get a valid output
The audio intelligence model returned an empty value
Time audio intelligence model took to complete the task
null if success is true. Contains the error details of the failed model
If sentences has been enabled, transcription as sentences.
If display_mode has been enabled, the output will be reordered, creating new utterances when speakers overlapped
The audio intelligence model succeeded to get a valid output
The audio intelligence model returned an empty value
Time audio intelligence model took to complete the task
null if success is true. Contains the error details of the failed model
If display_mode has been enabled, proposes an alternative display output.
If chapterization has been enabled, will generate chapters name for different parts of the given audio.
The audio intelligence model succeeded to get a valid output
The audio intelligence model returned an empty value
Time audio intelligence model took to complete the task
null if success is true. Contains the error details of the failed model
If chapterization has been enabled, will generate chapters name for different parts of the given audio.
Was this page helpful?