--- title: "Get transcription jobs based on query parameters" method: GET path: "/v2/transcription" tags: ["Transcription V2"] --- # Get transcription jobs based on query parameters `GET /v2/transcription` ## Query parameters - `offset` integer - `limit` integer - `date` string, date-time - `before_date` string, date-time - `after_date` string, date-time - `status` string[] - `custom_metadata` object - `kind` string[] ## Response `200` A list of transcription jobs matching the parameters. - ListTranscriptionResponse - `first` string, uri, required — URL to fetch the first page - `current` string, uri, required — URL to fetch the current page - `next` string, uri, nullable, required — URL to fetch the next page - `items` union[], required — List of transcriptions - union - PreRecordedResponse - `id` string, uuid, required — Id of the job - `request_id` string, required — Debug id - `version` integer, required — API version - `status` 'queued' | 'processing' | 'done' | 'error', required — "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. - `created_at` string, date-time, required — Creation date - `completed_at` string, date-time, nullable — Completion date when status is "done" or "error" - `custom_metadata` object — Custom metadata given in the initial request - `error_code` integer, nullable — HTTP status code of the error if status is "error" - `post_session_metadata` object, required — For debugging purposes, send data that could help to identify issues - `kind` 'pre-recorded', required - `file` FileResponse - `id` string, required — The file id - `filename` string, nullable, required — The name of the uploaded file - `source` string, nullable, required — The link used to download the file if audio_url was used - `audio_duration` number, nullable, required — Duration of the audio file - `number_of_channels` integer, nullable, required — Number of channels in the audio file - `request_params` PreRecordedRequestParamsResponse - `custom_vocabulary` boolean — **[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` CustomVocabularyConfigDTO - `vocabulary` union[], 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. - … - `default_intensity` number — Default intensity for the custom vocabulary - `callback_url` string, uri — **[Deprecated]** Use `callback`/`callback_config` instead. Callback URL we will do a `POST` request to with the result of the transcription - `callback` boolean — Enable callback for this transcription. If true, the `callback_config` property will be used to customize the callback behaviour - `callback_config` CallbackConfigDto - `url` string, uri, required — The URL to be called with the result of the transcription - `method` 'POST' | 'PUT' — The HTTP method to be used. Allowed values are `POST` or `PUT` (default: `POST`) - `subtitles` boolean — Enable subtitles generation for this transcription - `subtitles_config` SubtitlesConfigDTO - `formats` SubtitlesFormatEnum[] — Subtitles formats you want your transcription to be formatted to - `minimum_duration` number — Minimum duration of a subtitle in seconds - `maximum_duration` number — Maximum duration of a subtitle in seconds - `maximum_characters_per_row` integer — Maximum number of characters per row in a subtitle - `maximum_rows_per_caption` integer — Maximum number of rows per caption - `style` 'default' | 'compliance' — 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 - `diarization` boolean — Enable speaker recognition (diarization) for this audio - `diarization_config` DiarizationConfigDTO - `number_of_speakers` integer — Exact number of speakers in the audio - `min_speakers` integer — Minimum number of speakers in the audio - `max_speakers` integer — Maximum number of speakers in the audio - `translation` boolean — **[Beta]** Enable translation for this audio - `translation_config` TranslationConfigDTO - `target_languages` TranslationLanguageCodeEnum[], required — Target language in `iso639-1` format you want the transcription translated to - `model` 'base' | 'batch' | 'enhanced' — Model you want the translation model to use to translate - `match_original_utterances` boolean — Align translated utterances with the original ones - `lipsync` boolean — Whether to apply lipsync to the translated transcription. - `context_adaptation` boolean — Enables or disables context-aware translation features that allow the model to adapt translations based on provided context. - `context` string — Context information to improve translation accuracy - `informal` boolean — Forces the translation to use informal language forms when available in the target language. - `summarization` boolean — Enable summarization for this audio - `summarization_config` SummarizationConfigDTO - `type` 'general' | 'bullet_points' | 'concise' — The type of summarization to apply - `named_entity_recognition` boolean — **[Alpha]** Enable named entity recognition for this audio - `custom_spelling` boolean — **[Alpha]** Enable custom spelling for this audio - `custom_spelling_config` CustomSpellingConfigDTO - `spelling_dictionary` object, required — The list of spelling applied on the audio transcription - `sentiment_analysis` boolean — Enable sentiment analysis for this audio - `audio_to_llm` boolean — Enable audio to LLM processing for this audio - `audio_to_llm_config` AudioToLlmListConfigDTO - `prompts` array[], required — The list of prompts applied on the audio transcription - … - `model` string — The model to use for the prompt execution. You can find the list of supported models [here](https://openrouter.ai/models). - `pii_redaction` boolean — Enable PII redaction for this audio - `pii_redaction_config` PiiRedactionConfigDTO - `entity_types` 'APPI' | 'APPI_SENSITIVE' | 'CCI' | 'CORE_ENTITIES' | 'CPRA' | 'GDPR' | 'GDPR_SENSITIVE' | 'HEALTH_INFORMATION' | 'HIPAA_SAFE_HARBOR' | 'LIDI' | 'NUMERICAL_EXCL_PCI' | 'PCI' | 'QUEBEC_PRIVACY_ACT' | 'ACCOUNT_NUMBER' | 'AGE' | 'DATE' | 'DATE_INTERVAL' | 'DOB' | 'DRIVER_LICENSE' | 'DURATION' | 'EMAIL_ADDRESS' | 'EVENT' | 'FILENAME' | 'GENDER' | 'HEALTHCARE_NUMBER' | 'IP_ADDRESS' | 'LANGUAGE' | 'LOCATION' | 'LOCATION_ADDRESS' | 'LOCATION_ADDRESS_STREET' | 'LOCATION_CITY' | 'LOCATION_COORDINATE' | 'LOCATION_COUNTRY' | 'LOCATION_STATE' | 'LOCATION_ZIP' | 'MARITAL_STATUS' | 'MONEY' | 'NAME' | 'NAME_FAMILY' | 'NAME_GIVEN' | 'NAME_MEDICAL_PROFESSIONAL' | 'NUMERICAL_PII' | 'OCCUPATION' | 'ORGANIZATION' | 'ORGANIZATION_MEDICAL_FACILITY' | 'ORIGIN' | 'PASSPORT_NUMBER' | 'PASSWORD' | 'PHONE_NUMBER' | 'PHYSICAL_ATTRIBUTE' | 'POLITICAL_AFFILIATION' | 'RELIGION' | 'SEXUALITY' | 'SSN' | 'TIME' | 'URL' | 'USERNAME' | 'VEHICLE_ID' | 'ZODIAC_SIGN' | 'BLOOD_TYPE' | 'CONDITION' | 'DOSE' | 'DRUG' | 'INJURY' | 'MEDICAL_PROCESS' | 'STATISTICS' | 'BANK_ACCOUNT' | 'CREDIT_CARD' | 'CREDIT_CARD_EXPIRATION' | 'CVV' | 'ROUTING_NUMBER' | 'CORPORATE_ACTION' | 'DAY' | 'EFFECT' | 'FINANCIAL_METRIC' | 'MEDICAL_CODE' | 'MONTH' | 'ORGANIZATION_ID' | 'PRODUCT' | 'PROJECT' | 'TREND' | 'YEAR' — The entity types to redact - `processed_text_type` 'MARKER' | 'MASK' — The type of processed text to return (marker or mask) - `sentences` boolean — Enable sentences for this audio - `punctuation_enhanced` boolean — **[Alpha]** Use enhanced punctuation for this audio - `language_config` LanguageConfig - `languages` TranscriptionLanguageCodeEnum[] — If one language is set, it will be used for the transcription. Otherwise, language will be auto-detected by the model. - `code_switching` boolean — If true, language will be auto-detected on each utterance. Otherwise, language will be auto-detected on first utterance and then used for the rest of the transcription. If one language is set, this option will be ignored. - `audio_url` string, uri, nullable, required - `result` TranscriptionResultDTO - `metadata` TranscriptionMetadataDTO, required - `audio_duration` number, required — Duration of the transcribed audio file - `number_of_distinct_channels` integer, required — Number of distinct channels in the transcribed audio file - `billing_time` number, required — Billed duration in seconds (audio_duration * number_of_distinct_channels) - `transcription_time` number, required — Duration of the transcription in seconds - `transcription` TranscriptionDTO - `full_transcript` string, required — All transcription on text format without any other information - `languages` TranscriptionLanguageCodeEnum[], required — All the detected languages in the audio sorted from the most detected to the less detected - `sentences` SentencesDTO[] — If `sentences` has been enabled, sentences results - … - `subtitles` SubtitleDTO[] — If `subtitles` has been enabled, subtitles results - … - `utterances` UtteranceDTO[], required — Transcribed speech utterances present in the audio - … - `translation` TranslationDTO - `success` boolean, required — The audio intelligence model succeeded to get a valid output - `is_empty` boolean, required — The audio intelligence model returned an empty value - `exec_time` number, required — Time audio intelligence model took to complete the task - `error` AddonErrorDTO, required - … - `results` TranslationResultDTO[], nullable, required — List of translated transcriptions, one for each `target_languages` - … - `summarization` SummarizationDTO - `success` boolean, required — The audio intelligence model succeeded to get a valid output - `is_empty` boolean, required — The audio intelligence model returned an empty value - `exec_time` number, required — Time audio intelligence model took to complete the task - `error` AddonErrorDTO, required - … - `results` string, nullable, required — If `summarization` has been enabled, summary of the transcription - `moderation` ModerationDTO - `success` boolean, required — The audio intelligence model succeeded to get a valid output - `is_empty` boolean, required — The audio intelligence model returned an empty value - `exec_time` number, required — Time audio intelligence model took to complete the task - `error` AddonErrorDTO, required - … - `results` string, nullable, required — If `moderation` has been enabled, moderated transcription - `named_entity_recognition` NamedEntityRecognitionDTO - `success` boolean, required — The audio intelligence model succeeded to get a valid output - `is_empty` boolean, required — The audio intelligence model returned an empty value - `exec_time` number, required — Time audio intelligence model took to complete the task - `error` AddonErrorDTO, required - … - `results` NamedEntityRecognitionResult[], nullable, required — If `named_entity_recognition` has been enabled, the detected entities. - … - `name_consistency` NamesConsistencyDTO - `success` boolean, required — The audio intelligence model succeeded to get a valid output - `is_empty` boolean, required — The audio intelligence model returned an empty value - `exec_time` number, required — Time audio intelligence model took to complete the task - `error` AddonErrorDTO, required - … - `results` string, nullable, required — Deprecated, If `name_consistency` has been enabled, Gladia will improve the consistency of the names across the transcription - `structured_data_extraction` StructuredDataExtractionDTO - `success` boolean, required — The audio intelligence model succeeded to get a valid output - `is_empty` boolean, required — The audio intelligence model returned an empty value - `exec_time` number, required — Time audio intelligence model took to complete the task - `error` AddonErrorDTO, required - … - `results` string, nullable, required — If `structured_data_extraction` has been enabled, results of the AI structured data extraction for the defined classes. - `sentiment_analysis` SentimentAnalysisDTO - `success` boolean, required — The audio intelligence model succeeded to get a valid output - `is_empty` boolean, required — The audio intelligence model returned an empty value - `exec_time` number, required — Time audio intelligence model took to complete the task - `error` AddonErrorDTO, required - … - `results` string, required — If `sentiment_analysis` has been enabled, Gladia will analyze the sentiments and emotions of the audio - `audio_to_llm` AudioToLlmListDTO - `success` boolean, required — The audio intelligence model succeeded to get a valid output - `is_empty` boolean, required — The audio intelligence model returned an empty value - `exec_time` number, required — Time audio intelligence model took to complete the task - `error` AddonErrorDTO, required - … - `results` AudioToLlmDTO[], nullable, required — If `audio_to_llm` has been enabled, results of the AI custom analysis - … - `sentences` SentencesDTO - `success` boolean, required — The audio intelligence model succeeded to get a valid output - `is_empty` boolean, required — The audio intelligence model returned an empty value - `exec_time` number, required — Time audio intelligence model took to complete the task - `error` AddonErrorDTO, required - … - `results` string[], nullable, required — If `sentences` has been enabled, transcription as sentences. - `display_mode` DisplayModeDTO - `success` boolean, required — The audio intelligence model succeeded to get a valid output - `is_empty` boolean, required — The audio intelligence model returned an empty value - `exec_time` number, required — Time audio intelligence model took to complete the task - `error` AddonErrorDTO, required - … - `results` string[], nullable, required — If `display_mode` has been enabled, proposes an alternative display output. - `chapterization` ChapterizationDTO - `success` boolean, required — The audio intelligence model succeeded to get a valid output - `is_empty` boolean, required — The audio intelligence model returned an empty value - `exec_time` number, required — Time audio intelligence model took to complete the task - `error` AddonErrorDTO, required - … - `results` object, nullable, required — If `chapterization` has been enabled, will generate chapters name for different parts of the given audio. - `diarization` DiarizationDTO - `success` boolean, required — The audio intelligence model succeeded to get a valid output - `is_empty` boolean, required — The audio intelligence model returned an empty value - `exec_time` number, required — Time audio intelligence model took to complete the task - `error` AddonErrorDTO, required - … - `results` UtteranceDTO[], required — [Deprecated] If `diarization` has been enabled, the diarization result will appear here - … - StreamingResponse - `id` string, uuid, required — Id of the job - `request_id` string, required — Debug id - `version` integer, required — API version - `status` 'queued' | 'processing' | 'done' | 'error', required — "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. - `created_at` string, date-time, required — Creation date - `completed_at` string, date-time, nullable — Completion date when status is "done" or "error" - `custom_metadata` object — Custom metadata given in the initial request - `error_code` integer, nullable — HTTP status code of the error if status is "error" - `post_session_metadata` object, required — For debugging purposes, send data that could help to identify issues - `kind` 'live', required - `file` FileResponse - `id` string, required — The file id - `filename` string, nullable, required — The name of the uploaded file - `source` string, nullable, required — The link used to download the file if audio_url was used - `audio_duration` number, nullable, required — Duration of the audio file - `number_of_channels` integer, nullable, required — Number of channels in the audio file - `request_params` StreamingRequestParamsResponse - `encoding` 'wav/pcm' | 'wav/alaw' | 'wav/ulaw' — 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. - `bit_depth` 8 | 16 | 24 | 32 — The bit depth of the audio stream - `sample_rate` 8000 | 16000 | 32000 | 44100 | 48000 — The sample rate of the audio stream - `channels` integer — The number of channels of the audio stream - `model` 'solaria-1' — The model used to process the audio. "solaria-1" is used by default. - `endpointing` number — The endpointing duration in seconds. Endpointing is the duration of silence which will cause an utterance to be considered as finished - `maximum_duration_without_endpointing` number — The maximum duration in seconds without endpointing. If endpointing is not detected after this duration, current utterance will be considered as finished - `language_config` LanguageConfig - `languages` TranscriptionLanguageCodeEnum[] — If one language is set, it will be used for the transcription. Otherwise, language will be auto-detected by the model. - `code_switching` boolean — If true, language will be auto-detected on each utterance. Otherwise, language will be auto-detected on first utterance and then used for the rest of the transcription. If one language is set, this option will be ignored. - `pre_processing` PreProcessingConfig - `audio_enhancer` boolean — If true, apply pre-processing to the audio stream to enhance the quality. - `speech_threshold` number — Sensitivity configuration for Speech Threshold. A value close to 1 will apply stricter thresholds, making it less likely to detect background sounds as speech. - `realtime_processing` RealtimeProcessingConfig - `custom_vocabulary` boolean — If true, enable custom vocabulary for the transcription. - `custom_vocabulary_config` CustomVocabularyConfigDTO - … - `custom_spelling` boolean — If true, enable custom spelling for the transcription. - `custom_spelling_config` CustomSpellingConfigDTO - … - `translation` boolean — If true, enable translation for the transcription - `translation_config` TranslationConfigDTO - … - `named_entity_recognition` boolean — If true, enable named entity recognition for the transcription. - `sentiment_analysis` boolean — If true, enable sentiment analysis for the transcription. - `post_processing` PostProcessingConfig - `summarization` boolean — If true, generates summarization for the whole transcription. - `summarization_config` SummarizationConfigDTO - … - `chapterization` boolean — If true, generates chapters for the whole transcription. - `messages_config` MessagesConfig - `receive_partial_transcripts` boolean — If true, partial transcript will be sent to websocket. - `receive_final_transcripts` boolean — If true, final transcript will be sent to websocket. - `receive_speech_events` boolean — If true, begin and end speech events will be sent to websocket. - `receive_pre_processing_events` boolean — If true, pre-processing events will be sent to websocket. - `receive_realtime_processing_events` boolean — If true, realtime processing events will be sent to websocket. - `receive_post_processing_events` boolean — If true, post-processing events will be sent to websocket. - `receive_acknowledgments` boolean — If true, acknowledgments will be sent to websocket. - `receive_errors` boolean — If true, errors will be sent to websocket. - `receive_lifecycle_events` boolean — If true, lifecycle events will be sent to websocket. - `callback` boolean — If true, messages will be sent to configured url. - `callback_config` CallbackConfig - `url` string, uri — URL on which we will do a `POST` request with configured messages - `receive_partial_transcripts` boolean — If true, partial transcript will be sent to the defined callback. - `receive_final_transcripts` boolean — If true, final transcript will be sent to the defined callback. - `receive_speech_events` boolean — If true, begin and end speech events will be sent to the defined callback. - `receive_pre_processing_events` boolean — If true, pre-processing events will be sent to the defined callback. - `receive_realtime_processing_events` boolean — If true, realtime processing events will be sent to the defined callback. - `receive_post_processing_events` boolean — If true, post-processing events will be sent to the defined callback. - `receive_acknowledgments` boolean — If true, acknowledgments will be sent to the defined callback. - `receive_errors` boolean — If true, errors will be sent to the defined callback. - `receive_lifecycle_events` boolean — If true, lifecycle events will be sent to the defined callback. - `result` StreamingTranscriptionResultWithMessagesDTO - `metadata` TranscriptionMetadataDTO, required - `audio_duration` number, required — Duration of the transcribed audio file - `number_of_distinct_channels` integer, required — Number of distinct channels in the transcribed audio file - `billing_time` number, required — Billed duration in seconds (audio_duration * number_of_distinct_channels) - `transcription_time` number, required — Duration of the transcription in seconds - `transcription` TranscriptionDTO - `full_transcript` string, required — All transcription on text format without any other information - `languages` TranscriptionLanguageCodeEnum[], required — All the detected languages in the audio sorted from the most detected to the less detected - `sentences` SentencesDTO[] — If `sentences` has been enabled, sentences results - … - `subtitles` SubtitleDTO[] — If `subtitles` has been enabled, subtitles results - … - `utterances` UtteranceDTO[], required — Transcribed speech utterances present in the audio - … - `translation` TranslationDTO - `success` boolean, required — The audio intelligence model succeeded to get a valid output - `is_empty` boolean, required — The audio intelligence model returned an empty value - `exec_time` number, required — Time audio intelligence model took to complete the task - `error` AddonErrorDTO, required - … - `results` TranslationResultDTO[], nullable, required — List of translated transcriptions, one for each `target_languages` - … - `summarization` SummarizationDTO - `success` boolean, required — The audio intelligence model succeeded to get a valid output - `is_empty` boolean, required — The audio intelligence model returned an empty value - `exec_time` number, required — Time audio intelligence model took to complete the task - `error` AddonErrorDTO, required - … - `results` string, nullable, required — If `summarization` has been enabled, summary of the transcription - `named_entity_recognition` NamedEntityRecognitionDTO - `success` boolean, required — The audio intelligence model succeeded to get a valid output - `is_empty` boolean, required — The audio intelligence model returned an empty value - `exec_time` number, required — Time audio intelligence model took to complete the task - `error` AddonErrorDTO, required - … - `results` NamedEntityRecognitionResult[], nullable, required — If `named_entity_recognition` has been enabled, the detected entities. - … - `sentiment_analysis` SentimentAnalysisDTO - `success` boolean, required — The audio intelligence model succeeded to get a valid output - `is_empty` boolean, required — The audio intelligence model returned an empty value - `exec_time` number, required — Time audio intelligence model took to complete the task - `error` AddonErrorDTO, required - … - `results` string, required — If `sentiment_analysis` has been enabled, Gladia will analyze the sentiments and emotions of the audio - `chapterization` ChapterizationDTO - `success` boolean, required — The audio intelligence model succeeded to get a valid output - `is_empty` boolean, required — The audio intelligence model returned an empty value - `exec_time` number, required — Time audio intelligence model took to complete the task - `error` AddonErrorDTO, required - … - `results` object, nullable, required — If `chapterization` has been enabled, will generate chapters name for different parts of the given audio. - `messages` string[] — Real-Time messages sent by the server during the live transcription ## Other responses - `401` — You don't have the permissions to access transcription jobs --- [API](https://skmtc.net/gladia/apis/gladia-control-api.md) · [All operations](https://skmtc.net/gladia/apis/gladia-control-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gladia/gladia-control-api/versions/8ec9ebfee489/schema)