--- title: "List Recordings" method: GET path: "/api/v1/recording/" tags: ["recording"] --- # List Recordings `GET /api/v1/recording/` The base rate limit for this endpoint is: - 60 requests per min per workspace ## Query parameters - `bot_id` string, uuid - `created_at_after` string, date-time - `created_at_before` string, date-time - `cursor` string - `desktop_sdk_upload_id` string, uuid - `status_code` 'done' | 'failed' | 'paused' | 'processing', nullable ## Response `200` - PaginatedRecordingList - `next` string, nullable - `previous` string, nullable - `results` Recording[] - `id` string, uuid, required - `created_at` string, date-time, required - `started_at` string, date-time, nullable, required - `completed_at` string, date-time, nullable, required - `status` RecordingStatus, required - `code` 'processing' | 'paused' | 'done' | 'failed' | 'deleted', required — * `processing` - Processing * `paused` - Paused * `done` - Done * `failed` - Failed * `deleted` - Deleted - `sub_code` string, nullable, required - `updated_at` string, date-time, required - `media_shortcuts` RecordingShortcuts, required - `video_mixed` VideoMixedArtifactShortcut, required - `id` string, uuid, required - `created_at` string, date-time, required - `status` ArtifactStatus, required - `code` 'processing' | 'done' | 'failed' | 'deleted', required — * `processing` - Processing * `done` - Done * `failed` - Failed * `deleted` - Deleted - `sub_code` string, nullable, required - `updated_at` string, date-time, required - `metadata` object, required - `data` VideoMixedArtifactData, required - `download_url` string, uri, nullable, required - `format` 'mp4', required — * `mp4` - Mp4 - `transcript` TranscriptArtifactShortcut, required - `id` string, uuid, required - `created_at` string, date-time, required - `status` ArtifactStatus, required - `code` 'processing' | 'done' | 'failed' | 'deleted', required — * `processing` - Processing * `done` - Done * `failed` - Failed * `deleted` - Deleted - `sub_code` string, nullable, required - `updated_at` string, date-time, required - `metadata` object, required - `data` TranscriptArtifactData, required - `download_url` string, uri, nullable, required — Download transcript for the recording. **[See response format here](https://docs.recall.ai/docs/download-schemas#json-transcript-download-url)** - `provider_data_download_url` string, uri, nullable, required — Download raw transcription data received from the provider for the recording. **[See response format here](https://docs.recall.ai/docs/download-schemas#json-transcript-provider-data-download-url)** - `diarization` TranscriptArtifactDiarization, required - `use_separate_streams_when_available` boolean, required - `provider` TranscriptArtifactProvider, required - `assembly_ai_async` object, nullable, required — The parameters for creating a transcript - `audio_end_at` integer — The point in time, in milliseconds, to stop transcribing in your media file. See [Set the start and end of the transcript](https://www.assemblyai.com/docs/pre-recorded-audio/set-the-start-and-end-of-the-transcript) for more details. - `audio_start_from` integer — The point in time, in milliseconds, to begin transcribing in your media file. See [Set the start and end of the transcript](https://www.assemblyai.com/docs/pre-recorded-audio/set-the-start-and-end-of-the-transcript) for more details. - `auto_chapters` boolean — Enable [Auto Chapters](https://www.assemblyai.com/docs/speech-understanding/auto-chapters), can be true or false - `auto_highlights` boolean — Enable [Key Phrases](https://www.assemblyai.com/docs/speech-understanding/key-phrases), either true or false - `content_safety` boolean — Enable [Content Moderation](https://www.assemblyai.com/docs/content-moderation), can be true or false - `content_safety_confidence` integer — The confidence threshold for the [Content Moderation](https://www.assemblyai.com/docs/content-moderation) model. Values must be between 25 and 100. - `custom_spelling` object[] — Customize how words are spelled and formatted using to and from values. See [Custom Spelling](https://www.assemblyai.com/docs/pre-recorded-audio/custom-spelling) for more details. - … - `disfluencies` boolean — Transcribe [Filler Words](https://www.assemblyai.com/docs/pre-recorded-audio/filler-words), like "umm", in your media file; can be true or false - `entity_detection` boolean — Enable [Entity Detection](https://www.assemblyai.com/docs/speech-understanding/entity-detection), can be true or false - `filter_profanity` boolean — Filter profanity from the transcribed text, can be true or false. See [Profanity Filtering](https://www.assemblyai.com/docs/profanity-filtering) for more details. - `format_text` boolean — Enable [Text Formatting](https://www.assemblyai.com/docs/pre-recorded-audio), can be true or false - `iab_categories` boolean — Enable [Topic Detection](https://www.assemblyai.com/docs/speech-understanding/topic-detection), can be true or false - `keyterms_prompt` string[] — Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3-Pro) domain-specific words or phrases (maximum 6 words per phrase). See [Keyterms Prompting](https://www.assemblyai.com/docs/pre-recorded-audio/keyterms-prompting) for more details. - `language_code` union — The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/pre-recorded-audio/supported-languages). The default value is 'en_us'. - … - `language_codes` string[], nullable — The language codes of your audio file. Used for [Code switching](https://www.assemblyai.com/docs/speech-to-text/pre-recorded-audio/code-switching) One of the values specified must be `en`. - `language_confidence_threshold` number, float — The confidence threshold for the automatically detected language. An error will be returned if the language confidence is below this threshold. Defaults to 0. See [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection) for more details. - `language_detection` boolean — Enable [Automatic language detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection), either true or false. - `language_detection_options` object — Specify options for [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection). - … - `multichannel` boolean — Enable [Multichannel](https://www.assemblyai.com/docs/pre-recorded-audio/multichannel) transcription, can be true or false. - `prompt` string — Provide natural language prompting of up to 1,500 words of contextual information to the model. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for best practices. Note: This parameter is only supported for the Universal-3-Pro model. - `punctuate` boolean — Enable [Automatic Punctuation](https://www.assemblyai.com/docs/pre-recorded-audio), can be true or false - `redact_pii` boolean — Redact PII from the transcribed text using the Redact PII model, can be true or false. See [PII Redaction](https://www.assemblyai.com/docs/pii-redaction) for more details. - `redact_pii_audio` boolean — Generate a copy of the original media file with spoken PII "beeped" out, can be true or false. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) for more details. - `redact_pii_audio_options` object — Specify options for [PII redacted audio](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) files. - … - `redact_pii_audio_quality` 'mp3' | 'wav' — Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) for more details. - `redact_pii_policies` string[] — The list of PII Redaction policies to enable. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction) for more details. - `redact_pii_sub` union — The replacement logic for detected PII, can be `entity_type` or `hash`. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction) for more details. - … - `sentiment_analysis` boolean — Enable [Sentiment Analysis](https://www.assemblyai.com/docs/speech-understanding/sentiment-analysis), can be true or false - `speaker_labels` boolean — Enable [Speaker diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization), can be true or false - `speaker_options` object — Specify options for [Speaker diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization#set-a-range-of-possible-speakers). Use this to set a range of possible speakers. - … - `speakers_expected` integer, nullable — Tells the speaker label model how many speakers it should attempt to identify. See [Set number of speakers expected](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization#set-number-of-speakers-expected) for more details. - `speech_models` string[] — List multiple speech models in priority order, allowing our system to automatically route your audio to the best available option. See [Model Selection](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model) for available models and routing behavior. - `speech_threshold` number, float, nullable — Reject audio files that contain less than this fraction of speech. Valid values are in the range [0, 1] inclusive. See [Speech Threshold](https://www.assemblyai.com/docs/speech-threshold) for more details. - `speech_understanding` object — Enable speech understanding tasks like [Translation](https://www.assemblyai.com/docs/speech-understanding/translation), [Speaker Identification](https://www.assemblyai.com/docs/speech-understanding/speaker-identification), and [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting). See the task-specific docs for available options and configuration. - … - `summarization` boolean — Enable [Summarization](https://www.assemblyai.com/docs/speech-understanding/summarization), can be true or false - `summary_model` 'informative' | 'conversational' | 'catchy' — The model to summarize the transcript - `summary_type` 'bullets' | 'bullets_verbose' | 'gist' | 'headline' | 'paragraph' — The type of summary - `temperature` number — Control the amount of randomness injected into the model's response. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for more details. Note: This parameter can only be used with the Universal-3-Pro model. - `webhook_auth_header_name` string, nullable — The header name to be sent with the transcript completed or failed [webhook](https://www.assemblyai.com/docs/deployment/webhooks-for-pre-recorded-audio) requests - `webhook_auth_header_value` string, nullable — The header value to send back with the transcript completed or failed [webhook](https://www.assemblyai.com/docs/deployment/webhooks-for-pre-recorded-audio) requests for added security - `webhook_url` string, url — The URL to which we send [webhook](https://www.assemblyai.com/docs/deployment/webhooks-for-pre-recorded-audio) requests. - `custom_topics` boolean — This parameter does not currently have any functionality attached to it. - `speech_model` union — This parameter has been replaced with the `speech_models` parameter, learn more about the `speech_models` parameter [here](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model). - … - `topics` string[] — This parameter does not currently have any functionality attached to it. - `deepgram_async` object, nullable, required - `callback` string - `callback_method` 'POST' | 'PUT' - `custom_topic` union - … - `custom_topic_mode` 'extended' | 'strict' - `custom_intent` union - … - `custom_intent_mode` 'extended' | 'strict' - `detect_entities` boolean - `detect_language` union - … - `diarize` boolean - `dictation` boolean - `encoding` 'linear16' | 'flac' | 'mulaw' | 'amr-nb' | 'amr-wb' | 'opus' | 'speex' | 'g729' - `extra` union - … - `filler_words` boolean - `intents` boolean - `keyterm` string[] - `keywords` union - … - `language` 'bg' | 'ca' | 'zh' | 'zh-CN' | 'zh-TW' | 'zh-HK' | 'zh-Hans' | 'zh-Hant' | 'cs' | 'da' | 'da-DK' | 'nl' | 'nl-BE' | 'en' | 'en-US' | 'en-AU' | 'en-GB' | 'en-NZ' | 'en-IN' | 'et' | 'fi' | 'fr' | 'fr-CA' | 'de' | 'de-CH' | 'el' | 'hi' | 'hi-Latn' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'ko-KR' | 'lv' | 'lt' | 'ms' | 'multi' | 'no' | 'pl' | 'pt' | 'pt-BR' | 'pt-PT' | 'ro' | 'ru' | 'sk' | 'es' | 'es-419' | 'es-LATAM' | 'sv' | 'sv-SE' | 'taq' | 'th' | 'th-TH' | 'tr' | 'uk' | 'vi' - `measurements` boolean - `mip_opt_out` boolean - `model` union - … - `multichannel` boolean - `numerals` boolean - `paragraphs` boolean - `profanity_filter` boolean - `punctuate` boolean - `redact` union - … - `replace` union - … - `search` union - … - `sentiment` boolean - `smart_format` boolean - `summarize` unknown - `tag` union - … - `topics` boolean - `utterances` boolean - `utt_split` number - `version` union - … - `credential_id` string — The ID of the Deepgram credential to use for this transcription. If not specified, the default credential will be used. - `gladia_v2_async` object, nullable, required - `context_prompt` string — **[Deprecated]** Context to feed the transcription model with for possible better accuracy - `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` object — **[Beta]** Custom vocabulary configuration, if `custom_vocabulary` is enabled - … - `detect_language` boolean — **[Deprecated]** Use `language_config` instead. Detect the language from the given audio - `enable_code_switching` boolean — **[Deprecated]** Use `language_config` instead.Detect multiple languages in the given audio - `code_switching_config` object — **[Deprecated]** Use `language_config` instead. Specify the configuration for code switching - … - `language` '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' — **[Deprecated]** Use `language_config` instead. Set the spoken language for the given audio (ISO 639 standard) - `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` object — Customize the callback behaviour (url and http method) - … - `subtitles` boolean — Enable subtitles generation for this transcription - `subtitles_config` object — Configuration for subtitles generation if `subtitles` is enabled - … - `diarization` boolean — Enable speaker recognition (diarization) for this audio - `diarization_config` object — Speaker recognition configuration, if `diarization` is enabled - … - `translation` boolean — **[Beta]** Enable translation for this audio - `translation_config` object — **[Beta]** Translation configuration, if `translation` is enabled - … - `summarization` boolean — **[Beta]** Enable summarization for this audio - `summarization_config` object — **[Beta]** Summarization configuration, if `summarization` is enabled - … - `moderation` boolean — **[Alpha]** Enable moderation for this audio - `named_entity_recognition` boolean — **[Alpha]** Enable named entity recognition for this audio - `chapterization` boolean — **[Alpha]** Enable chapterization for this audio - `name_consistency` boolean — **[Alpha]** Enable names consistency for this audio - `custom_spelling` boolean — **[Alpha]** Enable custom spelling for this audio - `custom_spelling_config` object — **[Alpha]** Custom spelling configuration, if `custom_spelling` is enabled - … - `structured_data_extraction` boolean — **[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 — **[Alpha]** Enable sentiment analysis for this audio - `audio_to_llm` boolean — **[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 — Enable sentences for this audio - `display_mode` boolean — **[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 — **[Alpha]** Use enhanced punctuation for this audio - `language_config` object — Specify the language configuration - … - `rev_async` object, nullable, required - `metadata` string, nullable — Optional metadata for the job - `delete_after` string, date-span, nullable — Optional setting for the number of Seconds after job completion when the job should be auto-deleted - `language` string, nullable — Optional language setting for foreign languages - `skip_diarization` boolean, nullable — Optional setting for turning on/off diarization. If not set, we will assume the value is false. - `skip_postprocessing` boolean, nullable — Optional setting for turning on/off postprocessing. If not set, we will assume the value is false. - `custom_vocabularies` object[], nullable — Optional setting for passing in custom vocabularies. - … - `custom_vocabulary_id` string, nullable — The id of the prebuilt custom vocabulary job - `strict_custom_vocabulary` boolean, nullable — If true, only exact phrases submitted in the Rev.Ai.Api.Models.SubmitJobOptions.CustomVocabularies option will be used as custom vocabulary, i.e. phrases will not be split into individual words for processing. Defaults to true if Rev.Ai.Api.Models.SubmitJobOptions.CustomVocabularies is set. - `skip_punctuation` boolean, nullable — Optional setting for disabling punctuation. If unset, the value is assumed to be false. - `remove_disfluencies` boolean, nullable — Optional setting for removing disfluencies If unset the value is assumed to be false - `remove_atmospherics` boolean, nullable — Optional setting for removing atmospherics If unset the value is assumed to be false - `filter_profanity` boolean, nullable — Optional setting for removing profanities If unset the value is assumed to be false - `add_data_labels` boolean, nullable — Optional setting for adding data classification labels If unset the value is assumed to be false - `enable_redaction` boolean, nullable — Optional setting for redacting certain data labels If unset the value is assumed to be false - `speaker_channels_count` integer, nullable — Optional speaker channels count used to indicate how many individual channels to transcribe for a given audio - `speakers_count` integer, nullable — Optional count of speakers in the audio to improve diarization accuracy - `alternatives_count` integer, nullable — Optional count of alternatives to generate - `deletion_length_penalty` integer, nullable - `chunk_size` string, date-span, nullable — Optional chunk size to be sent to Revspeech for processing - `transcriber` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 - `verbatim` boolean, nullable — Instructs Revver to transcribe audio with all details including disfluencies and other verbal interactions such as laughter - `rush` boolean, nullable — Whether human order should be rushed at a greater cost to the customer - `segments_to_transcribe` object[], nullable — Specific segments of the file to be transcribed by a human - … - `test_mode` boolean, nullable — Whether human order is test mode and should return a dummy transcript - `speaker_names` object[], nullable — Speaker names for human transcription - … - `predict_topics` boolean, nullable — Whether to predict topics while performing speech rec - `top_nwords` integer, nullable — Returns the top n words of a transcript. Defaults to 0 - `forced_alignment` boolean, nullable — Whether improved alignment should be used with transcription - `enable_fusion` boolean, nullable — Whether transcription should be done with fusion - `domain` 0 | 1 - `apply_duration_padding` boolean, nullable — If set adds one second of silence to the audio at the end - `diarization_type` 0 | 10 | 20 - `summarization_config` object — Summarization options. - … - `captions_config` object — Caption options. - `translation_config` object — Options for translation as part of Async job request - … - `speechmatics_async` object, nullable, required — JSON object that contains various groups of job configuration parameters. Based on the value of `type`, a type-specific object such as `transcription_config` is required to be present to specify all configuration settings or parameters needed to process the job inputs as expected. If the results of the job are to be forwarded on completion, `notification_config` can be provided with a list of callbacks to be made; no assumptions should be made about the order in which they will occur. Customer specific job details or metadata can be supplied in `tracking`, and this information will be available where possible in the job results and in callbacks. - `alignment_config` object - … - `transcription_config` object - … - `tracking` object - … - `output_config` object - … - `translation_config` object - … - `language_identification_config` object - … - `summarization_config` object - … - `sentiment_analysis_config` object - `topic_detection_config` object - … - `auto_chapters_config` object - `audio_events_config` object - … - `recallai_async` object, nullable, required — Docs: https://docs.recall.ai/docs/recallai-transcription - `language_code` 'auto' | 'bg' | 'ca' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'en_au' | 'en_uk' | 'en_us' | 'es' | 'et' | 'fi' | 'fr' | 'he' | 'hi' | 'hr' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lt' | 'lv' | 'ms' | 'nl' | 'no' | 'pl' | 'pt' | 'ro' | 'ru' | 'sk' | 'sv' | 'th' | 'tr' | 'uk' | 'vi' | 'zh' — Must be `en` in low latency mode. Docs: https://docs.recall.ai/docs/recallai-transcription * `auto` - auto * `bg` - bg * `ca` - ca * `cs` - cs * `da` - da * `de` - de * `el` - el * `en` - en * `en_au` - en_au * `en_uk` - en_uk * `en_us` - en_us * `es` - es * `et` - et * `fi` - fi * `fr` - fr * `he` - he * `hi` - hi * `hr` - hr * `hu` - hu * `id` - id * `it` - it * `ja` - ja * `ko` - ko * `lt` - lt * `lv` - lv * `ms` - ms * `nl` - nl * `no` - no * `pl` - pl * `pt` - pt * `ro` - ro * `ru` - ru * `sk` - sk * `sv` - sv * `th` - th * `tr` - tr * `uk` - uk * `vi` - vi * `zh` - zh - `spelling` RecallaiSpellingEntry[] — List of text strings to find/replace in the transcript. - … - `key_terms` string[] — Increases the chances that these terms appear in the transcript over some sound-alikes. - `filter_profanity` boolean - `google_speech_v2_async` object, nullable, required — Docs: https://docs.cloud.google.com/speech-to-text/docs/reference/rest/v2/projects.locations.recognizers/batchRecognize - `recognizer` string — Required. The name of the Recognizer to use during recognition. The expected format is `projects/{project}/locations/{location}/recognizers/{recognizer}`. The {recognizer} segment may be set to `_` to use an empty implicit Recognizer. - `config` object — Provides information to the Recognizer that specifies how to process the recognition request. - … - `configMask` string, google-fieldmask — The list of fields in config that override the values in the default_recognition_config of the recognizer during this recognition request. If no mask is provided, all given fields in config override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard (`*`) is provided, config completely overrides and replaces the config in the recognizer for this recognition request. - `aws_transcribe_async` object, nullable, required — Docs: https://docs.aws.amazon.com/transcribe/latest/APIReference/API_StartTranscriptionJob.html - `elevenlabs_async` object, nullable, required — Docs: https://elevenlabs.io/docs/api-reference/speech-to-text - `model_id` 'scribe_v1' | 'scribe_v2', required — The ID of the model to use for transcription. - `language_code` union — An ISO-639-1 or ISO-639-3 language_code corresponding to the language of the audio file. Can sometimes improve transcription performance if known beforehand. Defaults to null, in this case the language is predicted automatically. - … - `tag_audio_events` boolean — Whether to tag audio events like (laughter), (footsteps), etc. in the transcription. - `num_speakers` union — The maximum amount of speakers talking in the uploaded file. Can help with predicting who speaks when. The maximum amount of speakers that can be predicted is 32. Defaults to null, in this case the amount of speakers is set to the maximum value the model supports. - … - `diarize` boolean — Whether to annotate which speaker is currently talking in the uploaded file. - `diarization_threshold` union — Diarization threshold to apply during speaker diarization. A higher value means there will be a lower chance of one speaker being diarized as two different speakers but also a higher chance of two different speakers being diarized as one speaker (less total speakers predicted). A low value means there will be a higher chance of one speaker being diarized as two different speakers but also a lower chance of two different speakers being diarized as one speaker (more total speakers predicted). Can only be set when diarize=True and num_speakers=None. Defaults to None, in which case we will choose a threshold based on the model_id (0.22 usually). - … - `additional_formats` union[] - … - `webhook_id` union — Optional specific webhook ID to send the transcription result to. Only valid when webhook is set to true. If not provided, transcription will be sent to all configured speech-to-text webhooks. - … - `temperature` union — Controls the randomness of the transcription output. Accepts values between 0.0 and 2.0, where higher values result in more diverse and less deterministic results. If omitted, we will use a temperature based on the model you selected which is usually 0. - … - `seed` union — If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed. Must be an integer between 0 and 2147483647. - … - `webhook_metadata` union — Optional metadata to be included in the webhook response. This should be a JSON string representing an object with a maximum depth of 2 levels and maximum size of 16KB. Useful for tracking internal IDs, job references, or other contextual information. - … - `entity_detection` union — Detect entities in the transcript. Can be 'all' to detect all entities, a single entity type or category string, or a list of entity types/categories. Categories include 'pii', 'phi', 'pci', 'other', 'offensive_language'. When enabled, detected entities will be returned in the 'entities' field with their text, type, and character positions. - … - `keyterms` string[] — A list of keyterms to bias the transcription towards. The keyterms are words or phrases you want the model to recognise more accurately. The number of keyterms cannot exceed 100. The length of each keyterm must be less than 50 characters. Keyterms can contain at most 5 words (after normalisation). For example ["hello", "world", "technical term"] - `assembly_ai_async_chunked` object — Docs: https://www.assemblyai.com/docs/api-reference/transcripts/submit - `audio_end_at` integer — The point in time, in milliseconds, to stop transcribing in your media file. See [Set the start and end of the transcript](https://www.assemblyai.com/docs/pre-recorded-audio/set-the-start-and-end-of-the-transcript) for more details. - `audio_start_from` integer — The point in time, in milliseconds, to begin transcribing in your media file. See [Set the start and end of the transcript](https://www.assemblyai.com/docs/pre-recorded-audio/set-the-start-and-end-of-the-transcript) for more details. - `auto_chapters` boolean — Enable [Auto Chapters](https://www.assemblyai.com/docs/speech-understanding/auto-chapters), can be true or false - `auto_highlights` boolean — Enable [Key Phrases](https://www.assemblyai.com/docs/speech-understanding/key-phrases), either true or false - `content_safety` boolean — Enable [Content Moderation](https://www.assemblyai.com/docs/content-moderation), can be true or false - `content_safety_confidence` integer — The confidence threshold for the [Content Moderation](https://www.assemblyai.com/docs/content-moderation) model. Values must be between 25 and 100. - `custom_spelling` object[] — Customize how words are spelled and formatted using to and from values. See [Custom Spelling](https://www.assemblyai.com/docs/pre-recorded-audio/custom-spelling) for more details. - … - `disfluencies` boolean — Transcribe [Filler Words](https://www.assemblyai.com/docs/pre-recorded-audio/filler-words), like "umm", in your media file; can be true or false - `entity_detection` boolean — Enable [Entity Detection](https://www.assemblyai.com/docs/speech-understanding/entity-detection), can be true or false - `filter_profanity` boolean — Filter profanity from the transcribed text, can be true or false. See [Profanity Filtering](https://www.assemblyai.com/docs/profanity-filtering) for more details. - `format_text` boolean — Enable [Text Formatting](https://www.assemblyai.com/docs/pre-recorded-audio), can be true or false - `iab_categories` boolean — Enable [Topic Detection](https://www.assemblyai.com/docs/speech-understanding/topic-detection), can be true or false - `keyterms_prompt` string[] — Improve accuracy with up to 200 (for Universal-2) or 1000 (for Universal-3-Pro) domain-specific words or phrases (maximum 6 words per phrase). See [Keyterms Prompting](https://www.assemblyai.com/docs/pre-recorded-audio/keyterms-prompting) for more details. - `language_code` union — The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/pre-recorded-audio/supported-languages). The default value is 'en_us'. - … - `language_codes` string[], nullable — The language codes of your audio file. Used for [Code switching](https://www.assemblyai.com/docs/speech-to-text/pre-recorded-audio/code-switching) One of the values specified must be `en`. - `language_confidence_threshold` number, float — The confidence threshold for the automatically detected language. An error will be returned if the language confidence is below this threshold. Defaults to 0. See [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection) for more details. - `language_detection` boolean — Enable [Automatic language detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection), either true or false. - `language_detection_options` object — Specify options for [Automatic Language Detection](https://www.assemblyai.com/docs/pre-recorded-audio/language-detection). - … - `multichannel` boolean — Enable [Multichannel](https://www.assemblyai.com/docs/pre-recorded-audio/multichannel) transcription, can be true or false. - `prompt` string — Provide natural language prompting of up to 1,500 words of contextual information to the model. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for best practices. Note: This parameter is only supported for the Universal-3-Pro model. - `punctuate` boolean — Enable [Automatic Punctuation](https://www.assemblyai.com/docs/pre-recorded-audio), can be true or false - `redact_pii` boolean — Redact PII from the transcribed text using the Redact PII model, can be true or false. See [PII Redaction](https://www.assemblyai.com/docs/pii-redaction) for more details. - `redact_pii_audio` boolean — Generate a copy of the original media file with spoken PII "beeped" out, can be true or false. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) for more details. - `redact_pii_audio_options` object — Specify options for [PII redacted audio](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) files. - … - `redact_pii_audio_quality` 'mp3' | 'wav' — Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction#request-for-redacted-audio) for more details. - `redact_pii_policies` string[] — The list of PII Redaction policies to enable. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction) for more details. - `redact_pii_sub` union — The replacement logic for detected PII, can be `entity_type` or `hash`. See [PII redaction](https://www.assemblyai.com/docs/pii-redaction) for more details. - … - `sentiment_analysis` boolean — Enable [Sentiment Analysis](https://www.assemblyai.com/docs/speech-understanding/sentiment-analysis), can be true or false - `speaker_labels` boolean — Enable [Speaker diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization), can be true or false - `speaker_options` object — Specify options for [Speaker diarization](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization#set-a-range-of-possible-speakers). Use this to set a range of possible speakers. - … - `speakers_expected` integer, nullable — Tells the speaker label model how many speakers it should attempt to identify. See [Set number of speakers expected](https://www.assemblyai.com/docs/pre-recorded-audio/speaker-diarization#set-number-of-speakers-expected) for more details. - `speech_models` string[] — List multiple speech models in priority order, allowing our system to automatically route your audio to the best available option. See [Model Selection](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model) for available models and routing behavior. - `speech_threshold` number, float, nullable — Reject audio files that contain less than this fraction of speech. Valid values are in the range [0, 1] inclusive. See [Speech Threshold](https://www.assemblyai.com/docs/speech-threshold) for more details. - `speech_understanding` object — Enable speech understanding tasks like [Translation](https://www.assemblyai.com/docs/speech-understanding/translation), [Speaker Identification](https://www.assemblyai.com/docs/speech-understanding/speaker-identification), and [Custom Formatting](https://www.assemblyai.com/docs/speech-understanding/custom-formatting). See the task-specific docs for available options and configuration. - … - `summarization` boolean — Enable [Summarization](https://www.assemblyai.com/docs/speech-understanding/summarization), can be true or false - `summary_model` 'informative' | 'conversational' | 'catchy' — The model to summarize the transcript - `summary_type` 'bullets' | 'bullets_verbose' | 'gist' | 'headline' | 'paragraph' — The type of summary - `temperature` number — Control the amount of randomness injected into the model's response. See the [Prompting Guide](https://www.assemblyai.com/docs/pre-recorded-audio/prompting) for more details. Note: This parameter can only be used with the Universal-3-Pro model. - `custom_topics` boolean — This parameter does not currently have any functionality attached to it. - `speech_model` union — This parameter has been replaced with the `speech_models` parameter, learn more about the `speech_models` parameter [here](https://www.assemblyai.com/docs/pre-recorded-audio/select-the-speech-model). - … - `topics` string[] — This parameter does not currently have any functionality attached to it. - `assembly_ai_v3_streaming` object — Docs: https://www.assemblyai.com/docs/api-reference/streaming-api/streaming-api - `speech_model` 'universal-streaming-english' | 'universal-streaming-multilingual' | 'whisper-rt' | 'u3-rt-pro' | 'universal-3-5-pro' — The speech model used for your Streaming session. - `format_turns` boolean — Whether to return formatted final transcripts. - `inactivity_timeout` integer — Optional time in seconds of inactivity before session is terminated. If not set, no inactivity timeout is applied. - `keyterms_prompt` string[] — A list of words and phrases to improve recognition accuracy for. See [Keyterms Prompting](https://www.assemblyai.com/docs/streaming/keyterms-prompting) for more details. - `language_detection` string — Whether to detect the language and return language metadata on utterances and final turns. Only available for the multilingual model. - `max_turn_silence` integer — The maximum amount of silence in milliseconds allowed in a turn before end of turn is triggered. See [Turn Detection](https://www.assemblyai.com/docs/streaming/universal-streaming/turn-detection) for configuration details. - `min_turn_silence` integer — The minimum amount of silence in milliseconds required to detect end of turn when confident. See [Turn Detection](https://www.assemblyai.com/docs/streaming/universal-streaming/turn-detection) for configuration details. - `vad_threshold` number — The confidence threshold (0.0 to 1.0) for classifying audio frames as silence. Frames with VAD confidence below this value are considered silent. Increase for noisy environments to reduce false speech detection. - `end_of_turn_confidence_threshold` number — The confidence threshold (0.0 to 1.0) to use when determining if the end of a turn has been reached. See [Turn Detection](https://www.assemblyai.com/docs/streaming/universal-streaming/turn-detection) for configuration details. - `language` 'en' | 'multi' — The language of your audio stream. - `recallai_streaming` RecallaiStreamingTranscription - `language_code` 'auto' | 'bg' | 'ca' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'en_au' | 'en_uk' | 'en_us' | 'es' | 'et' | 'fi' | 'fr' | 'he' | 'hi' | 'hr' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lt' | 'lv' | 'ms' | 'nl' | 'no' | 'pl' | 'pt' | 'ro' | 'ru' | 'sk' | 'sv' | 'th' | 'tr' | 'uk' | 'vi' | 'zh' — * `auto` - auto * `bg` - bg * `ca` - ca * `cs` - cs * `da` - da * `de` - de * `el` - el * `en` - en * `en_au` - en_au * `en_uk` - en_uk * `en_us` - en_us * `es` - es * `et` - et * `fi` - fi * `fr` - fr * `he` - he * `hi` - hi * `hr` - hr * `hu` - hu * `id` - id * `it` - it * `ja` - ja * `ko` - ko * `lt` - lt * `lv` - lv * `ms` - ms * `nl` - nl * `no` - no * `pl` - pl * `pt` - pt * `ro` - ro * `ru` - ru * `sk` - sk * `sv` - sv * `th` - th * `tr` - tr * `uk` - uk * `vi` - vi * `zh` - zh - `spelling` RecallaiSpellingEntry[] — List of text strings to find/replace in the transcript. - … - `key_terms` string[] — Increases the chances that these terms appear in the transcript over some sound-alikes. - `filter_profanity` boolean - `mode` 'prioritize_low_latency' | 'prioritize_accuracy' — * `prioritize_low_latency` - prioritize_low_latency * `prioritize_accuracy` - prioritize_accuracy - `deepgram_streaming` object — Docs: https://developers.deepgram.com/reference/streaming - `diarize` string — Defaults to `false`. Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0 - `dictation` string — Identify and extract key entities from content in submitted audio - `endpointing` string — Indicates how long Deepgram will wait to detect whether a speaker has finished speaking or pauses for a significant period of time. When set to a value, the streaming endpoint immediately finalizes the transcription for the processed time range and returns the transcript with a speech_final parameter set to true. Can also be set to false to disable endpointing - `extra` unknown - `filler_words` string — Filler Words can help transcribe interruptions in your audio, like "uh" and "um" - `interim_results` string — Specifies whether the streaming endpoint should provide ongoing transcription updates as more audio is received. When set to true, the endpoint sends continuous updates, meaning transcription results may evolve over time - `keyterm` unknown - `keywords` unknown - `language` 'bg' | 'ca' | 'cs' | 'da' | 'da-DK' | 'de' | 'de-CH' | 'el' | 'en' | 'en-AU' | 'en-GB' | 'en-IN' | 'en-NZ' | 'en-US' | 'es' | 'es-419' | 'es-LATAM' | 'et' | 'fi' | 'fr' | 'fr-CA' | 'hi' | 'hi-Latn' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'ko-KR' | 'lt' | 'lv' | 'ms' | 'multi' | 'nl' | 'nl-BE' | 'no' | 'pl' | 'pt' | 'pt-BR' | 'pt-PT' | 'ro' | 'ru' | 'sk' | 'sv' | 'sv-SE' | 'taq' | 'th' | 'th-TH' | 'tr' | 'uk' | 'vi' | 'zh' | 'zh-CN' | 'zh-HK' | 'zh-Hans' | 'zh-Hant' | 'zh-TW' — The [BCP-47 language tag](https://tools.ietf.org/html/bcp47) that hints at the primary spoken language. Depending on the Model you choose only certain languages are available - `mip_opt_out` string — Opts out requests from the Deepgram Model Improvement Program. Refer to our Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip - `model` 'nova-3' | 'nova-3-general' | 'nova-3-medical' | 'nova-2' | 'nova-2-general' | 'nova-2-meeting' | 'nova-2-finance' | 'nova-2-conversationalai' | 'nova-2-voicemail' | 'nova-2-video' | 'nova-2-medical' | 'nova-2-drivethru' | 'nova-2-automotive' | 'nova' | 'nova-general' | 'nova-phonecall' | 'nova-medical' | 'enhanced' | 'enhanced-general' | 'enhanced-meeting' | 'enhanced-phonecall' | 'enhanced-finance' | 'base' | 'meeting' | 'phonecall' | 'finance' | 'conversationalai' | 'voicemail' | 'video' | 'custom' — AI model to use for the transcription - `multichannel` string — Transcribe each audio channel independently - `numerals` string — Convert numbers from written format to numerical format - `profanity_filter` string — Profanity Filter looks for recognized profanity and converts it to the nearest recognized non-profane word or removes it from the transcript completely - `punctuate` string — Add punctuation and capitalization to the transcript - `redact` union — Redaction removes sensitive information from your transcripts - … - `replace` unknown - `search` unknown - `smart_format` string — Apply formatting to transcript output. When set to true, additional formatting will be applied to transcripts to improve readability - `tag` unknown - `utterance_end_ms` unknown - `vad_events` string — Indicates that speech has started. You'll begin receiving Speech Started messages upon speech starting - `version` string — Version of an AI model to use - `gladia_v2_streaming` object — Docs: https://docs.gladia.io/api-reference/v2/live/init - `custom_metadata` object — Custom metadata you can attach to this live transcription - `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` object — Specify the language configuration - … - `pre_processing` object — Specify the pre-processing configuration - … - `realtime_processing` object — Specify the realtime processing configuration - … - `post_processing` object — Specify the post-processing configuration - … - `messages_config` object — Specify the websocket messages configuration - … - `callback` boolean — If true, messages will be sent to configured url. - `callback_config` object — Specify the callback configuration - … - `rev_streaming` object — Docs: https://docs.rev.ai/api/streaming/requests/ - `obscure_expletives` boolean - `delete_after` string, date-span - `audio_options._content_type` string - `audio_options._layout` string - `audio_options._rate` integer - `audio_options._format` string - `audio_options._channels` integer - `transcriber` 0 | 1 - `language` string - `metadata` string - `filter_profanity` boolean - `remove_disfluencies` boolean - `detailed_partials` boolean - `custom_vocabulary_id` string - `delete_after_seconds` integer - `max_segment_duration_seconds` integer - `max_connection_wait_seconds` integer - `allow_interruption` boolean - `enable_speaker_switch` boolean - `start_ts` string, date-span - `skip_postprocessing` boolean - `priority` 0 | 1 - `user_agent` string - `aws_transcribe_streaming` union — You must specify either: - `language_code`(e.g `en-US`) OR - Set `language_identification` to `true` AND specify `language_options`(e.g `en-US,fr-FR,es-US,de-DE,it-IT`). Docs: https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html - object - … - object - … - `speechmatics_streaming` object — You must specify `language` (e.g `en`) Docs: https://docs.speechmatics.com/rt-api-ref#transcription-config - `language` string, required - `domain` string — Request a specialized model based on 'language' but optimized for a particular field, e.g. "finance" or "medical". - `output_locale` string - `additional_vocab` object[] - … - `diarization` 'none' | 'speaker' - `max_delay` number - `max_delay_mode` 'flexible' | 'fixed' - `speaker_diarization_config` object - … - `audio_filtering_config` object - … - `transcript_filtering_config` object - … - `enable_partials` boolean - `enable_entities` boolean - `operating_point` 'standard' | 'enhanced' - `punctuation_overrides` object - … - `conversation_config` object — This mode will detect when a speaker has stopped talking. The end_of_utterance_silence_trigger is the time in seconds after which the server will assume that the speaker has finished speaking, and will emit an EndOfUtterance message. A value of 0 disables the feature. - … - `elevenlabs_streaming` object — Docs: https://elevenlabs.io/docs/api-reference/speech-to-text - `model_id` string — The model to use for transcription. - `language_code` string — ISO 639-1 two-letter language code. When not specified, the model auto-detects the language. - `previous_text` string — Text from a previous transcription session to provide context for the model. Sent in the first message to the WebSocket. - `meeting_captions` object - `language_code` 'cs' | 'de' | 'en' | 'es' | 'fil' | 'fr' | 'he' | 'hi' | 'it' | 'ja' | 'ko' | 'nl' | 'pl' | 'pt' | 'pt-BR' | 'ro' | 'ru' | 'sv' | 'th' | 'tr' | 'uk' | 'vi' | 'zh' | 'null', nullable — * `cs` - Czech * `de` - German * `en` - English * `es` - Spanish * `fil` - Filipino * `fr` - French * `he` - Hebrew * `hi` - Hindi * `it` - Italian * `ja` - Japanese * `ko` - Korean * `nl` - Dutch * `pl` - Polish * `pt` - Portuguese * `pt-BR` - Portuguese (Brazil) * `ro` - Romanian * `ru` - Russian * `sv` - Swedish * `th` - Thai * `tr` - Turkish * `uk` - Ukrainian * `vi` - Vietnamese * `zh` - Chinese - `zoom_rtms` object - `participant_events` ParticipantEventsArtifactShortcut, required - `id` string, uuid, required - `created_at` string, date-time, required - `status` ArtifactStatus, required - `code` 'processing' | 'done' | 'failed' | 'deleted', required — * `processing` - Processing * `done` - Done * `failed` - Failed * `deleted` - Deleted - `sub_code` string, nullable, required - `updated_at` string, date-time, required - `metadata` object, required - `data` ParticipantEventsArtifactData, required - `participant_events_download_url` string, uri, nullable, required — Download all participant events for the recording. **[See response format here](https://docs.recall.ai/docs/download-schemas#json-participant-event-download-url)** - `speaker_timeline_download_url` string, uri, nullable, required — Download speaker timeline for the recording. **[See response format here](https://docs.recall.ai/docs/download-schemas#json-speaker-timeline-download-url)** - `participants_download_url` string, uri, nullable, required — Download all participants for the recording. **[See response format here](https://docs.recall.ai/docs/download-schemas#json-participant-download-url)** - `meeting_metadata` MeetingMetadataArtifactShortcut, required - `id` string, uuid, required - `created_at` string, date-time, required - `status` ArtifactStatus, required - `code` 'processing' | 'done' | 'failed' | 'deleted', required — * `processing` - Processing * `done` - Done * `failed` - Failed * `deleted` - Deleted - `sub_code` string, nullable, required - `updated_at` string, date-time, required - `metadata` object, required - `data` MeetingMetadataArtifactData, required - `title` string, nullable, required - `zoom` MeetingMetadataArtifactDataZoom, required - `meeting_uuid` string, nullable, required - `audio_mixed` AudioMixedArtifactShortcut, required - `id` string, uuid, required - `created_at` string, date-time, required - `status` ArtifactStatus, required - `code` 'processing' | 'done' | 'failed' | 'deleted', required — * `processing` - Processing * `done` - Done * `failed` - Failed * `deleted` - Deleted - `sub_code` string, nullable, required - `updated_at` string, date-time, required - `metadata` object, required - `data` AudioMixedArtifactData, required - `download_url` string, uri, nullable, required - `format` 'mp3' | 'raw', required — * `mp3` - Mp3 * `raw` - Raw - `realtime_endpoints` RealtimeEndpointMinimal[], required - `id` string, uuid, required - `metadata` object, required - `bot` BotMinimal, required - `id` string, uuid, required - `metadata` object, required - `desktop_sdk_upload` DesktopSdkUploadMinimal, required - `id` string, uuid, required - `metadata` object, required - `expires_at` string, date-time, required - `metadata` object, required --- [API](https://skmtc.net/recall/apis/recall-ai-api.md) · [All operations](https://skmtc.net/recall/apis/recall-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/recall/recall-ai-api/revisions/55ce8c277c24/schema)