Initiate a session

API Documentation

Upload

POST
Upload a file

Pre-recorded endpoints

Pre-recorded webhooks

Pre-recorded callbacks

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)

POST

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": "accurate",
  "endpointing": 0.01,
  "maximum_duration_without_endpointing": 5,
  "language_config": {
    "languages": [],
    "code_switching": false
  },
  "pre_processing": {
    "audio_enhancer": false,
    "speech_threshold": 0.8
  },
  "realtime_processing": {
    "words_accurate_timestamps": false,
    "custom_vocabulary": false,
    "custom_vocabulary_config": {
      "vocabulary": [
        "Gladia",
        {
          "value": "Gladia",
          "intensity": 0.5
        }
      ],
      "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
    },
    "named_entity_recognition": false,
    "sentiment_analysis": false
  },
  "post_processing": {
    "summarization": false,
    "summarization_config": {
      "type": "general"
    },
    "chapterization": false
  },
  "messages_config": {
    "receive_partial_transcripts": true,
    "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_partial_transcripts": false,
    "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

x-gladia-key

string

header

required

Your personal Gladia API key

Body

application/json

encoding

enum<string>

default:wav/pcm

The encoding format of the audio stream. Supported formats:

PCM: 8, 16, 24, and 32 bits
A-law: 8 bits
μ-law: 8 bits

Note: No need to add WAV headers to raw audio as the API supports both formats.

Available options:

wav/pcm,

wav/alaw,

wav/ulaw

bit_depth

enum<number>

default:16

The bit depth of the audio stream

Available options:

8,

16,

24,

32

sample_rate

enum<number>

default:16000

The sample rate of the audio stream

Available options:

8000,

16000,

32000,

44100,

48000

channels

integer

default:1

The number of channels of the audio stream

Required range: 1 <= x <= 8

custom_metadata

object

Custom metadata you can attach to this live transcription

Example:

{ "user": "John Doe" }

model

enum<string>

default:accurate

The model used to process the audio. "accurate" is used by default.

Available options:

fast,

accurate

endpointing

number

default:0.01

The endpointing duration in seconds. Endpointing is the duration of silence which will cause an utterance to be considered as finished

Required range: 0.01 <= x <= 10

maximum_duration_without_endpointing

number

default:5

The maximum duration in seconds without endpointing. If endpointing is not detected after this duration, current utterance will be considered as finished

Required range: 5 <= x <= 60

language_config

object

Specify the language configuration

pre_processing

object

Specify the pre-processing configuration

realtime_processing

object

Specify the realtime processing configuration

realtime_processing.words_accurate_timestamps

boolean

default:false

If true, accurate timestamps will be provided for each word in the transcription.

realtime_processing.custom_vocabulary

boolean

default:false

If true, enable custom vocabulary for the transcription.

realtime_processing.custom_vocabulary_config

object

Custom vocabulary configuration, if custom_vocabulary is enabled

realtime_processing.custom_vocabulary_config.vocabulary

array

required

Specific vocabulary list to feed the transcription model with

Example:

[
  "Gladia",
  { "value": "Gladia", "intensity": 0.5 }
]

realtime_processing.custom_vocabulary_config.default_intensity

number

Default intensity for the custom vocabulary

Required range: 0 <= x <= 1

Example:

0.5

realtime_processing.custom_spelling

boolean

default:false

If true, enable custom spelling for the transcription.

realtime_processing.custom_spelling_config

object

Custom spelling configuration, if custom_spelling is enabled

realtime_processing.translation

boolean

default:false

If true, enable translation for the transcription

realtime_processing.translation_config

object

Translation configuration, if translation is enabled

realtime_processing.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"]

realtime_processing.translation_config.model

enum<string>

default:base

Model you want the translation model to use to translate

Available options:

base,

enhanced

realtime_processing.translation_config.match_original_utterances

boolean

default:true

Align translated utterances with the original ones

realtime_processing.named_entity_recognition

boolean

default:false

If true, enable named entity recognition for the transcription.

realtime_processing.sentiment_analysis

boolean

default:false

If true, enable sentiment analysis for the transcription.

post_processing

object

Specify the post-processing configuration

messages_config

object

Specify the websocket messages configuration

callback

boolean

default:false

If true, messages will be sent to configured url.

callback_config

object

Specify the callback configuration

Response

201

application/json

The live job has been initiated

string

required

Id of the job

Example:

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

url

string

required

The websocket url to connect to for sending audio data. The url will contain the temporary token to authenticate the session.

Example:

"wss://api.gladia.io/v2/live?token=4a39145c-2844-4557-8f34-34883f7be7d9"

Was this page helpful?

Error Get result

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": "accurate",
  "endpointing": 0.01,
  "maximum_duration_without_endpointing": 5,
  "language_config": {
    "languages": [],
    "code_switching": false
  },
  "pre_processing": {
    "audio_enhancer": false,
    "speech_threshold": 0.8
  },
  "realtime_processing": {
    "words_accurate_timestamps": false,
    "custom_vocabulary": false,
    "custom_vocabulary_config": {
      "vocabulary": [
        "Gladia",
        {
          "value": "Gladia",
          "intensity": 0.5
        }
      ],
      "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
    },
    "named_entity_recognition": false,
    "sentiment_analysis": false
  },
  "post_processing": {
    "summarization": false,
    "summarization_config": {
      "type": "general"
    },
    "chapterization": false
  },
  "messages_config": {
    "receive_partial_transcripts": true,
    "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_partial_transcripts": false,
    "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"
}