API

Every gladia.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Live

deleteSession

live.deleteSession Permanently delete a live transcription session Risk: destructive · Irreversible

await corsair.gladia.api.live.deleteSession({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—

Output: object

Output full type

undefined | {
  message: string
}

getTranscriptionResult

live.getTranscriptionResult Retrieve a live transcription session result Risk: read

await corsair.gladia.api.live.getTranscriptionResult({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`request_id`	`string`	No	—
`version`	`number`	No	—
`status`	`queued \| processing \| done \| error`	No	—
`created_at`	`string`	No	—
`completed_at`	`string`	No	—
`kind`	`live \| pre-recorded`	No	—
`custom_metadata`	`object`	No	—
`error_code`	`number`	No	—
`file`	`object`	No	—
`request_params`	`object`	No	—
`result`	`any`	No	—
`post_session_metadata`	`object`	No	—

custom_metadata full type

{
}

file full type

{
  id?: string,
  filename?: string,
  extension?: string,
  size?: number,
  audio_duration?: number,
  number_of_channels?: number,
  source?: string
}

request_params full type

{
}

post_session_metadata full type

{
}

initiateTranscriptionSession

live.initiateTranscriptionSession Create a live transcription session and return its WebSocket URL Risk: write

await corsair.gladia.api.live.initiateTranscriptionSession({});

Input

Name	Type	Required	Description
`region`	`us-west \| eu-west`	No	—
`encoding`	`wav/pcm \| wav/alaw \| wav/ulaw`	No	—
`bit_depth`	`8 \| 16 \| 24 \| 32`	No	—
`sample_rate`	`8000 \| 16000 \| 32000 \| 44100 \| 48000`	No	—
`channels`	`number`	No	—
`custom_metadata`	`object`	No	—
`model`	`string`	No	—
`endpointing`	`number`	No	—
`maximum_duration_without_endpointing`	`number`	No	—
`language_config`	`object`	No	—
`pre_processing`	`object`	No	—
`realtime_processing`	`object`	No	—
`post_processing`	`object`	No	—
`messages_config`	`object`	No	—
`callback`	`boolean`	No	—
`callback_config`	`object`	No	—

custom_metadata full type

{
}

language_config full type

{
}

pre_processing full type

{
}

realtime_processing full type

{
}

post_processing full type

{
}

messages_config full type

{
}

callback_config full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`created_at`	`string`	Yes	—
`url`	`string`	Yes	—

listTranscriptionJobs

live.listTranscriptionJobs List live transcription jobs with pagination and filters Risk: read

await corsair.gladia.api.live.listTranscriptionJobs({});

Input

Name	Type	Required	Description
`offset`	`number`	No	—
`limit`	`number`	No	—
`date`	`string`	No	—
`before_date`	`string`	No	—
`after_date`	`string`	No	—
`status`	`queued \| processing \| done \| error[]`	No	—
`custom_metadata`	`object`	No	—

custom_metadata full type

{
}

Output

Name	Type	Required	Description
`first`	`string`	Yes	—
`current`	`string`	Yes	—
`next`	`string`	No	—
`items`	`object[]`	Yes	—

items full type

{
  id: string,
  request_id?: string,
  version?: number,
  status?: queued | processing | done | error,
  created_at?: string,
  completed_at?: string | null,
  kind?: live | pre-recorded,
  custom_metadata?: {
  },
  error_code?: number | null,
  file?: {
    id?: string,
    filename?: string,
    extension?: string,
    size?: number,
    audio_duration?: number,
    number_of_channels?: number,
    source?: string
  } | null,
  request_params?: {
  } | null,
  result?: any,
  post_session_metadata?: {
  }
}[]

Pre Recorded

deleteJob

preRecorded.deleteJob Permanently delete a pre-recorded transcription job Risk: destructive · Irreversible

await corsair.gladia.api.preRecorded.deleteJob({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—

Output: object

Output full type

undefined | {
  message: string
}

getJob

preRecorded.getJob Retrieve a pre-recorded transcription job and result Risk: read

await corsair.gladia.api.preRecorded.getJob({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`request_id`	`string`	No	—
`version`	`number`	No	—
`status`	`queued \| processing \| done \| error`	No	—
`created_at`	`string`	No	—
`completed_at`	`string`	No	—
`kind`	`live \| pre-recorded`	No	—
`custom_metadata`	`object`	No	—
`error_code`	`number`	No	—
`file`	`object`	No	—
`request_params`	`object`	No	—
`result`	`any`	No	—
`post_session_metadata`	`object`	No	—

custom_metadata full type

{
}

file full type

{
  id?: string,
  filename?: string,
  extension?: string,
  size?: number,
  audio_duration?: number,
  number_of_channels?: number,
  source?: string
}

request_params full type

{
}

post_session_metadata full type

{
}

initiateTranscription

preRecorded.initiateTranscription Start a pre-recorded transcription job Risk: write

await corsair.gladia.api.preRecorded.initiateTranscription({});

Input

Name	Type	Required	Description
`audio_url`	`string`	Yes	—
`custom_vocabulary`	`boolean`	No	—
`custom_vocabulary_config`	`object`	No	—
`callback_url`	`string`	No	—
`callback`	`boolean`	No	—
`callback_config`	`object`	No	—
`subtitles`	`boolean`	No	—
`subtitles_config`	`object`	No	—
`diarization`	`boolean`	No	—
`diarization_config`	`object`	No	—
`translation`	`boolean`	No	—
`translation_config`	`object`	No	—
`summarization`	`boolean`	No	—
`summarization_config`	`object`	No	—
`named_entity_recognition`	`boolean`	No	—
`custom_spelling`	`boolean`	No	—
`custom_spelling_config`	`object`	No	—
`sentiment_analysis`	`boolean`	No	—
`audio_to_llm`	`boolean`	No	—
`audio_to_llm_config`	`object`	No	—
`pii_redaction`	`boolean`	No	—
`pii_redaction_config`	`object`	No	—
`custom_metadata`	`object`	No	—
`sentences`	`boolean`	No	—
`punctuation_enhanced`	`boolean`	No	—
`language_config`	`object`	No	—
`model`	`string`	No	—

custom_vocabulary_config full type

{
}

callback_config full type

{
}

subtitles_config full type

{
}

diarization_config full type

{
}

translation_config full type

{
}

summarization_config full type

{
}

custom_spelling_config full type

{
}

audio_to_llm_config full type

{
}

pii_redaction_config full type

{
}

custom_metadata full type

{
}

language_config full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`result_url`	`string`	Yes	—

listJobs

preRecorded.listJobs List pre-recorded transcription jobs with pagination and filters Risk: read

await corsair.gladia.api.preRecorded.listJobs({});

Input

Name	Type	Required	Description
`offset`	`number`	No	—
`limit`	`number`	No	—
`date`	`string`	No	—
`before_date`	`string`	No	—
`after_date`	`string`	No	—
`status`	`queued \| processing \| done \| error[]`	No	—
`custom_metadata`	`object`	No	—

custom_metadata full type

{
}

Output

Name	Type	Required	Description
`first`	`string`	Yes	—
`current`	`string`	Yes	—
`next`	`string`	No	—
`items`	`object[]`	Yes	—

items full type

{
  id: string,
  request_id?: string,
  version?: number,
  status?: queued | processing | done | error,
  created_at?: string,
  completed_at?: string | null,
  kind?: live | pre-recorded,
  custom_metadata?: {
  },
  error_code?: number | null,
  file?: {
    id?: string,
    filename?: string,
    extension?: string,
    size?: number,
    audio_duration?: number,
    number_of_channels?: number,
    source?: string
  } | null,
  request_params?: {
  } | null,
  result?: any,
  post_session_metadata?: {
  }
}[]

Upload

audioVideoFile

upload.audioVideoFile Upload an audio or video file for a pre-recorded job Risk: write

await corsair.gladia.api.upload.audioVideoFile({});

Input

Name	Type	Required	Description
`audio`	`custom`	Yes	—
`filename`	`string`	No	—

Output

Name	Type	Required	Description
`audio_url`	`string`	Yes	—
`audio_metadata`	`object`	Yes	—

audio_metadata full type

{
  id?: string,
  filename?: string,
  extension?: string,
  size?: number,
  audio_duration?: number,
  number_of_channels?: number,
  source?: string
}

Overview

Plugins

Live

deleteSession

getTranscriptionResult

initiateTranscriptionSession

listTranscriptionJobs

Pre Recorded

deleteJob

getJob

initiateTranscription

listJobs

Upload

audioVideoFile

​Live

​deleteSession

​getTranscriptionResult

​initiateTranscriptionSession

​listTranscriptionJobs

​Pre Recorded

​deleteJob

​getJob

​initiateTranscription

​listJobs

​Upload

​audioVideoFile

Live

deleteSession

getTranscriptionResult

initiateTranscriptionSession

listTranscriptionJobs

Pre Recorded

deleteJob

getJob

initiateTranscription

listJobs

Upload

audioVideoFile