Initiate a transcription

API Documentation

Upload

Pre-recorded endpoints

Pre-recorded webhooks

Pre-recorded callbacks

Live endpoints

Live WS actions

Live WS messages

Live callbacks

Live webhooks

Transcription (deprecated)

POST

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": {
      "vocabulary": [
        "Westeros",
        {
          "value": "Stark"
        },
        {
          "value": "Night'\''s Watch",
          "pronunciations": [
            "Nightz Watch"
          ],
          "intensity": 0.4,
          "language": "en"
        }
      ],
      "default_intensity": 0.6
    },
    "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
  },
  "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

x-gladia-key

string

header

required

Your personal Gladia API key

Body

application/json

audio_url

string

required

URL to a Gladia file or to an external audio or video file

Example:

"http://files.gladia.io/example/audio-transcription/split_infinity.wav"

context_prompt

string

[Alpha] Context to feed the transcription model with for possible better accuracy

custom_vocabulary

boolean

default:false

[Beta] Can be either boolean to enable custom_vocabulary for this audio or an array with specific vocabulary list to feed the transcription model with

custom_vocabulary_config

object

[Beta] Custom vocabulary configuration, if custom_vocabulary is enabled

custom_vocabulary_config.vocabulary

array

required

Specific vocabulary list to feed the transcription model with. Each item can be a string or an object with the following properties: value, intensity, pronunciations, language.

Example:

{
  "vocabulary": [
    "Westeros",
    { "value": "Stark" },
    {
      "value": "Night's Watch",
      "pronunciations": ["Nightz Watch"],
      "intensity": 0.4,
      "language": "en"
    }
  ],
  "default_intensity": 0.6
}

custom_vocabulary_config.default_intensity

number

Default intensity for the custom vocabulary

Required range: 0 <= x <= 1

Example:

0.5

detect_language

boolean

default:true

deprecated

[Deprecated] Use language_config instead. Detect the language from the given audio

enable_code_switching

boolean

default:false

deprecated

[Deprecated] Use language_config instead.Detect multiple languages in the given audio

code_switching_config

object

deprecated

[Deprecated] Use language_config instead. Specify the configuration for code switching

language

enum<string>

The original language in iso639-1 format

Available options:

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

string

deprecated

[Deprecated] Use callback/callback_config instead. Callback URL we will do a POST request to with the result of the transcription

Example:

"http://callback.example"

callback

boolean

default:false

Enable callback for this transcription. If true, the callback_config property will be used to customize the callback behaviour

callback_config

object

Customize the callback behaviour (url and http method)

subtitles

boolean

default:false

Enable subtitles generation for this transcription

subtitles_config

object

Configuration for subtitles generation if subtitles is enabled

subtitles_config.formats

enum<string>[]

Subtitles formats you want your transcription to be formatted to

Available options:

srt,

vtt

Example:

["srt"]

subtitles_config.minimum_duration

number

Minimum duration of a subtitle in seconds

Required range: x >= 0

subtitles_config.maximum_duration

number

Maximum duration of a subtitle in seconds

Required range: 1 <= x <= 30

subtitles_config.maximum_characters_per_row

integer

Maximum number of characters per row in a subtitle

Required range: x >= 1

subtitles_config.maximum_rows_per_caption

integer

Maximum number of rows per caption

Required range: 1 <= x <= 5

subtitles_config.style

enum<string>

default:default

Style 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

Available options:

default,

compliance

diarization

boolean

default:false

Enable speaker recognition (diarization) for this audio

diarization_config

object

Speaker recognition configuration, if diarization is enabled

translation

boolean

default:false

[Beta] Enable translation for this audio

translation_config

object

[Beta] Translation configuration, if translation is enabled

translation_config.target_languages

enum<string>[]

required

The target language in iso639-1 format

Available options:

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

Example:

["en"]

translation_config.model

enum<string>

default:base

Model you want the translation model to use to translate

Available options:

base,

enhanced

translation_config.match_original_utterances

boolean

default:true

Align translated utterances with the original ones

summarization

boolean

default:false

[Beta] Enable summarization for this audio

summarization_config

object

[Beta] Summarization configuration, if summarization is enabled

moderation

boolean

default:false

[Alpha] Enable moderation for this audio

named_entity_recognition

boolean

default:false

[Alpha] Enable named entity recognition for this audio

chapterization

boolean

default:false

[Alpha] Enable chapterization for this audio

name_consistency

boolean

default:false

[Alpha] Enable names consistency for this audio

custom_spelling

boolean

default:false

[Alpha] Enable custom spelling for this audio

custom_spelling_config

object

[Alpha] Custom spelling configuration, if custom_spelling is enabled

structured_data_extraction

boolean

default:false

[Alpha] Enable structured data extraction for this audio

structured_data_extraction_config

object

[Alpha] Structured data extraction configuration, if structured_data_extraction is enabled

sentiment_analysis

boolean

default:false

[Alpha] Enable sentiment analysis for this audio

audio_to_llm

boolean

default:false

[Alpha] Enable audio to llm processing for this audio

audio_to_llm_config

object

[Alpha] Audio to llm configuration, if audio_to_llm is enabled

custom_metadata

object

Custom metadata you can attach to this transcription

sentences

boolean

default:false

Enable sentences for this audio

display_mode

boolean

default:false

[Alpha] Allows to change the output display_mode for this audio. The output will be reordered, creating new utterances when speakers overlapped

punctuation_enhanced

boolean

default:false

[Alpha] Use enhanced punctuation for this audio

language_config

object

Specify the language configuration

Response

201

application/json

The transcription job has been initiated

string

required

Id of the job

Example:

"45463597-20b7-4af7-b3b3-f5fb778203ab"

result_url

string

required

Prebuilt URL with your transcription id to fetch the result

Example:

"https://api.gladia.io/v2/transcription/45463597-20b7-4af7-b3b3-f5fb778203ab"

End session Get result

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": {
      "vocabulary": [
        "Westeros",
        {
          "value": "Stark"
        },
        {
          "value": "Night'\''s Watch",
          "pronunciations": [
            "Nightz Watch"
          ],
          "intensity": 0.4,
          "language": "en"
        }
      ],
      "default_intensity": 0.6
    },
    "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
  },
  "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"
}