Skip to main content
POST
/
v2
/
pre-recorded
Initiate a new pre recorded job
curl --request POST \
  --url https://api.gladia.io/v2/pre-recorded \
  --header 'Content-Type: application/json' \
  --header 'x-gladia-key: <api-key>' \
  --data '
{
  "audio_url": "http://files.gladia.io/example/audio-transcription/split_infinity.wav",
  "custom_vocabulary": false,
  "callback_url": "http://callback.example",
  "callback": false,
  "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": 3,
    "min_speakers": 1,
    "max_speakers": 2
  },
  "translation": false,
  "summarization": false,
  "summarization_config": {
    "type": "general"
  },
  "named_entity_recognition": false,
  "custom_spelling": false,
  "sentiment_analysis": false,
  "audio_to_llm": false,
  "pii_redaction": false,
  "pii_redaction_config": {
    "entity_types": [
      "GDPR",
      "HEALTH_INFORMATION",
      "HIPAA_SAFE_HARBOR",
      "QUEBEC_PRIVACY_ACT",
      "EMAIL_ADDRESS",
      "NAME",
      "PHONE_NUMBER"
    ],
    "processed_text_type": "MARKER"
  },
  "custom_metadata": {
    "user": "John Doe"
  },
  "sentences": false,
  "punctuation_enhanced": false,
  "language_config": {
    "languages": [],
    "code_switching": false
  }
}
'
{
  "id": "45463597-20b7-4af7-b3b3-f5fb778203ab",
  "result_url": "https://api.gladia.io/v2/transcription/45463597-20b7-4af7-b3b3-f5fb778203ab"
}

Documentation Index

Fetch the complete documentation index at: https://docs.gladia.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-gladia-key
string
header
required

Your personal Gladia API key

Body

application/json
​
audio_url
string<uri>
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"

​
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

​
callback_url
string<uri>
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

​
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

​
summarization
boolean
default:false

Enable summarization for this audio

​
summarization_config
object

Summarization configuration, if summarization is enabled

​
named_entity_recognition
boolean
default:false

[Alpha] Enable named entity recognition 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

​
sentiment_analysis
boolean
default:false

Enable sentiment analysis for this audio

​
audio_to_llm
boolean
default:false

Enable audio to LLM processing for this audio

​
audio_to_llm_config
object

Audio to LLM configuration, if audio_to_llm is enabled

​
pii_redaction
boolean
default:false

Enable PII redaction for this audio

​
pii_redaction_config
object

PII redaction configuration, if pii_redaction is enabled

​
custom_metadata
object

Custom metadata you can attach to this transcription

Example:
{ "user": "John Doe" }
​
sentences
boolean
default:false

Enable sentences for this audio

​
punctuation_enhanced
boolean
default:false

[Alpha] Use enhanced punctuation for this audio

​
language_config
object

Specify the language configuration

Response

The pre recorded job has been initiated

​
id
string<uuid>
required

Id of the job

Example:

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

​
result_url
string<uri>
required

Prebuilt URL with your transcription id to fetch the result

Example:

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