openapi: 3.1.0 info: title: API Reference version: 1.0.0 paths: /synthesize: post: operationId: synthesize summary: Synchronous text-to-speech synthesis description: Generate speech synchronously from text or SSML. Returns complete audio as base64. tags: - subpackage_textToSpeech parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Successful synthesis content: application/json: schema: $ref: '#/components/schemas/Text-to-Speech_synthesize_Response_200' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' requestBody: content: application/json: schema: type: object properties: voice_uuid: type: string description: Voice UUID to use for synthesis project_uuid: type: string description: Optional project UUID to store the clip title: type: string description: Optional title for the generated clip data: type: string description: Text or SSML to synthesize (max 3,000 characters) model: type: string description: >- Model to use for synthesis. Pass `chatterbox-turbo` to use the Turbo model for lower latency and paralinguistic tag support. If not specified, defaults to Chatterbox or Chatterbox Multilingual based on the voice. Note - Chatterbox-Turbo is supported by all Rapid English voices and Pre Built Library voices. precision: $ref: '#/components/schemas/SynthesizePostRequestBodyContentApplicationJsonSchemaPrecision' description: Audio precision for WAV output output_format: $ref: '#/components/schemas/SynthesizePostRequestBodyContentApplicationJsonSchemaOutputFormat' description: Audio output format sample_rate: $ref: '#/components/schemas/SynthesizePostRequestBodyContentApplicationJsonSchemaSampleRate' description: Audio sample rate in Hz use_hd: type: boolean default: false description: Enable HD synthesis with small latency trade-off apply_custom_pronunciations: type: boolean default: false description: >- When true, automatically applies your team's custom pronunciations to matching words in the input text. Defaults to false. required: - voice_uuid - data /stream: post: operationId: stream-synthesize summary: Streaming text-to-speech synthesis (HTTP) description: Stream audio as it's generated. Returns chunked WAV data for progressive playback. tags: - subpackage_textToSpeech parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Streaming audio response (chunked WAV) content: application/octet-stream: schema: type: string format: binary '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/Error' requestBody: content: application/json: schema: type: object properties: voice_uuid: type: string description: Voice UUID to use for synthesis data: type: string description: Text or SSML to synthesize (max 2000 characters) project_uuid: type: string description: Optional project UUID to store the clip model: type: string description: >- Model to use for synthesis. Pass `chatterbox-turbo` to use the Turbo model for lower latency and paralinguistic tag support. If not specified, defaults to Chatterbox or Chatterbox Multilingual based on the voice. Note - Chatterbox-Turbo is supported by all Rapid English voices and Pre Built Library voices. precision: $ref: '#/components/schemas/StreamPostRequestBodyContentApplicationJsonSchemaPrecision' description: Audio precision sample_rate: $ref: '#/components/schemas/StreamPostRequestBodyContentApplicationJsonSchemaSampleRate' description: Audio sample rate in Hz use_hd: type: boolean default: false description: Enable HD synthesis with small latency trade-off apply_custom_pronunciations: type: boolean default: false description: >- When true, automatically applies your team's custom pronunciations to matching words in the input text. Defaults to false. required: - voice_uuid - data /speech-to-text: get: operationId: list-transcripts summary: List transcripts description: Retrieve paginated list of transcript jobs tags: - subpackage_speechToText parameters: - name: page in: query required: true schema: type: integer default: 1 - name: per_page in: query required: false schema: type: integer default: 25 - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of transcripts content: application/json: schema: $ref: '#/components/schemas/Speech-to-Text_listTranscripts_Response_200' post: operationId: create-transcript summary: Create transcript job description: Submit audio or video for transcription tags: - subpackage_speechToText parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Transcript job created content: application/json: schema: $ref: '#/components/schemas/Speech-to-Text_createTranscript_Response_200' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/Error' requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary description: Audio or video file (max 500 MB, 20 minutes) query: type: string description: Optional intelligence question to evaluate after transcription /speech-to-text/{uuid}: get: operationId: get-transcript summary: Get transcript description: Retrieve transcript status, text, and timestamps tags: - subpackage_speechToText parameters: - name: uuid in: path required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Transcript details content: application/json: schema: $ref: '#/components/schemas/Speech-to-Text_getTranscript_Response_200' /speech-to-text/{uuid}/ask: post: operationId: ask-transcript-question summary: Ask intelligence question description: Submit a question about a completed transcript tags: - subpackage_speechToText parameters: - name: uuid in: path required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Question submitted content: application/json: schema: $ref: '#/components/schemas/Speech-to-Text_askTranscriptQuestion_Response_200' requestBody: content: application/json: schema: type: object properties: query: type: string description: Question to ask about the transcript required: - query /speech-to-text/{uuid}/questions: get: operationId: list-transcript-questions summary: List intelligence questions description: List all questions asked about a transcript tags: - subpackage_speechToText parameters: - name: uuid in: path required: true schema: type: string format: uuid - name: page in: query required: true schema: type: integer default: 1 - name: per_page in: query required: false schema: type: integer default: 25 - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of questions content: application/json: schema: $ref: '#/components/schemas/Speech-to-Text_listTranscriptQuestions_Response_200' /speech-to-text/{uuid}/questions/{question_uuid}: get: operationId: get-transcript-question summary: Get intelligence question status description: Check the status of a specific question tags: - subpackage_speechToText parameters: - name: uuid in: path required: true schema: type: string format: uuid - name: question_uuid in: path required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Question details content: application/json: schema: $ref: '#/components/schemas/Speech-to-Text_getTranscriptQuestion_Response_200' /edit: get: operationId: list-audio-edits summary: List audio edits description: Retrieve paginated list of audio edits tags: - subpackage_audioEdit parameters: - name: page in: query required: true schema: type: integer default: 1 - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of audio edits content: application/json: schema: $ref: '#/components/schemas/Audio Edit_listAudioEdits_Response_200' post: operationId: create-audio-edit summary: Create audio edit description: Edit audio segments using voice synthesis tags: - subpackage_audioEdit parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Edit job created content: application/json: schema: $ref: '#/components/schemas/Audio Edit_createAudioEdit_Response_200' requestBody: content: multipart/form-data: schema: type: object properties: input_audio: type: string format: binary description: WAV, MP3, M4A, or WMA file (< 20 seconds) original_transcript: type: string description: Accurate transcript of the uploaded audio target_transcript: type: string description: Desired replacement text voice_uuid: type: string description: Voice used to render the edited segment required: - input_audio - original_transcript - target_transcript - voice_uuid /edit/{audio_edit_uuid}: get: operationId: get-audio-edit summary: Get audio edit description: Get status and result of an audio edit tags: - subpackage_audioEdit parameters: - name: audio_edit_uuid in: path required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Audio edit details content: application/json: schema: $ref: '#/components/schemas/Audio Edit_getAudioEdit_Response_200' /audio_enhancements: get: operationId: list-audio-enhancements summary: List audio enhancements description: Returns a paginated list of all audio enhancements for your team, ordered by most recent first. tags: - subpackage_audioEnhancement parameters: - name: page in: query description: Page number (starting from 1). required: true schema: type: integer - name: page_size in: query description: Items per page (10 to 1000). Default 10. required: false schema: type: integer default: 10 - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of enhancements content: application/json: schema: $ref: '#/components/schemas/Audio Enhancement_listAudioEnhancements_Response_200' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ListAudioEnhancementsRequestBadRequestError' post: operationId: create-audio-enhancement summary: Create audio enhancement description: | Submit an audio file for enhancement. Processing happens asynchronously in the background. The API defaults to the v2 enhancement engine. The v1 engine is legacy and will be sunset in a future release. tags: - subpackage_audioEnhancement parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '202': description: Enhancement job created content: application/json: schema: $ref: '#/components/schemas/Audio Enhancement_createAudioEnhancement_Response_202' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/CreateAudioEnhancementRequestBadRequestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/CreateAudioEnhancementRequestForbiddenError' requestBody: content: multipart/form-data: schema: type: object properties: audio_file: type: string format: binary description: Audio file to enhance (WAV, MP3, M4A, MP4, OGG, AAC, FLAC). Max 150 MB. enhancement_engine: $ref: '#/components/schemas/AudioEnhancementsPostRequestBodyContentMultipartFormDataSchemaEnhancementEngine' description: Enhancement engine to use. Default is v2. remove_noise: type: boolean default: true description: Remove background noise. Engine v2 only. normalize: type: boolean default: true description: Normalize audio levels. Engine v2 only. studio_sound: type: boolean default: true description: Apply studio-quality enhancement. Engine v2 only. enhancement_level: type: number format: double description: Enhancement intensity (0.0 to 1.0). Engine v1 only (legacy). loudness_target_level: type: integer default: -14 description: Target loudness in LUFS. Engine v1 only (legacy). loudness_peak_limit: type: integer default: -1 description: Peak limit in dBTP. Engine v1 only (legacy). required: - audio_file /audio_enhancements/{enhancement_uuid}: get: operationId: get-audio-enhancement summary: Get audio enhancement description: Poll this endpoint to check the status of an enhancement job and retrieve the download URL when complete. tags: - subpackage_audioEnhancement parameters: - name: enhancement_uuid in: path description: The UUID returned from the create endpoint. required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Enhancement details content: application/json: schema: $ref: '#/components/schemas/Audio Enhancement_getAudioEnhancement_Response_200' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/GetAudioEnhancementRequestNotFoundError' /agents: get: operationId: list-agents summary: List agents description: Retrieve all agents for the authenticated team tags: - subpackage_agents parameters: - name: phone_number in: query description: Filter by associated phone number required: false schema: type: string - name: advanced in: query description: Include detailed configuration required: false schema: type: boolean default: false - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of agents content: application/json: schema: $ref: '#/components/schemas/Agents_listAgents_Response_200' post: operationId: create-agent summary: Create agent description: Create a new voice agent tags: - subpackage_agents parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Agent created successfully content: application/json: schema: $ref: '#/components/schemas/Agents_createAgent_Response_200' '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/Error' requestBody: content: application/json: schema: type: object properties: name: type: string voice_uuid: type: string phone_number_id: type: integer languages: type: array items: type: string dynamic_variables: type: object additionalProperties: $ref: '#/components/schemas/AgentsPostRequestBodyContentApplicationJsonSchemaDynamicVariables' asr: $ref: '#/components/schemas/AgentsPostRequestBodyContentApplicationJsonSchemaAsr' turn: $ref: '#/components/schemas/AgentsPostRequestBodyContentApplicationJsonSchemaTurn' llm: $ref: '#/components/schemas/AgentsPostRequestBodyContentApplicationJsonSchemaLlm' search_mode: $ref: '#/components/schemas/AgentsPostRequestBodyContentApplicationJsonSchemaSearchMode' description: RAG search strategy - speed (faster) or accuracy (more thorough) max_chunks_per_query: type: integer default: 8 description: Number of relevant chunks to retrieve per query for RAG webhooks: type: array items: $ref: '#/components/schemas/AgentsPostRequestBodyContentApplicationJsonSchemaWebhooksItems' system_tools: $ref: '#/components/schemas/AgentsPostRequestBodyContentApplicationJsonSchemaSystemTools' required: - name - voice_uuid /agents/{uuid}: get: operationId: get-agent summary: Get agent description: Retrieve a specific agent's details tags: - subpackage_agents parameters: - name: uuid in: path required: true schema: type: string format: uuid - name: advanced in: query required: false schema: type: boolean default: false - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Agent details content: application/json: schema: $ref: '#/components/schemas/Agents_getAgent_Response_200' delete: operationId: delete-agent summary: Delete agent description: Delete an agent and all its configurations tags: - subpackage_agents parameters: - name: uuid in: path required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Agent deleted successfully content: application/json: schema: $ref: '#/components/schemas/Agents_deleteAgent_Response_200' patch: operationId: update-agent summary: Update agent description: Update an existing agent's configuration tags: - subpackage_agents parameters: - name: uuid in: path required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Agent updated successfully content: application/json: schema: $ref: '#/components/schemas/Agents_updateAgent_Response_200' requestBody: content: application/json: schema: type: object properties: name: type: string voice_uuid: type: string phone_number_id: type: integer languages: type: array items: type: string dynamic_variables: $ref: '#/components/schemas/AgentsUuidPatchRequestBodyContentApplicationJsonSchemaDynamicVariables' asr: $ref: '#/components/schemas/AgentsUuidPatchRequestBodyContentApplicationJsonSchemaAsr' turn: $ref: '#/components/schemas/AgentsUuidPatchRequestBodyContentApplicationJsonSchemaTurn' llm: $ref: '#/components/schemas/AgentsUuidPatchRequestBodyContentApplicationJsonSchemaLlm' search_mode: $ref: '#/components/schemas/AgentsUuidPatchRequestBodyContentApplicationJsonSchemaSearchMode' description: RAG search strategy max_chunks_per_query: type: integer description: Number of chunks to retrieve per query for RAG webhooks: type: array items: description: Any type system_tools: $ref: '#/components/schemas/AgentsUuidPatchRequestBodyContentApplicationJsonSchemaSystemTools' /agents/{uuid}/dispatch: post: operationId: dispatch-agent summary: Dispatch agent description: Make an outbound call with an agent tags: - subpackage_agents parameters: - name: uuid in: path required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Call dispatched content: application/json: schema: $ref: '#/components/schemas/Agents_dispatchAgent_Response_200' requestBody: content: application/json: schema: type: object properties: phone_number: type: string description: Destination phone number dynamic_variables: $ref: '#/components/schemas/AgentsUuidDispatchPostRequestBodyContentApplicationJsonSchemaDynamicVariables' description: Runtime variable overrides required: - phone_number /agents/capabilities: get: operationId: get-agent-capabilities summary: Get capabilities description: List supported ASR and LLM providers and models tags: - subpackage_agents parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Agent capabilities content: application/json: schema: $ref: '#/components/schemas/Agents_getAgentCapabilities_Response_200' /agents/system-tools: get: operationId: get-system-tools summary: Get system tools description: List available system tools tags: - subpackage_agents parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: System tools content: application/json: schema: $ref: '#/components/schemas/Agents_getSystemTools_Response_200' /agents/{agent_uuid}/tools: get: operationId: list-agent-tools summary: List agent tools description: List all tools for an agent tags: - subpackage_agentTools parameters: - name: agent_uuid in: path required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of tools content: application/json: schema: $ref: '#/components/schemas/Agent Tools_listAgentTools_Response_200' post: operationId: create-agent-tool summary: Create agent tool description: Create a new tool for an agent tags: - subpackage_agentTools parameters: - name: agent_uuid in: path required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Tool created content: application/json: schema: $ref: '#/components/schemas/Agent Tools_createAgentTool_Response_200' requestBody: content: application/json: schema: type: object properties: name: type: string description: type: string tool_type: $ref: '#/components/schemas/AgentsAgentUuidToolsPostRequestBodyContentApplicationJsonSchemaToolType' tool_config: $ref: '#/components/schemas/AgentsAgentUuidToolsPostRequestBodyContentApplicationJsonSchemaToolConfig' required: - name - description - tool_type - tool_config /agents/{agent_uuid}/tools/{tool_uuid}: get: operationId: get-agent-tool summary: Get agent tool description: Get details of a specific tool tags: - subpackage_agentTools parameters: - name: agent_uuid in: path required: true schema: type: string format: uuid - name: tool_uuid in: path required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Tool details content: application/json: schema: $ref: '#/components/schemas/Agent Tools_getAgentTool_Response_200' delete: operationId: delete-agent-tool summary: Delete agent tool description: Delete a tool tags: - subpackage_agentTools parameters: - name: agent_uuid in: path required: true schema: type: string format: uuid - name: tool_uuid in: path required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Tool deleted content: application/json: schema: $ref: '#/components/schemas/Agent Tools_deleteAgentTool_Response_200' patch: operationId: update-agent-tool summary: Update agent tool description: Update an existing tool tags: - subpackage_agentTools parameters: - name: agent_uuid in: path required: true schema: type: string format: uuid - name: tool_uuid in: path required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Tool updated content: application/json: schema: $ref: '#/components/schemas/Agent Tools_updateAgentTool_Response_200' requestBody: content: application/json: schema: type: object properties: name: type: string description: type: string tool_config: $ref: >- #/components/schemas/AgentsAgentUuidToolsToolUuidPatchRequestBodyContentApplicationJsonSchemaToolConfig /agents/{agent_uuid}/webhooks: get: operationId: list-agent-webhooks summary: List agent webhooks description: List all webhooks for an agent tags: - subpackage_agentWebhooks parameters: - name: agent_uuid in: path required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of webhooks content: application/json: schema: $ref: '#/components/schemas/Agent Webhooks_listAgentWebhooks_Response_200' post: operationId: create-agent-webhook summary: Create agent webhook description: Create a new webhook for an agent tags: - subpackage_agentWebhooks parameters: - name: agent_uuid in: path required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Webhook created content: application/json: schema: $ref: '#/components/schemas/Agent Webhooks_createAgentWebhook_Response_200' requestBody: content: application/json: schema: type: object properties: webhook_type: $ref: '#/components/schemas/AgentsAgentUuidWebhooksPostRequestBodyContentApplicationJsonSchemaWebhookType' webhook_config: $ref: '#/components/schemas/AgentsAgentUuidWebhooksPostRequestBodyContentApplicationJsonSchemaWebhookConfig' required: - webhook_type - webhook_config /agents/{agent_uuid}/webhooks/{webhook_uuid}: get: operationId: get-agent-webhook summary: Get agent webhook description: Get details of a specific webhook tags: - subpackage_agentWebhooks parameters: - name: agent_uuid in: path required: true schema: type: string format: uuid - name: webhook_uuid in: path required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Webhook details content: application/json: schema: $ref: '#/components/schemas/Agent Webhooks_getAgentWebhook_Response_200' delete: operationId: delete-agent-webhook summary: Delete agent webhook description: Delete a webhook tags: - subpackage_agentWebhooks parameters: - name: agent_uuid in: path required: true schema: type: string format: uuid - name: webhook_uuid in: path required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Webhook deleted content: application/json: schema: $ref: '#/components/schemas/Agent Webhooks_deleteAgentWebhook_Response_200' patch: operationId: update-agent-webhook summary: Update agent webhook description: Update an existing webhook tags: - subpackage_agentWebhooks parameters: - name: agent_uuid in: path required: true schema: type: string format: uuid - name: webhook_uuid in: path required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Webhook updated content: application/json: schema: $ref: '#/components/schemas/Agent Webhooks_updateAgentWebhook_Response_200' requestBody: content: application/json: schema: type: object properties: webhook_config: $ref: >- #/components/schemas/AgentsAgentUuidWebhooksWebhookUuidPatchRequestBodyContentApplicationJsonSchemaWebhookConfig /phone_numbers: get: operationId: list-phone-numbers summary: List agent phone numbers description: List all agent phone numbers tags: - subpackage_agentPhoneNumbers parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of phone numbers content: application/json: schema: $ref: '#/components/schemas/Agent Phone Numbers_listPhoneNumbers_Response_200' post: operationId: create-phone-number summary: Create agent phone number description: Create a new agent phone number tags: - subpackage_agentPhoneNumbers parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Phone number created content: application/json: schema: $ref: '#/components/schemas/Agent Phone Numbers_createPhoneNumber_Response_200' requestBody: content: application/json: schema: type: object properties: phone_number: type: string description: E.164 formatted phone number label: type: string supports_inbound: type: boolean default: false supports_outbound: type: boolean default: false provider: $ref: '#/components/schemas/PhoneNumbersPostRequestBodyContentApplicationJsonSchemaProvider' twilio_account_sid: type: string twilio_auth_token: type: string outbound_trunk: $ref: '#/components/schemas/PhoneNumbersPostRequestBodyContentApplicationJsonSchemaOutboundTrunk' inbound_trunk: $ref: '#/components/schemas/PhoneNumbersPostRequestBodyContentApplicationJsonSchemaInboundTrunk' required: - phone_number - label /phone_numbers/{id}: get: operationId: get-phone-number summary: Get agent phone number description: Get agent phone number details tags: - subpackage_agentPhoneNumbers parameters: - name: id in: path required: true schema: type: integer - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Phone number details content: application/json: schema: $ref: '#/components/schemas/Agent Phone Numbers_getPhoneNumber_Response_200' delete: operationId: delete-phone-number summary: Delete agent phone number description: Delete an agent phone number tags: - subpackage_agentPhoneNumbers parameters: - name: id in: path required: true schema: type: integer - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Phone number deleted content: application/json: schema: $ref: '#/components/schemas/Agent Phone Numbers_deletePhoneNumber_Response_200' /phone_numbers/{id}/force: delete: operationId: force-delete-phone-number summary: Force delete agent phone number description: Force delete an agent phone number even if linked to agent tags: - subpackage_agentPhoneNumbers parameters: - name: id in: path required: true schema: type: integer - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Phone number force deleted content: application/json: schema: $ref: '#/components/schemas/Agent Phone Numbers_forceDeletePhoneNumber_Response_200' /knowledge_items: get: operationId: list-knowledge-items summary: List knowledge items description: List all knowledge items belonging to the authenticated user's team tags: - subpackage_agentKnowledgeBase parameters: - name: status in: query description: Filter by status required: false schema: $ref: '#/components/schemas/KnowledgeItemsGetParametersStatus' - name: source_type in: query description: Filter by source type required: false schema: $ref: '#/components/schemas/KnowledgeItemsGetParametersSourceType' - name: page in: query description: Page number required: false schema: type: integer default: 1 - name: per_page in: query description: Items per page required: false schema: type: integer default: 20 - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of knowledge items content: application/json: schema: $ref: '#/components/schemas/Agent Knowledge Base_listKnowledgeItems_Response_200' post: operationId: create-knowledge-item summary: Create knowledge item description: Creates a new knowledge item and queues it for ingestion processing tags: - subpackage_agentKnowledgeBase parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '201': description: Knowledge item created successfully content: application/json: schema: $ref: '#/components/schemas/Agent Knowledge Base_createKnowledgeItem_Response_201' '422': description: Validation error content: application/json: schema: $ref: '#/components/schemas/Error' requestBody: content: application/json: schema: type: object properties: title: type: string description: Title of the knowledge item description: type: string description: Description of the knowledge item source_type: $ref: '#/components/schemas/KnowledgeItemsPostRequestBodyContentApplicationJsonSchemaSourceType' description: Type of knowledge source url: type: string description: Required when source_type is url raw_text: type: string description: Required when source_type is text required: - title - description - source_type /knowledge_items/{uuid}: get: operationId: get-knowledge-item summary: Get knowledge item description: Retrieves a single knowledge item with detailed information including attached agents tags: - subpackage_agentKnowledgeBase parameters: - name: uuid in: path description: The UUID of the knowledge item required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Knowledge item details content: application/json: schema: $ref: '#/components/schemas/Agent Knowledge Base_getKnowledgeItem_Response_200' '404': description: Knowledge item not found content: application/json: schema: $ref: '#/components/schemas/Error' delete: operationId: delete-knowledge-item summary: Delete knowledge item description: Deletes a knowledge item and cleans up associated data tags: - subpackage_agentKnowledgeBase parameters: - name: uuid in: path description: The UUID of the knowledge item required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Knowledge item deleted successfully content: application/json: schema: $ref: '#/components/schemas/Agent Knowledge Base_deleteKnowledgeItem_Response_200' '404': description: Knowledge item not found content: application/json: schema: $ref: '#/components/schemas/Error' /knowledge_items/{uuid}/reingest: post: operationId: reingest-knowledge-item summary: Re-ingest knowledge item description: Re-runs the ingestion pipeline for an existing knowledge item tags: - subpackage_agentKnowledgeBase parameters: - name: uuid in: path description: The UUID of the knowledge item required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Re-ingestion queued successfully content: application/json: schema: $ref: '#/components/schemas/Agent Knowledge Base_reingestKnowledgeItem_Response_200' '422': description: Cannot reingest (already processing or rate limited) content: application/json: schema: $ref: '#/components/schemas/Error' /agents/{agent_uuid}/knowledge_items: get: operationId: list-agent-knowledge-items summary: List agent's knowledge items description: Lists all knowledge items attached to a specific agent tags: - subpackage_agentKnowledgeBase parameters: - name: agent_uuid in: path description: The UUID of the agent required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of knowledge items attached to agent content: application/json: schema: $ref: '#/components/schemas/Agent Knowledge Base_listAgentKnowledgeItems_Response_200' '404': description: Agent not found content: application/json: schema: $ref: '#/components/schemas/Error' post: operationId: attach-knowledge-item-to-agent summary: Attach knowledge item to agent description: Attaches an existing knowledge item to an agent tags: - subpackage_agentKnowledgeBase parameters: - name: agent_uuid in: path description: The UUID of the agent required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '201': description: Knowledge item attached successfully content: application/json: schema: $ref: '#/components/schemas/Agent Knowledge Base_attachKnowledgeItemToAgent_Response_201' '422': description: Validation error (not ready, already attached, etc.) content: application/json: schema: $ref: '#/components/schemas/Error' requestBody: content: application/json: schema: type: object properties: knowledge_item_uuid: type: string format: uuid description: The UUID of the knowledge item to attach required: - knowledge_item_uuid /agents/{agent_uuid}/knowledge_items/{knowledge_item_uuid}: delete: operationId: detach-knowledge-item-from-agent summary: Detach knowledge item from agent description: Removes a knowledge item from an agent tags: - subpackage_agentKnowledgeBase parameters: - name: agent_uuid in: path description: The UUID of the agent required: true schema: type: string format: uuid - name: knowledge_item_uuid in: path description: The UUID of the knowledge item to detach required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Knowledge item detached successfully content: application/json: schema: $ref: '#/components/schemas/Agent Knowledge Base_detachKnowledgeItemFromAgent_Response_200' '404': description: Agent or knowledge item not found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Knowledge item not attached to agent content: application/json: schema: $ref: '#/components/schemas/Error' /secure_uploads: post: operationId: create-secure-upload summary: Upload media securely description: | Upload a media file and receive a short-lived token that can be passed to downstream endpoints (such as `/detect` and `/intelligence`) in place of a public URL. The returned token is a JWT that expires 1 hour after issuance. Keeping uploads private avoids exposing source media on the open internet and means you do not need to host files yourself for jobs that only need the API to read them once. tags: - subpackage_secureUploads parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Upload accepted content: application/json: schema: $ref: '#/components/schemas/Secure Uploads_createSecureUpload_Response_200' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary description: The media file to upload (audio, image, or video). required: - file /detect: get: operationId: list-detections summary: List all detects description: Retrieve a paginated list of all detect objects for the authenticated user's team tags: - subpackage_deepfakeDetection parameters: - name: page in: query description: Page number (must be >= 1) required: true schema: type: integer - name: page_size in: query description: Number of items per page (10-1000) required: false schema: type: integer default: 10 - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of detects content: application/json: schema: $ref: '#/components/schemas/Deepfake Detection_listDetections_Response_200' post: operationId: create-detection summary: Create deepfake detection description: > Analyze audio, image, and video for deepfake detection. Supply media via one of three intake methods: - **Direct file upload** — `multipart/form-data` with the file attached as `file`. Files must be 150 MB or smaller and use one of the supported audio/video/image extensions. For larger files, use the secure upload flow. - **Public URL** — `application/json` with a `url` field. The API fetches the URL itself. - **Secure upload token** — `application/json` with a `media_token` field obtained from `POST /secure_uploads`. Exactly one of `file`, `url`, or `media_token` must be provided per request. tags: - subpackage_deepfakeDetection parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Detection job created content: application/json: schema: $ref: '#/components/schemas/Deepfake Detection_createDetection_Response_200' requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary description: The media file to analyze (audio, video, or image). Must be 150 MB or smaller. callback_url: type: string format: uri description: POST destination when analysis completes visualize: type: boolean description: Generate visualization artifacts frame_length: type: integer default: 2 description: Window size in seconds (audio/video) start_region: type: number format: double description: Start of segment to analyze (seconds) end_region: type: number format: double description: End of segment to analyze (seconds) max_video_secs: type: number format: double description: Cap processed duration model_types: $ref: '#/components/schemas/DetectPostRequestBodyContentMultipartFormDataSchemaModelTypes' description: Use talking_head for face-swaps intelligence: type: boolean default: false description: Run multimodal intelligence analysis on the media audio_source_tracing: type: boolean default: false description: Enable audio source tracing to identify synthetic audio origin use_reverse_search: type: boolean default: false description: >- Enable reverse image search to improve detection accuracy for image files. Only applies to image detections. use_ood_detector: type: boolean default: false description: Enable out-of-distribution detection zero_retention_mode: type: boolean default: false description: Enable Zero Retention Mode to automatically delete submitted media after detection completes. required: - file /detect/{uuid}: get: operationId: get-detection summary: Get deepfake detection result description: Get deepfake detection result by UUID tags: - subpackage_deepfakeDetection parameters: - name: uuid in: path description: The UUID of the detect object required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Detection result content: application/json: schema: $ref: '#/components/schemas/Deepfake Detection_getDetection_Response_200' '404': description: Detect not found content: application/json: schema: $ref: '#/components/schemas/Error' /detect/batch: post: operationId: create-detect-batch summary: Create a batch deepfake detection job description: | Submit up to 50 files in a single request and process them as a single logical group. Returns HTTP 202 with a batch UUID; each file is analyzed in the background and individual results are available via `GET /detect/{uuid}` for each entry in `detect_uuids`. Two intake methods: - **Multiple media files** — repeated `files[]` form fields. - **Single zip archive** — a single `file` form field whose value is a `.zip` containing the media files. Non-media entries are skipped. Provide one of `files[]` or `file=<...>.zip` per request. Synchronous mode (`Prefer: wait`) is not supported and returns 400 if sent. Constraints: - Maximum 50 files per batch. - Maximum 500 MB total upload size across all files. - Allowed file types match `POST /detect`'s direct-upload allowlist. - All-or-nothing billing: if the team's wallet cannot cover the projected cost for every file, the request is rejected with 402 and no detects are created. tags: - subpackage_deepfakeDetection parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '202': description: Batch accepted content: application/json: schema: $ref: '#/components/schemas/Deepfake Detection_createDetectBatch_Response_202' '400': description: >- Invalid batch request (missing files, both file and files[] supplied, file count or size exceeded, unsupported file type, or `Prefer: wait` header sent) content: application/json: schema: $ref: '#/components/schemas/Error' '402': description: Insufficient balance for the projected batch cost. Response `details` includes per-file estimates. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Intelligence detect limit reached (Default plan). content: application/json: schema: $ref: '#/components/schemas/Error' requestBody: content: multipart/form-data: schema: type: object properties: files[]: type: array items: type: string format: binary description: One or more media files. Repeat the `files[]` field for each file. Mutually exclusive with `file`. file: type: string format: binary description: A single `.zip` archive containing media files. Mutually exclusive with `files[]`. callback_url: type: string format: uri description: POST destination invoked when the batch reaches a terminal state. intelligence: type: boolean default: false description: Run multimodal intelligence on every file in the batch. search_identity: type: boolean default: false description: Run identity search against the team's saved identities (audio/video only). visualize: type: boolean default: true description: Generate visualization artifacts. audio_source_tracing_enabled: type: boolean default: false description: Enable audio source tracing on each audio file. frame_length: type: integer description: Window size in seconds (audio/video). start_region: type: number format: double description: Start of segment to analyze (seconds). end_region: type: number format: double description: End of segment to analyze (seconds). max_video_secs: type: number format: double description: Cap processed video duration. use_llm: type: boolean description: Use LLM-assisted video analysis. zero_retention_mode: type: boolean default: false description: Enable Zero Retention Mode for every file in the batch. /detect/batch/{uuid}: get: operationId: get-detect-batch summary: Get batch status description: | Retrieve the latest aggregate status for a batch. The response shape mirrors the create response — `status`, `completed_count`, and `failed_count` update as child detects progress. Use the `detect_uuids` array to fetch per-file results via `GET /detect/{uuid}`. tags: - subpackage_deepfakeDetection parameters: - name: uuid in: path description: Batch UUID returned by `POST /detect/batch`. required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Batch status content: application/json: schema: $ref: '#/components/schemas/Deepfake Detection_getDetectBatch_Response_200' '404': description: Batch not found (or not accessible by the authenticated team). content: application/json: schema: $ref: '#/components/schemas/Error' /intelligence: post: operationId: run-intelligence summary: Run intelligence description: Analyze audio, image, or video for comprehensive insights. Optionally reference an existing detect to associate. tags: - subpackage_intelligence parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Intelligence analysis content: application/json: schema: $ref: '#/components/schemas/Intelligence_runIntelligence_Response_200' requestBody: content: application/json: schema: type: object properties: media_token: type: string description: Token for uploaded media file (from secure upload) url: type: string format: uri description: HTTPS URL to audio, image, or video file detect_id: type: string format: uuid description: UUID of an existing detect to associate media_type: $ref: '#/components/schemas/IntelligencePostRequestBodyContentApplicationJsonSchemaMediaType' description: Explicit media type (auto-detected if not provided) callback_url: type: string format: uri description: >- URL that receives the final intelligence payload via HTTP POST. When present, the request runs asynchronously and returns 202 Accepted. /intelligences: get: operationId: list-intelligences summary: List intelligences description: Retrieve a paginated list of all intelligence reports for the authenticated user's team tags: - subpackage_intelligence parameters: - name: page in: query description: Page number (must be >= 1) required: true schema: type: integer - name: page_size in: query description: Number of items per page (10-1000) required: false schema: type: integer default: 10 - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of intelligence reports content: application/json: schema: $ref: '#/components/schemas/Intelligence_listIntelligences_Response_200' /intelligences/{uuid}: get: operationId: get-intelligence summary: Get intelligence description: Retrieve a single intelligence report by its UUID tags: - subpackage_intelligence parameters: - name: uuid in: path description: The UUID of the intelligence report required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Intelligence report content: application/json: schema: $ref: '#/components/schemas/Intelligence_getIntelligence_Response_200' '404': description: Intelligence not found content: application/json: schema: $ref: '#/components/schemas/Error' /detects/{uuid}/intelligence: post: operationId: ask-detect-intelligence-question summary: Ask a question about a detection description: >- Submit a natural-language question about a completed detection report. Returns 202 Accepted while the answer is generated in the background. tags: - subpackage_detectIntelligence parameters: - name: uuid in: path description: UUID of the completed detection report required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '202': description: Question accepted content: application/json: schema: $ref: '#/components/schemas/Detect Intelligence_askDetectIntelligenceQuestion_Response_202' '400': description: Bad request (missing query) content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Detection not found content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Detection not completed content: application/json: schema: $ref: '#/components/schemas/Error' requestBody: content: application/json: schema: type: object properties: query: type: string description: The natural-language question to ask about the detection required: - query /detects/{uuid}/intelligence/{question_uuid}: get: operationId: get-detect-intelligence-question summary: Get answer to a detection question description: Retrieve the status and answer for a previously submitted question. Poll until status is completed or failed. tags: - subpackage_detectIntelligence parameters: - name: uuid in: path description: UUID of the detection report required: true schema: type: string - name: question_uuid in: path description: UUID of the question required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Question status and answer content: application/json: schema: $ref: '#/components/schemas/Detect Intelligence_getDetectIntelligenceQuestion_Response_200' '404': description: Question not found content: application/json: schema: $ref: '#/components/schemas/Error' /audio_source_tracings: get: operationId: list-audio-source-tracings summary: List audio source tracings description: Retrieve a paginated list of all source tracing reports for the authenticated user's team tags: - subpackage_audioSourceTracing parameters: - name: page in: query description: Page number (must be >= 1) required: true schema: type: integer - name: page_size in: query description: Number of items per page (10-1000) required: false schema: type: integer default: 10 - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of source tracing reports content: application/json: schema: $ref: '#/components/schemas/Audio Source Tracing_listAudioSourceTracings_Response_200' /audio_source_tracings/{uuid}: get: operationId: get-audio-source-tracing summary: Get audio source tracing description: Retrieve a single source tracing report by its UUID tags: - subpackage_audioSourceTracing parameters: - name: uuid in: path description: The UUID of the source tracing report required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Source tracing report content: application/json: schema: $ref: '#/components/schemas/Audio Source Tracing_getAudioSourceTracing_Response_200' '404': description: Source tracing report not found content: application/json: schema: $ref: '#/components/schemas/Error' /identity: get: operationId: list-identities summary: List identities description: List all speaker identities tags: - subpackage_identity parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of identities content: application/json: schema: $ref: '#/components/schemas/Identity_listIdentities_Response_200' post: operationId: create-identity summary: Create identity description: Create a new speaker identity tags: - subpackage_identity parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Identity created content: application/json: schema: $ref: '#/components/schemas/Identity_createIdentity_Response_200' requestBody: content: application/json: schema: type: object properties: audio_url: type: string format: uri name: type: string required: - audio_url /identity/search: post: operationId: search-identities summary: Search identities description: Search for matching speaker identities tags: - subpackage_identity parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Search results content: application/json: schema: $ref: '#/components/schemas/Identity_searchIdentities_Response_200' requestBody: content: application/json: schema: type: object properties: audio_url: type: string format: uri required: - audio_url /watermark/apply: post: operationId: apply-watermark summary: Apply watermark description: >- Apply a watermark to an audio, image, or video file. The media type is automatically detected from the file content. Use the `Prefer: wait` header for synchronous processing. tags: - subpackage_watermark parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string - name: Prefer in: header description: When set to "wait", the API processes synchronously and returns the completed result. required: false schema: $ref: '#/components/schemas/WatermarkApplyPostParametersPrefer' responses: '200': description: Watermark job created content: application/json: schema: $ref: '#/components/schemas/Watermark_applyWatermark_Response_200' requestBody: content: application/json: schema: type: object properties: url: type: string format: uri description: HTTPS URL to the media file (audio, image, or video). strength: type: number format: double default: 0.2 description: Watermark strength for image/video. Ignored for audio. custom_message: type: string default: resembleai description: Custom message to embed for image/video. Ignored for audio. required: - url /watermark/apply/{uuid}/result: get: operationId: get-watermark-apply-result summary: Get watermark apply result description: Retrieve the result of a watermark apply job. tags: - subpackage_watermark parameters: - name: uuid in: path required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Apply result content: application/json: schema: $ref: '#/components/schemas/Watermark_getWatermarkApplyResult_Response_200' /watermark/detect: post: operationId: detect-watermark summary: Detect watermark description: >- Detect a watermark in an audio, image, or video file. The media type is automatically detected from the file content. Use the `Prefer: wait` header for synchronous processing. tags: - subpackage_watermark parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string - name: Prefer in: header description: When set to "wait", the API processes synchronously and returns the completed result with metrics. required: false schema: $ref: '#/components/schemas/WatermarkDetectPostParametersPrefer' responses: '200': description: Detection job created content: application/json: schema: $ref: '#/components/schemas/Watermark_detectWatermark_Response_200' requestBody: content: application/json: schema: type: object properties: url: type: string format: uri description: HTTPS URL to the media file (audio, image, or video). custom_message: type: string default: resembleai description: Custom message used during encoding for image/video. Ignored for audio. required: - url /watermark/detect/{uuid}/result: get: operationId: get-watermark-detection-result summary: Get watermark detection result description: Retrieve the result of a watermark detection. tags: - subpackage_watermark parameters: - name: uuid in: path required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Detection result content: application/json: schema: $ref: '#/components/schemas/Watermark_getWatermarkDetectionResult_Response_200' /voices: get: operationId: list-voices summary: List voices description: Retrieve voice metadata tags: - subpackage_voices parameters: - name: page in: query required: true schema: type: integer default: 1 - name: page_size in: query required: false schema: type: integer default: 10 - name: advanced in: query required: false schema: type: boolean default: false - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of voices content: application/json: schema: $ref: '#/components/schemas/Voices_listVoices_Response_200' post: operationId: create-voice summary: Create voice description: Create a new voice tags: - subpackage_voices parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Voice created content: application/json: schema: $ref: '#/components/schemas/Voices_createVoice_Response_200' requestBody: content: application/json: schema: type: object properties: name: type: string voice_type: $ref: '#/components/schemas/VoicesPostRequestBodyContentApplicationJsonSchemaVoiceType' dataset_url: type: string format: uri callback_uri: type: string format: uri language: type: string default: en-US required: - name /voices/{voice_uuid}: get: operationId: get-voice summary: Get voice description: Get voice details tags: - subpackage_voices parameters: - name: voice_uuid in: path required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Voice details content: application/json: schema: $ref: '#/components/schemas/Voices_getVoice_Response_200' delete: operationId: delete-voice summary: Delete voice description: Delete a voice tags: - subpackage_voices parameters: - name: voice_uuid in: path required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Voice deleted content: application/json: schema: $ref: '#/components/schemas/Voices_deleteVoice_Response_200' /voices/{voice_uuid}/build: post: operationId: build-voice summary: Build voice description: Start voice training tags: - subpackage_voices parameters: - name: voice_uuid in: path required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Build started content: application/json: schema: $ref: '#/components/schemas/Voices_buildVoice_Response_200' requestBody: content: application/json: schema: type: object properties: fill: type: boolean default: false /voice-design: post: operationId: generate-voice-design summary: Generate voice candidates description: Generate three voice candidates from a text prompt tags: - subpackage_voiceDesign parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Voice candidates generated content: application/json: schema: $ref: '#/components/schemas/Voice Design_generateVoiceDesign_Response_200' requestBody: content: multipart/form-data: schema: type: object properties: user_prompt: type: string description: Description of desired voice required: - user_prompt /voice-design/create: post: operationId: create-voice-from-candidate summary: Create voice from candidate description: Create a voice from a voice design candidate tags: - subpackage_voiceDesign parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Voice created content: application/json: schema: $ref: '#/components/schemas/Voice Design_createVoiceFromCandidate_Response_200' requestBody: content: application/json: schema: type: object properties: uuid: type: string voice_sample_index: type: integer name: type: string required: - uuid - voice_sample_index - name /voices/{voice_uuid}/recordings: get: operationId: list-recordings summary: List recordings description: List all recordings for a voice tags: - subpackage_recordings parameters: - name: voice_uuid in: path required: true schema: type: string - name: page in: query required: true schema: type: integer default: 1 - name: page_size in: query required: false schema: type: integer default: 10 - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of recordings content: application/json: schema: $ref: '#/components/schemas/Recordings_listRecordings_Response_200' post: operationId: create-recording summary: Create recording description: Upload a new recording for voice training tags: - subpackage_recordings parameters: - name: voice_uuid in: path required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Recording created content: application/json: schema: $ref: '#/components/schemas/Recordings_createRecording_Response_200' requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary description: Audio file (WAV recommended, 1-12 seconds) name: type: string description: Display name text: type: string description: Transcript of the clip emotion: type: string description: Emotion label is_active: type: boolean description: Include in training fill: type: boolean description: Include for Resemble Fill required: - file - name - text - emotion - is_active /voices/{voice_uuid}/recordings/{recording_id}: get: operationId: get-recording summary: Get recording description: Get recording details tags: - subpackage_recordings parameters: - name: voice_uuid in: path required: true schema: type: string - name: recording_id in: path required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Recording details content: application/json: schema: $ref: '#/components/schemas/Recordings_getRecording_Response_200' delete: operationId: delete-recording summary: Delete recording description: Delete a recording tags: - subpackage_recordings parameters: - name: voice_uuid in: path required: true schema: type: string - name: recording_id in: path required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Recording deleted content: application/json: schema: $ref: '#/components/schemas/Recordings_deleteRecording_Response_200' patch: operationId: update-recording summary: Update recording description: Update a recording tags: - subpackage_recordings parameters: - name: voice_uuid in: path required: true schema: type: string - name: recording_id in: path required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Recording updated content: application/json: schema: $ref: '#/components/schemas/Recordings_updateRecording_Response_200' requestBody: content: application/json: schema: type: object properties: name: type: string text: type: string emotion: type: string is_active: type: boolean /term_substitutions: get: operationId: list-term-substitutions summary: List term substitutions description: List all term substitutions tags: - subpackage_termSubstitutions parameters: - name: page in: query required: true schema: type: integer default: 1 - name: page_size in: query required: false schema: type: integer default: 10 - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of term substitutions content: application/json: schema: $ref: '#/components/schemas/Term Substitutions_listTermSubstitutions_Response_200' post: operationId: create-term-substitution summary: Create term substitution description: Create a new pronunciation substitution tags: - subpackage_termSubstitutions parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Term substitution created content: application/json: schema: $ref: '#/components/schemas/Term Substitutions_createTermSubstitution_Response_200' requestBody: content: application/json: schema: type: object properties: original_text: type: string description: Original text to substitute replacement_text: type: string description: Replacement pronunciation required: - original_text - replacement_text /term_substitutions/{id}: get: operationId: get-term-substitution summary: Get term substitution description: Get term substitution details tags: - subpackage_termSubstitutions parameters: - name: id in: path required: true schema: type: integer - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Term substitution details content: application/json: schema: $ref: '#/components/schemas/Term Substitutions_getTermSubstitution_Response_200' delete: operationId: delete-term-substitution summary: Delete term substitution description: Delete a term substitution tags: - subpackage_termSubstitutions parameters: - name: id in: path required: true schema: type: integer - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Term substitution deleted content: application/json: schema: $ref: '#/components/schemas/Term Substitutions_deleteTermSubstitution_Response_200' /pronunciations: get: operationId: list-pronunciations summary: List custom pronunciations description: Retrieve all custom pronunciations for your team, with optional filters. tags: - subpackage_customPronunciations parameters: - name: language in: query description: Filter by language (e.g., en-us) required: false schema: type: string - name: domain in: query description: Filter by domain (e.g., medical) required: false schema: type: string - name: status in: query description: Filter by processing status required: false schema: $ref: '#/components/schemas/PronunciationsGetParametersStatus' - name: active in: query description: Filter by active state required: false schema: type: boolean - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of custom pronunciations content: application/json: schema: $ref: '#/components/schemas/Custom Pronunciations_listPronunciations_Response_200' post: operationId: create-pronunciation summary: Create custom pronunciation description: Upload a single pronunciation with a reference audio file. tags: - subpackage_customPronunciations parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '201': description: Pronunciation created content: application/json: schema: $ref: '#/components/schemas/Custom Pronunciations_createPronunciation_Response_201' '422': description: Validation error (e.g., duplicate word) content: application/json: schema: $ref: '#/components/schemas/Error' requestBody: content: multipart/form-data: schema: type: object properties: word: type: string description: >- The word or phrase (2-100 characters). Letters, accented characters, apostrophes, hyphens, and spaces only. audio: type: string format: binary description: Reference audio file (wav, flac, mp3, m4a, ogg, webm, aac). Duration 200ms-10s. Max 10MB. required: - word - audio /pronunciations/bulk: post: operationId: bulk-create-pronunciations summary: Bulk create pronunciations from ZIP description: >- Upload multiple pronunciations at once. Each audio file in the ZIP becomes a pronunciation — the filename (without extension) is used as the word. tags: - subpackage_customPronunciations parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '201': description: Bulk creation result content: application/json: schema: $ref: '#/components/schemas/Custom Pronunciations_bulkCreatePronunciations_Response_201' requestBody: content: multipart/form-data: schema: type: object properties: zip: type: string format: binary description: ZIP file containing audio files. Max 50 files, max 100MB total. required: - zip /pronunciations/{uuid}: get: operationId: get-pronunciation summary: Get custom pronunciation description: Retrieve a single custom pronunciation by UUID tags: - subpackage_customPronunciations parameters: - name: uuid in: path required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Pronunciation details content: application/json: schema: $ref: '#/components/schemas/Custom Pronunciations_getPronunciation_Response_200' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/Error' delete: operationId: delete-pronunciation summary: Delete custom pronunciation description: Permanently remove a custom pronunciation. Takes effect immediately. tags: - subpackage_customPronunciations parameters: - name: uuid in: path required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Pronunciation deleted content: application/json: schema: $ref: '#/components/schemas/Custom Pronunciations_deletePronunciation_Response_200' patch: operationId: update-pronunciation summary: Toggle pronunciation active status description: Enable or disable a pronunciation without deleting it. Inactive pronunciations are not used during synthesis. tags: - subpackage_customPronunciations parameters: - name: uuid in: path required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Pronunciation updated content: application/json: schema: $ref: '#/components/schemas/Custom Pronunciations_updatePronunciation_Response_200' requestBody: content: application/json: schema: type: object properties: active: type: boolean description: Set to false to disable, true to re-enable required: - active /voice_settings_presets: get: operationId: list-voice-settings-presets summary: List voice settings presets description: List all voice settings presets tags: - subpackage_voiceSettingsPresets parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of presets content: application/json: schema: $ref: '#/components/schemas/Voice Settings Presets_listVoiceSettingsPresets_Response_200' post: operationId: create-voice-settings-preset summary: Create voice settings preset description: Create a new voice settings preset (max 5 per user) tags: - subpackage_voiceSettingsPresets parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '201': description: Preset created content: application/json: schema: $ref: '#/components/schemas/Voice Settings Presets_createVoiceSettingsPreset_Response_201' requestBody: content: application/json: schema: type: object properties: name: type: string description: Preset name (unique, max 30 characters) pace: type: number format: double default: 1 description: Speech pace/speed temperature: type: number format: double default: 0.8 description: Voice variation pitch: type: number format: double default: 0 description: Voice pitch adjustment useHd: type: boolean default: false description: Use HD quality exaggeration: type: number format: double default: 0.5 description: Emotional exaggeration description: type: string default: '' description: Voice style prompt required: - name /voice_settings_presets/{uuid}: get: operationId: get-voice-settings-preset summary: Get voice settings preset description: Get preset details tags: - subpackage_voiceSettingsPresets parameters: - name: uuid in: path required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Preset details content: application/json: schema: $ref: '#/components/schemas/Voice Settings Presets_getVoiceSettingsPreset_Response_200' delete: operationId: delete-voice-settings-preset summary: Delete voice settings preset description: Delete a preset tags: - subpackage_voiceSettingsPresets parameters: - name: uuid in: path required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Preset deleted content: application/json: schema: $ref: '#/components/schemas/Voice Settings Presets_deleteVoiceSettingsPreset_Response_200' patch: operationId: update-voice-settings-preset summary: Update voice settings preset description: Update a preset tags: - subpackage_voiceSettingsPresets parameters: - name: uuid in: path required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Preset updated content: application/json: schema: $ref: '#/components/schemas/Voice Settings Presets_updateVoiceSettingsPreset_Response_200' requestBody: content: application/json: schema: type: object properties: name: type: string pace: type: number format: double temperature: type: number format: double pitch: type: number format: double useHd: type: boolean exaggeration: type: number format: double description: type: string /projects: get: operationId: list-projects summary: List projects description: List all projects tags: - subpackage_projects parameters: - name: page in: query required: true schema: type: integer default: 1 - name: page_size in: query required: false schema: type: integer default: 10 - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of projects content: application/json: schema: $ref: '#/components/schemas/Projects_listProjects_Response_200' post: operationId: create-project summary: Create project description: Create a new project tags: - subpackage_projects parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Project created content: application/json: schema: $ref: '#/components/schemas/Projects_createProject_Response_200' requestBody: content: application/json: schema: type: object properties: name: type: string description: type: string is_collaborative: type: boolean is_archived: type: boolean required: - name - description - is_collaborative - is_archived /projects/{project_uuid}: get: operationId: get-project summary: Get project description: Get project details tags: - subpackage_projects parameters: - name: project_uuid in: path required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Project details content: application/json: schema: $ref: '#/components/schemas/Projects_getProject_Response_200' put: operationId: update-project summary: Update project description: Update a project tags: - subpackage_projects parameters: - name: project_uuid in: path required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Project updated content: application/json: schema: $ref: '#/components/schemas/Projects_updateProject_Response_200' requestBody: content: application/json: schema: type: object properties: name: type: string description: type: string is_collaborative: type: boolean is_archived: type: boolean delete: operationId: delete-project summary: Delete project description: Delete a project tags: - subpackage_projects parameters: - name: project_uuid in: path required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Project deleted content: application/json: schema: $ref: '#/components/schemas/Projects_deleteProject_Response_200' /projects/{project_uuid}/clips: get: operationId: list-clips summary: List clips description: List clips in a project tags: - subpackage_clips parameters: - name: project_uuid in: path required: true schema: type: string - name: page in: query required: true schema: type: integer default: 1 - name: page_size in: query required: false schema: type: integer default: 10 - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of clips content: application/json: schema: $ref: '#/components/schemas/Clips_listClips_Response_200' /projects/{project_uuid}/clips/{clip_uuid}: get: operationId: get-clip summary: Get clip description: Get clip details tags: - subpackage_clips parameters: - name: project_uuid in: path required: true schema: type: string - name: clip_uuid in: path required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Clip details content: application/json: schema: $ref: '#/components/schemas/Clips_getClip_Response_200' delete: operationId: delete-clip summary: Delete clip description: Delete a clip tags: - subpackage_clips parameters: - name: project_uuid in: path required: true schema: type: string - name: clip_uuid in: path required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Clip deleted content: application/json: schema: $ref: '#/components/schemas/Clips_deleteClip_Response_200' patch: operationId: update-clip summary: Update clip description: Update a clip tags: - subpackage_clips parameters: - name: project_uuid in: path required: true schema: type: string - name: clip_uuid in: path required: true schema: type: string - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Clip updated content: application/json: schema: $ref: '#/components/schemas/Clips_updateClip_Response_200' requestBody: content: application/json: schema: type: object properties: title: type: string body: type: string is_archived: type: boolean /account: get: operationId: get-account summary: Get account description: Get account information tags: - subpackage_account parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Account details content: application/json: schema: $ref: '#/components/schemas/Account_getAccount_Response_200' /account/teams: get: operationId: get-teams summary: Get teams description: Get team information tags: - subpackage_account parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Team information content: application/json: schema: $ref: '#/components/schemas/Account_getTeams_Response_200' /account/teams/{team_uuid}: get: operationId: get-team summary: Get team description: Get specific team information tags: - subpackage_account parameters: - name: team_uuid in: path required: true schema: type: string format: uuid - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Team information content: application/json: schema: $ref: '#/components/schemas/Account_getTeam_Response_200' /account/billing_usage: get: operationId: get-billing-usage summary: Get billing usage description: Get billing and usage information tags: - subpackage_account parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Billing information content: application/json: schema: $ref: '#/components/schemas/Account_getBillingUsage_Response_200' /duet_voices: get: operationId: list-duet-voices summary: List duet voices description: Returns default and custom duet voices tags: - subpackage_duets parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of duet voices content: application/json: schema: $ref: '#/components/schemas/Duets_listDuetVoices_Response_200' post: operationId: create-duet-voice summary: Create custom duet voice description: Create a custom voice for duet generation tags: - subpackage_duets parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Duet voice created content: application/json: schema: $ref: '#/components/schemas/Duets_createDuetVoice_Response_200' requestBody: content: multipart/form-data: schema: type: object properties: name: type: string description: Voice name style_prompt: type: string description: Optional style prompt audio: type: string format: binary description: Audio file (MP3/WAV/M4A/OGG/AAC/FLAC max 10 MB) required: - name - audio /duet_voices/{id}: put: operationId: update-duet-voice summary: Update duet voice description: Update a custom duet voice (default voices cannot be modified) tags: - subpackage_duets parameters: - name: id in: path required: true schema: type: integer - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Duet voice updated content: application/json: schema: $ref: '#/components/schemas/Duets_updateDuetVoice_Response_200' requestBody: content: application/json: schema: type: object properties: name: type: string style_prompt: type: string delete: operationId: delete-duet-voice summary: Delete duet voice description: Delete a custom duet voice (default voices cannot be deleted) tags: - subpackage_duets parameters: - name: id in: path required: true schema: type: integer - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Duet voice deleted content: application/json: schema: $ref: '#/components/schemas/Duets_deleteDuetVoice_Response_200' /duet_voice_pairs: get: operationId: list-duet-voice-pairs summary: List duet voice pairs description: List all voice pairs for duet generation tags: - subpackage_duets parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: List of voice pairs content: application/json: schema: $ref: '#/components/schemas/Duets_listDuetVoicePairs_Response_200' post: operationId: create-duet-voice-pair summary: Create duet voice pair description: Create a voice pair for duet generation tags: - subpackage_duets parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Voice pair created content: application/json: schema: $ref: '#/components/schemas/Duets_createDuetVoicePair_Response_200' requestBody: content: application/json: schema: type: object properties: voice_1_id: type: integer description: ID of first voice voice_2_id: type: integer description: ID of second voice name: type: string description: Optional pair name required: - voice_1_id - voice_2_id /duet: post: operationId: generate-duet summary: Generate duet description: Generate conversational audio with two speakers tags: - subpackage_duets parameters: - name: Authorization in: header description: API token from https://app.resemble.ai/account/api required: true schema: type: string responses: '200': description: Duet generation job created content: application/json: schema: $ref: '#/components/schemas/Duets_generateDuet_Response_200' requestBody: content: application/json: schema: type: object properties: voice_pair_id: type: integer description: Voice pair ID to use script: type: array items: $ref: '#/components/schemas/DuetPostRequestBodyContentApplicationJsonSchemaScriptItems' title: type: string description: Optional title for the duet callback_uri: type: string format: uri description: Webhook URL for completion notification required: - voice_pair_id - script servers: - url: https://f.cluster.resemble.ai - url: https://app.resemble.ai/api/v2 components: schemas: SynthesizePostRequestBodyContentApplicationJsonSchemaPrecision: type: string enum: - MULAW - PCM_16 - PCM_24 - PCM_32 default: PCM_32 description: Audio precision for WAV output title: SynthesizePostRequestBodyContentApplicationJsonSchemaPrecision SynthesizePostRequestBodyContentApplicationJsonSchemaOutputFormat: type: string enum: - wav - mp3 default: wav description: Audio output format title: SynthesizePostRequestBodyContentApplicationJsonSchemaOutputFormat SynthesizePostRequestBodyContentApplicationJsonSchemaSampleRate: type: string enum: - '8000' - '16000' - '22050' - '32000' - '44100' - '48000' description: Audio sample rate in Hz title: SynthesizePostRequestBodyContentApplicationJsonSchemaSampleRate AudioTimestamps: type: object properties: graph_chars: type: array items: type: string description: Grapheme characters graph_times: type: array items: type: array items: type: number format: double description: Grapheme timestamps [start, end] in seconds phon_chars: type: array items: type: string description: Phoneme characters phon_times: type: array items: type: array items: type: number format: double description: Phoneme timestamps [start, end] in seconds title: AudioTimestamps Text-to-Speech_synthesize_Response_200: type: object properties: success: type: boolean audio_content: type: string format: byte description: Base64-encoded audio bytes audio_timestamps: $ref: '#/components/schemas/AudioTimestamps' duration: type: number format: double description: Audio duration in seconds synth_duration: type: number format: double description: Raw synthesis time output_format: type: string sample_rate: type: integer title: type: string issues: type: array items: type: string title: Text-to-Speech_synthesize_Response_200 Error: type: object properties: success: type: boolean error: type: string errors: type: object additionalProperties: type: array items: type: string message: type: string title: Error StreamPostRequestBodyContentApplicationJsonSchemaPrecision: type: string enum: - MULAW - PCM_16 - PCM_24 - PCM_32 default: PCM_32 description: Audio precision title: StreamPostRequestBodyContentApplicationJsonSchemaPrecision StreamPostRequestBodyContentApplicationJsonSchemaSampleRate: type: string enum: - '8000' - '16000' - '22050' - '32000' - '44100' - '48000' description: Audio sample rate in Hz title: StreamPostRequestBodyContentApplicationJsonSchemaSampleRate SpeechToTextGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: uuid: type: string format: uuid status: type: string duration_seconds: type: number format: double created_at: type: string format: date-time updated_at: type: string format: date-time title: SpeechToTextGetResponsesContentApplicationJsonSchemaItemsItems SpeechToTextGetResponsesContentApplicationJsonSchemaMeta: type: object properties: page: type: integer per_page: type: integer total_pages: type: integer total_items: type: integer title: SpeechToTextGetResponsesContentApplicationJsonSchemaMeta Speech-to-Text_listTranscripts_Response_200: type: object properties: success: type: boolean items: type: array items: $ref: '#/components/schemas/SpeechToTextGetResponsesContentApplicationJsonSchemaItemsItems' meta: $ref: '#/components/schemas/SpeechToTextGetResponsesContentApplicationJsonSchemaMeta' title: Speech-to-Text_listTranscripts_Response_200 SpeechToTextPostResponsesContentApplicationJsonSchemaItemStatus: type: string enum: - pending - processing - completed - failed title: SpeechToTextPostResponsesContentApplicationJsonSchemaItemStatus SpeechToTextPostResponsesContentApplicationJsonSchemaItem: type: object properties: uuid: type: string format: uuid status: $ref: '#/components/schemas/SpeechToTextPostResponsesContentApplicationJsonSchemaItemStatus' created_at: type: string format: date-time updated_at: type: string format: date-time title: SpeechToTextPostResponsesContentApplicationJsonSchemaItem Speech-to-Text_createTranscript_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/SpeechToTextPostResponsesContentApplicationJsonSchemaItem' title: Speech-to-Text_createTranscript_Response_200 SpeechToTextUuidGetResponsesContentApplicationJsonSchemaItemStatus: type: string enum: - pending - processing - completed - failed title: SpeechToTextUuidGetResponsesContentApplicationJsonSchemaItemStatus SpeechToTextUuidGetResponsesContentApplicationJsonSchemaItemWordsItems: type: object properties: text: type: string start_time: type: number format: double end_time: type: number format: double speaker_id: type: string title: SpeechToTextUuidGetResponsesContentApplicationJsonSchemaItemWordsItems SpeechToTextUuidGetResponsesContentApplicationJsonSchemaItem: type: object properties: uuid: type: string format: uuid status: $ref: '#/components/schemas/SpeechToTextUuidGetResponsesContentApplicationJsonSchemaItemStatus' text: type: string words: type: array items: $ref: '#/components/schemas/SpeechToTextUuidGetResponsesContentApplicationJsonSchemaItemWordsItems' duration_seconds: type: number format: double file_url: type: string format: uri query: type: string answer: type: string created_at: type: string format: date-time updated_at: type: string format: date-time title: SpeechToTextUuidGetResponsesContentApplicationJsonSchemaItem Speech-to-Text_getTranscript_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/SpeechToTextUuidGetResponsesContentApplicationJsonSchemaItem' title: Speech-to-Text_getTranscript_Response_200 SpeechToTextUuidAskPostResponsesContentApplicationJsonSchemaItem: type: object properties: uuid: type: string format: uuid transcript_uuid: type: string format: uuid query: type: string status: type: string created_at: type: string format: date-time title: SpeechToTextUuidAskPostResponsesContentApplicationJsonSchemaItem Speech-to-Text_askTranscriptQuestion_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/SpeechToTextUuidAskPostResponsesContentApplicationJsonSchemaItem' title: Speech-to-Text_askTranscriptQuestion_Response_200 SpeechToTextUuidQuestionsGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: uuid: type: string format: uuid query: type: string answer: type: string status: type: string created_at: type: string format: date-time title: SpeechToTextUuidQuestionsGetResponsesContentApplicationJsonSchemaItemsItems SpeechToTextUuidQuestionsGetResponsesContentApplicationJsonSchemaMeta: type: object properties: {} title: SpeechToTextUuidQuestionsGetResponsesContentApplicationJsonSchemaMeta Speech-to-Text_listTranscriptQuestions_Response_200: type: object properties: success: type: boolean items: type: array items: $ref: '#/components/schemas/SpeechToTextUuidQuestionsGetResponsesContentApplicationJsonSchemaItemsItems' meta: $ref: '#/components/schemas/SpeechToTextUuidQuestionsGetResponsesContentApplicationJsonSchemaMeta' title: Speech-to-Text_listTranscriptQuestions_Response_200 SpeechToTextUuidQuestionsQuestionUuidGetResponsesContentApplicationJsonSchemaItem: type: object properties: uuid: type: string format: uuid transcript_uuid: type: string format: uuid query: type: string answer: type: string status: type: string created_at: type: string format: date-time updated_at: type: string format: date-time title: SpeechToTextUuidQuestionsQuestionUuidGetResponsesContentApplicationJsonSchemaItem Speech-to-Text_getTranscriptQuestion_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/SpeechToTextUuidQuestionsQuestionUuidGetResponsesContentApplicationJsonSchemaItem' title: Speech-to-Text_getTranscriptQuestion_Response_200 EditGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: {} title: EditGetResponsesContentApplicationJsonSchemaItemsItems Audio Edit_listAudioEdits_Response_200: type: object properties: success: type: boolean page: type: integer num_pages: type: integer page_size: type: integer items: type: array items: $ref: '#/components/schemas/EditGetResponsesContentApplicationJsonSchemaItemsItems' title: Audio Edit_listAudioEdits_Response_200 EditPostResponsesContentApplicationJsonSchemaItem: type: object properties: uuid: type: string voice_uuid: type: string original_transcript: type: string target_transcript: type: string input_audio_url: type: string format: uri title: EditPostResponsesContentApplicationJsonSchemaItem Audio Edit_createAudioEdit_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/EditPostResponsesContentApplicationJsonSchemaItem' title: Audio Edit_createAudioEdit_Response_200 EditAudioEditUuidGetResponsesContentApplicationJsonSchemaItem: type: object properties: uuid: type: string voice_uuid: type: string original_transcript: type: string target_transcript: type: string input_audio_url: type: string format: uri result_audio_url: type: string format: uri title: EditAudioEditUuidGetResponsesContentApplicationJsonSchemaItem Audio Edit_getAudioEdit_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/EditAudioEditUuidGetResponsesContentApplicationJsonSchemaItem' title: Audio Edit_getAudioEdit_Response_200 AudioEnhancementsGetResponsesContentApplicationJsonSchemaItemsItemsStatus: type: string enum: - pending - processing - completed - failed title: AudioEnhancementsGetResponsesContentApplicationJsonSchemaItemsItemsStatus AudioEnhancementsGetResponsesContentApplicationJsonSchemaItemsItemsEnhancementEngine: type: string enum: - v1 - v2 title: AudioEnhancementsGetResponsesContentApplicationJsonSchemaItemsItemsEnhancementEngine AudioEnhancementsGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: uuid: type: string status: $ref: '#/components/schemas/AudioEnhancementsGetResponsesContentApplicationJsonSchemaItemsItemsStatus' enhancement_engine: $ref: '#/components/schemas/AudioEnhancementsGetResponsesContentApplicationJsonSchemaItemsItemsEnhancementEngine' error_message: type: - string - 'null' remove_noise: type: boolean description: Engine v2 only. normalize: type: boolean description: Engine v2 only. studio_sound: type: boolean description: Engine v2 only. loudness_target_level: type: integer description: Engine v1 only. loudness_peak_limit: type: integer description: Engine v1 only. enhancement_level: type: number format: double description: Engine v1 only. original_audio_url: type: string format: uri enhanced_audio_url: type: string format: uri title: AudioEnhancementsGetResponsesContentApplicationJsonSchemaItemsItems Audio Enhancement_listAudioEnhancements_Response_200: type: object properties: success: type: boolean page: type: integer num_pages: type: integer page_size: type: integer total_count: type: integer items: type: array items: $ref: '#/components/schemas/AudioEnhancementsGetResponsesContentApplicationJsonSchemaItemsItems' title: Audio Enhancement_listAudioEnhancements_Response_200 ListAudioEnhancementsRequestBadRequestError: type: object properties: success: type: boolean message: type: string title: ListAudioEnhancementsRequestBadRequestError AudioEnhancementsPostRequestBodyContentMultipartFormDataSchemaEnhancementEngine: type: string enum: - v1 - v2 default: v2 description: Enhancement engine to use. Default is v2. title: AudioEnhancementsPostRequestBodyContentMultipartFormDataSchemaEnhancementEngine AudioEnhancementsPostResponsesContentApplicationJsonSchemaStatus: type: string enum: - pending title: AudioEnhancementsPostResponsesContentApplicationJsonSchemaStatus Audio Enhancement_createAudioEnhancement_Response_202: type: object properties: success: type: boolean uuid: type: string status: $ref: '#/components/schemas/AudioEnhancementsPostResponsesContentApplicationJsonSchemaStatus' title: Audio Enhancement_createAudioEnhancement_Response_202 CreateAudioEnhancementRequestBadRequestError: type: object properties: success: type: boolean message: type: string title: CreateAudioEnhancementRequestBadRequestError CreateAudioEnhancementRequestForbiddenError: type: object properties: success: type: boolean message: type: string title: CreateAudioEnhancementRequestForbiddenError AudioEnhancementsEnhancementUuidGetResponsesContentApplicationJsonSchemaStatus: type: string enum: - pending - processing - completed - failed title: AudioEnhancementsEnhancementUuidGetResponsesContentApplicationJsonSchemaStatus Audio Enhancement_getAudioEnhancement_Response_200: type: object properties: success: type: boolean uuid: type: string status: $ref: '#/components/schemas/AudioEnhancementsEnhancementUuidGetResponsesContentApplicationJsonSchemaStatus' enhanced_audio_url: type: - string - 'null' format: uri description: Download URL. Only present when status is completed. This is a temporary signed URL. error_message: type: - string - 'null' description: Human-readable error. Only present when status is failed. title: Audio Enhancement_getAudioEnhancement_Response_200 GetAudioEnhancementRequestNotFoundError: type: object properties: success: type: boolean message: type: string title: GetAudioEnhancementRequestNotFoundError AgentsGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: {} title: AgentsGetResponsesContentApplicationJsonSchemaItemsItems Agents_listAgents_Response_200: type: object properties: success: type: boolean items: type: array items: $ref: '#/components/schemas/AgentsGetResponsesContentApplicationJsonSchemaItemsItems' count: type: integer title: Agents_listAgents_Response_200 AgentsPostRequestBodyContentApplicationJsonSchemaDynamicVariables: oneOf: - type: string - type: number format: double - type: boolean title: AgentsPostRequestBodyContentApplicationJsonSchemaDynamicVariables AgentsPostRequestBodyContentApplicationJsonSchemaAsrUserInputAudioFormat: type: string enum: - pcm_8000 - pcm_16000 - pcm_22050 - pcm_24000 - pcm_44100 - pcm_48000 - ulaw_8000 default: pcm_16000 title: AgentsPostRequestBodyContentApplicationJsonSchemaAsrUserInputAudioFormat AgentsPostRequestBodyContentApplicationJsonSchemaAsr: type: object properties: model: type: string provider: type: string default: deepgram user_input_audio_format: $ref: '#/components/schemas/AgentsPostRequestBodyContentApplicationJsonSchemaAsrUserInputAudioFormat' keywords: type: array items: type: string title: AgentsPostRequestBodyContentApplicationJsonSchemaAsr AgentsPostRequestBodyContentApplicationJsonSchemaTurnMode: type: string enum: - silence default: silence title: AgentsPostRequestBodyContentApplicationJsonSchemaTurnMode AgentsPostRequestBodyContentApplicationJsonSchemaTurn: type: object properties: turn_timeout: type: integer default: 7 silence_end_call_timeout: type: integer default: -1 mode: $ref: '#/components/schemas/AgentsPostRequestBodyContentApplicationJsonSchemaTurnMode' title: AgentsPostRequestBodyContentApplicationJsonSchemaTurn AgentsPostRequestBodyContentApplicationJsonSchemaLlmBuiltInTools: type: object properties: {} title: AgentsPostRequestBodyContentApplicationJsonSchemaLlmBuiltInTools AgentsPostRequestBodyContentApplicationJsonSchemaLlm: type: object properties: prompt: type: string provider: type: string model: type: string reasoning_effort: type: - string - 'null' temperature: type: number format: double timezone: type: - string - 'null' built_in_tools: $ref: '#/components/schemas/AgentsPostRequestBodyContentApplicationJsonSchemaLlmBuiltInTools' title: AgentsPostRequestBodyContentApplicationJsonSchemaLlm AgentsPostRequestBodyContentApplicationJsonSchemaSearchMode: type: string enum: - speed - accuracy default: accuracy description: RAG search strategy - speed (faster) or accuracy (more thorough) title: AgentsPostRequestBodyContentApplicationJsonSchemaSearchMode AgentsPostRequestBodyContentApplicationJsonSchemaWebhooksItems: type: object properties: {} title: AgentsPostRequestBodyContentApplicationJsonSchemaWebhooksItems AgentsPostRequestBodyContentApplicationJsonSchemaSystemTools: type: object properties: {} title: AgentsPostRequestBodyContentApplicationJsonSchemaSystemTools AgentsPostResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: AgentsPostResponsesContentApplicationJsonSchemaItem Agents_createAgent_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/AgentsPostResponsesContentApplicationJsonSchemaItem' message: type: string title: Agents_createAgent_Response_200 AgentsUuidGetResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: AgentsUuidGetResponsesContentApplicationJsonSchemaItem Agents_getAgent_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/AgentsUuidGetResponsesContentApplicationJsonSchemaItem' title: Agents_getAgent_Response_200 Agents_deleteAgent_Response_200: type: object properties: success: type: boolean message: type: string title: Agents_deleteAgent_Response_200 AgentsUuidPatchRequestBodyContentApplicationJsonSchemaDynamicVariables: type: object properties: {} title: AgentsUuidPatchRequestBodyContentApplicationJsonSchemaDynamicVariables AgentsUuidPatchRequestBodyContentApplicationJsonSchemaAsr: type: object properties: {} title: AgentsUuidPatchRequestBodyContentApplicationJsonSchemaAsr AgentsUuidPatchRequestBodyContentApplicationJsonSchemaTurn: type: object properties: {} title: AgentsUuidPatchRequestBodyContentApplicationJsonSchemaTurn AgentsUuidPatchRequestBodyContentApplicationJsonSchemaLlm: type: object properties: {} title: AgentsUuidPatchRequestBodyContentApplicationJsonSchemaLlm AgentsUuidPatchRequestBodyContentApplicationJsonSchemaSearchMode: type: string enum: - speed - accuracy description: RAG search strategy title: AgentsUuidPatchRequestBodyContentApplicationJsonSchemaSearchMode AgentsUuidPatchRequestBodyContentApplicationJsonSchemaSystemTools: type: object properties: {} title: AgentsUuidPatchRequestBodyContentApplicationJsonSchemaSystemTools AgentsUuidPatchResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: AgentsUuidPatchResponsesContentApplicationJsonSchemaItem Agents_updateAgent_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/AgentsUuidPatchResponsesContentApplicationJsonSchemaItem' message: type: string title: Agents_updateAgent_Response_200 AgentsUuidDispatchPostRequestBodyContentApplicationJsonSchemaDynamicVariables: type: object properties: {} description: Runtime variable overrides title: AgentsUuidDispatchPostRequestBodyContentApplicationJsonSchemaDynamicVariables Agents_dispatchAgent_Response_200: type: object properties: success: type: boolean call_id: type: string title: Agents_dispatchAgent_Response_200 AgentsCapabilitiesGetResponsesContentApplicationJsonSchemaAsrCapabilitiesItems: type: object properties: provider: type: string description: ASR provider name (e.g., "deepgram") model: type: string description: Model identifier (e.g., "nova-2") description: type: string description: Human-readable description of the capability title: AgentsCapabilitiesGetResponsesContentApplicationJsonSchemaAsrCapabilitiesItems AgentsCapabilitiesGetResponsesContentApplicationJsonSchemaLlmCapabilitiesItems: type: object properties: provider: type: string description: LLM provider name (e.g., "openai", "anthropic") model: type: string description: Model identifier (e.g., "gpt-4o", "claude-3-5-sonnet-20241022") description: type: string description: Human-readable description of the capability title: AgentsCapabilitiesGetResponsesContentApplicationJsonSchemaLlmCapabilitiesItems Agents_getAgentCapabilities_Response_200: type: object properties: success: type: boolean asr_capabilities: type: array items: $ref: '#/components/schemas/AgentsCapabilitiesGetResponsesContentApplicationJsonSchemaAsrCapabilitiesItems' llm_capabilities: type: array items: $ref: '#/components/schemas/AgentsCapabilitiesGetResponsesContentApplicationJsonSchemaLlmCapabilitiesItems' title: Agents_getAgentCapabilities_Response_200 AgentsSystemToolsGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: {} title: AgentsSystemToolsGetResponsesContentApplicationJsonSchemaItemsItems Agents_getSystemTools_Response_200: type: object properties: success: type: boolean items: type: array items: $ref: '#/components/schemas/AgentsSystemToolsGetResponsesContentApplicationJsonSchemaItemsItems' title: Agents_getSystemTools_Response_200 AgentsAgentUuidToolsGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: {} title: AgentsAgentUuidToolsGetResponsesContentApplicationJsonSchemaItemsItems Agent Tools_listAgentTools_Response_200: type: object properties: success: type: boolean items: type: array items: $ref: '#/components/schemas/AgentsAgentUuidToolsGetResponsesContentApplicationJsonSchemaItemsItems' title: Agent Tools_listAgentTools_Response_200 AgentsAgentUuidToolsPostRequestBodyContentApplicationJsonSchemaToolType: type: string enum: - webhook - client title: AgentsAgentUuidToolsPostRequestBodyContentApplicationJsonSchemaToolType AgentsAgentUuidToolsPostRequestBodyContentApplicationJsonSchemaToolConfig: type: object properties: {} title: AgentsAgentUuidToolsPostRequestBodyContentApplicationJsonSchemaToolConfig AgentsAgentUuidToolsPostResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: AgentsAgentUuidToolsPostResponsesContentApplicationJsonSchemaItem Agent Tools_createAgentTool_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/AgentsAgentUuidToolsPostResponsesContentApplicationJsonSchemaItem' message: type: string title: Agent Tools_createAgentTool_Response_200 AgentsAgentUuidToolsToolUuidGetResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: AgentsAgentUuidToolsToolUuidGetResponsesContentApplicationJsonSchemaItem Agent Tools_getAgentTool_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/AgentsAgentUuidToolsToolUuidGetResponsesContentApplicationJsonSchemaItem' title: Agent Tools_getAgentTool_Response_200 Agent Tools_deleteAgentTool_Response_200: type: object properties: success: type: boolean message: type: string title: Agent Tools_deleteAgentTool_Response_200 AgentsAgentUuidToolsToolUuidPatchRequestBodyContentApplicationJsonSchemaToolConfig: type: object properties: {} title: AgentsAgentUuidToolsToolUuidPatchRequestBodyContentApplicationJsonSchemaToolConfig AgentsAgentUuidToolsToolUuidPatchResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: AgentsAgentUuidToolsToolUuidPatchResponsesContentApplicationJsonSchemaItem Agent Tools_updateAgentTool_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/AgentsAgentUuidToolsToolUuidPatchResponsesContentApplicationJsonSchemaItem' message: type: string title: Agent Tools_updateAgentTool_Response_200 AgentsAgentUuidWebhooksGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: {} title: AgentsAgentUuidWebhooksGetResponsesContentApplicationJsonSchemaItemsItems Agent Webhooks_listAgentWebhooks_Response_200: type: object properties: success: type: boolean items: type: array items: $ref: '#/components/schemas/AgentsAgentUuidWebhooksGetResponsesContentApplicationJsonSchemaItemsItems' title: Agent Webhooks_listAgentWebhooks_Response_200 AgentsAgentUuidWebhooksPostRequestBodyContentApplicationJsonSchemaWebhookType: type: string enum: - pre_call - post_call title: AgentsAgentUuidWebhooksPostRequestBodyContentApplicationJsonSchemaWebhookType AgentsAgentUuidWebhooksPostRequestBodyContentApplicationJsonSchemaWebhookConfig: type: object properties: {} title: AgentsAgentUuidWebhooksPostRequestBodyContentApplicationJsonSchemaWebhookConfig AgentsAgentUuidWebhooksPostResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: AgentsAgentUuidWebhooksPostResponsesContentApplicationJsonSchemaItem Agent Webhooks_createAgentWebhook_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/AgentsAgentUuidWebhooksPostResponsesContentApplicationJsonSchemaItem' message: type: string title: Agent Webhooks_createAgentWebhook_Response_200 AgentsAgentUuidWebhooksWebhookUuidGetResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: AgentsAgentUuidWebhooksWebhookUuidGetResponsesContentApplicationJsonSchemaItem Agent Webhooks_getAgentWebhook_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/AgentsAgentUuidWebhooksWebhookUuidGetResponsesContentApplicationJsonSchemaItem' title: Agent Webhooks_getAgentWebhook_Response_200 Agent Webhooks_deleteAgentWebhook_Response_200: type: object properties: success: type: boolean message: type: string title: Agent Webhooks_deleteAgentWebhook_Response_200 AgentsAgentUuidWebhooksWebhookUuidPatchRequestBodyContentApplicationJsonSchemaWebhookConfig: type: object properties: {} title: AgentsAgentUuidWebhooksWebhookUuidPatchRequestBodyContentApplicationJsonSchemaWebhookConfig AgentsAgentUuidWebhooksWebhookUuidPatchResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: AgentsAgentUuidWebhooksWebhookUuidPatchResponsesContentApplicationJsonSchemaItem Agent Webhooks_updateAgentWebhook_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/AgentsAgentUuidWebhooksWebhookUuidPatchResponsesContentApplicationJsonSchemaItem' message: type: string title: Agent Webhooks_updateAgentWebhook_Response_200 PhoneNumbersGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: {} title: PhoneNumbersGetResponsesContentApplicationJsonSchemaItemsItems Agent Phone Numbers_listPhoneNumbers_Response_200: type: object properties: success: type: boolean items: type: array items: $ref: '#/components/schemas/PhoneNumbersGetResponsesContentApplicationJsonSchemaItemsItems' title: Agent Phone Numbers_listPhoneNumbers_Response_200 PhoneNumbersPostRequestBodyContentApplicationJsonSchemaProvider: type: string enum: - twilio title: PhoneNumbersPostRequestBodyContentApplicationJsonSchemaProvider PhoneNumbersPostRequestBodyContentApplicationJsonSchemaOutboundTrunk: type: object properties: {} title: PhoneNumbersPostRequestBodyContentApplicationJsonSchemaOutboundTrunk PhoneNumbersPostRequestBodyContentApplicationJsonSchemaInboundTrunk: type: object properties: {} title: PhoneNumbersPostRequestBodyContentApplicationJsonSchemaInboundTrunk PhoneNumbersPostResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: PhoneNumbersPostResponsesContentApplicationJsonSchemaItem Agent Phone Numbers_createPhoneNumber_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/PhoneNumbersPostResponsesContentApplicationJsonSchemaItem' message: type: string title: Agent Phone Numbers_createPhoneNumber_Response_200 PhoneNumbersIdGetResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: PhoneNumbersIdGetResponsesContentApplicationJsonSchemaItem Agent Phone Numbers_getPhoneNumber_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/PhoneNumbersIdGetResponsesContentApplicationJsonSchemaItem' title: Agent Phone Numbers_getPhoneNumber_Response_200 Agent Phone Numbers_deletePhoneNumber_Response_200: type: object properties: success: type: boolean message: type: string title: Agent Phone Numbers_deletePhoneNumber_Response_200 Agent Phone Numbers_forceDeletePhoneNumber_Response_200: type: object properties: success: type: boolean message: type: string title: Agent Phone Numbers_forceDeletePhoneNumber_Response_200 KnowledgeItemsGetParametersStatus: type: string enum: - pending - processing - ready - failed title: KnowledgeItemsGetParametersStatus KnowledgeItemsGetParametersSourceType: type: string enum: - document - url - text title: KnowledgeItemsGetParametersSourceType KnowledgeItemsGetResponsesContentApplicationJsonSchemaItemsItemsSourceType: type: string enum: - document - url - text title: KnowledgeItemsGetResponsesContentApplicationJsonSchemaItemsItemsSourceType KnowledgeItemsGetResponsesContentApplicationJsonSchemaItemsItemsStatus: type: string enum: - pending - processing - ready - failed title: KnowledgeItemsGetResponsesContentApplicationJsonSchemaItemsItemsStatus KnowledgeItemsGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: uuid: type: string format: uuid title: type: string description: type: string source_type: $ref: '#/components/schemas/KnowledgeItemsGetResponsesContentApplicationJsonSchemaItemsItemsSourceType' status: $ref: '#/components/schemas/KnowledgeItemsGetResponsesContentApplicationJsonSchemaItemsItemsStatus' error_message: type: - string - 'null' chunk_count: type: - integer - 'null' url: type: - string - 'null' document_url: type: - string - 'null' document_filename: type: - string - 'null' agent_count: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time title: KnowledgeItemsGetResponsesContentApplicationJsonSchemaItemsItems KnowledgeItemsGetResponsesContentApplicationJsonSchemaPagination: type: object properties: page: type: integer per_page: type: integer total_count: type: integer total_pages: type: integer title: KnowledgeItemsGetResponsesContentApplicationJsonSchemaPagination Agent Knowledge Base_listKnowledgeItems_Response_200: type: object properties: success: type: boolean items: type: array items: $ref: '#/components/schemas/KnowledgeItemsGetResponsesContentApplicationJsonSchemaItemsItems' pagination: $ref: '#/components/schemas/KnowledgeItemsGetResponsesContentApplicationJsonSchemaPagination' title: Agent Knowledge Base_listKnowledgeItems_Response_200 KnowledgeItemsPostRequestBodyContentApplicationJsonSchemaSourceType: type: string enum: - document - url - text description: Type of knowledge source title: KnowledgeItemsPostRequestBodyContentApplicationJsonSchemaSourceType KnowledgeItemsPostResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: KnowledgeItemsPostResponsesContentApplicationJsonSchemaItem Agent Knowledge Base_createKnowledgeItem_Response_201: type: object properties: success: type: boolean item: $ref: '#/components/schemas/KnowledgeItemsPostResponsesContentApplicationJsonSchemaItem' message: type: string title: Agent Knowledge Base_createKnowledgeItem_Response_201 KnowledgeItemsUuidGetResponsesContentApplicationJsonSchemaItemSourceType: type: string enum: - document - url - text title: KnowledgeItemsUuidGetResponsesContentApplicationJsonSchemaItemSourceType KnowledgeItemsUuidGetResponsesContentApplicationJsonSchemaItemStatus: type: string enum: - pending - processing - ready - failed title: KnowledgeItemsUuidGetResponsesContentApplicationJsonSchemaItemStatus KnowledgeItemsUuidGetResponsesContentApplicationJsonSchemaItemAgentsItems: type: object properties: uuid: type: string format: uuid name: type: string title: KnowledgeItemsUuidGetResponsesContentApplicationJsonSchemaItemAgentsItems KnowledgeItemsUuidGetResponsesContentApplicationJsonSchemaItem: type: object properties: uuid: type: string format: uuid title: type: string description: type: string source_type: $ref: '#/components/schemas/KnowledgeItemsUuidGetResponsesContentApplicationJsonSchemaItemSourceType' status: $ref: '#/components/schemas/KnowledgeItemsUuidGetResponsesContentApplicationJsonSchemaItemStatus' error_message: type: - string - 'null' chunk_count: type: - integer - 'null' url: type: - string - 'null' document_url: type: - string - 'null' document_filename: type: - string - 'null' agents: type: array items: $ref: '#/components/schemas/KnowledgeItemsUuidGetResponsesContentApplicationJsonSchemaItemAgentsItems' created_at: type: string format: date-time updated_at: type: string format: date-time title: KnowledgeItemsUuidGetResponsesContentApplicationJsonSchemaItem Agent Knowledge Base_getKnowledgeItem_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/KnowledgeItemsUuidGetResponsesContentApplicationJsonSchemaItem' title: Agent Knowledge Base_getKnowledgeItem_Response_200 Agent Knowledge Base_deleteKnowledgeItem_Response_200: type: object properties: success: type: boolean message: type: string title: Agent Knowledge Base_deleteKnowledgeItem_Response_200 KnowledgeItemsUuidReingestPostResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: KnowledgeItemsUuidReingestPostResponsesContentApplicationJsonSchemaItem Agent Knowledge Base_reingestKnowledgeItem_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/KnowledgeItemsUuidReingestPostResponsesContentApplicationJsonSchemaItem' message: type: string title: Agent Knowledge Base_reingestKnowledgeItem_Response_200 AgentsAgentUuidKnowledgeItemsGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: {} title: AgentsAgentUuidKnowledgeItemsGetResponsesContentApplicationJsonSchemaItemsItems Agent Knowledge Base_listAgentKnowledgeItems_Response_200: type: object properties: success: type: boolean items: type: array items: $ref: '#/components/schemas/AgentsAgentUuidKnowledgeItemsGetResponsesContentApplicationJsonSchemaItemsItems' count: type: integer title: Agent Knowledge Base_listAgentKnowledgeItems_Response_200 AgentsAgentUuidKnowledgeItemsPostResponsesContentApplicationJsonSchemaItemsItems: type: object properties: {} title: AgentsAgentUuidKnowledgeItemsPostResponsesContentApplicationJsonSchemaItemsItems Agent Knowledge Base_attachKnowledgeItemToAgent_Response_201: type: object properties: success: type: boolean items: type: array items: $ref: '#/components/schemas/AgentsAgentUuidKnowledgeItemsPostResponsesContentApplicationJsonSchemaItemsItems' message: type: string title: Agent Knowledge Base_attachKnowledgeItemToAgent_Response_201 AgentsAgentUuidKnowledgeItemsKnowledgeItemUuidDeleteResponsesContentApplicationJsonSchemaItemsItems: type: object properties: {} title: AgentsAgentUuidKnowledgeItemsKnowledgeItemUuidDeleteResponsesContentApplicationJsonSchemaItemsItems Agent Knowledge Base_detachKnowledgeItemFromAgent_Response_200: type: object properties: success: type: boolean items: type: array items: $ref: >- #/components/schemas/AgentsAgentUuidKnowledgeItemsKnowledgeItemUuidDeleteResponsesContentApplicationJsonSchemaItemsItems message: type: string title: Agent Knowledge Base_detachKnowledgeItemFromAgent_Response_200 Secure Uploads_createSecureUpload_Response_200: type: object properties: success: type: boolean token: type: string description: >- JWT referencing the uploaded file. Valid for 1 hour. Pass this value as `media_token` on downstream requests. title: Secure Uploads_createSecureUpload_Response_200 DetectGetResponsesContentApplicationJsonSchemaItemsItemsMediaType: type: string enum: - audio - video - image title: DetectGetResponsesContentApplicationJsonSchemaItemsItemsMediaType DetectGetResponsesContentApplicationJsonSchemaItemsItemsStatus: type: string enum: - processing - completed - failed title: DetectGetResponsesContentApplicationJsonSchemaItemsItemsStatus DetectAudioMetrics: type: object properties: label: type: string description: Detection label (fake or real) score: type: array items: type: string description: Array of prediction scores per chunk consistency: type: string description: Consistency metric across chunks aggregated_score: type: string description: Overall aggregated detection score image: type: string description: URL to visualization heatmap image (if visualize=true) required: - label - score - consistency - aggregated_score description: Audio detection metrics (for audio and video media types) title: DetectAudioMetrics DetectImageMetricsChildrenItems: type: object properties: {} title: DetectImageMetricsChildrenItems DetectImageMetrics: type: object properties: type: type: string description: Type of image analysis performed label: type: string description: Detection label (fake or real) image: type: string description: URL to visualization image score: type: number format: double description: Detection confidence score children: type: array items: $ref: '#/components/schemas/DetectImageMetricsChildrenItems' description: Nested analysis results (structure varies by pipeline) required: - type - label - image - score - children description: Image detection metrics (for image media type) title: DetectImageMetrics DetectVideoMetricsChildrenItemsChildrenItemsChildrenItems: type: object properties: type: type: string conclusion: type: string score: type: number format: double certainty: type: number format: double certainty (%): type: string required: - type - conclusion - score - certainty - certainty (%) title: DetectVideoMetricsChildrenItemsChildrenItemsChildrenItems DetectVideoMetricsChildrenItemsChildrenItems: type: object properties: type: type: string conclusion: type: string score: type: number format: double certainty: type: number format: double certainty (%): type: string timestamp: type: number format: double description: Timestamp in seconds children: type: array items: $ref: '#/components/schemas/DetectVideoMetricsChildrenItemsChildrenItemsChildrenItems' description: Segment-level detection results required: - type - conclusion - score - certainty - certainty (%) - timestamp - children title: DetectVideoMetricsChildrenItemsChildrenItems DetectVideoMetricsChildrenItems: type: object properties: type: type: string conclusion: type: string score: type: number format: double certainty: type: number format: double certainty (%): type: string children: type: array items: $ref: '#/components/schemas/DetectVideoMetricsChildrenItemsChildrenItems' description: Frame-level detection results required: - type - conclusion - score - certainty - certainty (%) - children title: DetectVideoMetricsChildrenItems DetectVideoMetrics: type: object properties: label: type: string description: Overall video detection label score: type: number format: double description: Overall detection score certainty: type: number format: double description: Overall certainty score treeview: type: string description: Optional tree visualization data children: type: array items: $ref: '#/components/schemas/DetectVideoMetricsChildrenItems' description: Hierarchical detection results across frames required: - label - score - certainty - children description: Video detection metrics (for video media type) title: DetectVideoMetrics DetectGetResponsesContentApplicationJsonSchemaItemsItemsAudioSourceTracing: type: object properties: label: type: string description: Identified source (e.g., resemble_ai, elevenlabs) or "real" if audio is not synthetic error_message: type: - string - 'null' description: Source tracing results (only returned if audio is labeled fake) title: DetectGetResponsesContentApplicationJsonSchemaItemsItemsAudioSourceTracing DetectGetResponsesContentApplicationJsonSchemaItemsItemsIntelligence: type: object properties: {} title: DetectGetResponsesContentApplicationJsonSchemaItemsItemsIntelligence DetectGetResponsesContentApplicationJsonSchemaItemsItemsExtraParams: type: object properties: {} title: DetectGetResponsesContentApplicationJsonSchemaItemsItemsExtraParams DetectGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: uuid: type: string media_type: $ref: '#/components/schemas/DetectGetResponsesContentApplicationJsonSchemaItemsItemsMediaType' status: $ref: '#/components/schemas/DetectGetResponsesContentApplicationJsonSchemaItemsItemsStatus' metrics: $ref: '#/components/schemas/DetectAudioMetrics' image_metrics: $ref: '#/components/schemas/DetectImageMetrics' video_metrics: $ref: '#/components/schemas/DetectVideoMetrics' audio_source_tracing: oneOf: - $ref: '#/components/schemas/DetectGetResponsesContentApplicationJsonSchemaItemsItemsAudioSourceTracing' - type: 'null' description: Source tracing results (only returned if audio is labeled fake) intelligence: oneOf: - $ref: '#/components/schemas/DetectGetResponsesContentApplicationJsonSchemaItemsItemsIntelligence' - type: 'null' url: type: - string - 'null' description: URL to the media file. Null when Zero Retention Mode is enabled. audio_url: type: - string - 'null' description: Alias of url. Null when Zero Retention Mode is enabled. filename: type: string description: Original filename, or tokenized (redacted_.) when Zero Retention Mode is enabled duration: type: number format: double zero_retention_mode: type: boolean description: Whether Zero Retention Mode was enabled for this detect file_deleted_at: type: - string - 'null' format: date-time description: ISO 8601 timestamp of when the file was purged, or null if not yet deleted visualize: type: boolean audio_source_tracing_enabled: type: boolean use_ood_detector: type: boolean pipeline: type: - string - 'null' description: Legacy field. May be present on older image/video detects. Ignored on create for new detections. extra_params: $ref: '#/components/schemas/DetectGetResponsesContentApplicationJsonSchemaItemsItemsExtraParams' error_message: type: - string - 'null' created_at: type: string format: date-time updated_at: type: string format: date-time title: DetectGetResponsesContentApplicationJsonSchemaItemsItems Deepfake Detection_listDetections_Response_200: type: object properties: success: type: boolean page: type: integer num_pages: type: integer page_size: type: integer total_count: type: integer items: type: array items: $ref: '#/components/schemas/DetectGetResponsesContentApplicationJsonSchemaItemsItems' title: Deepfake Detection_listDetections_Response_200 DetectPostRequestBodyContentMultipartFormDataSchemaModelTypes: type: string enum: - image - talking_head description: Use talking_head for face-swaps title: DetectPostRequestBodyContentMultipartFormDataSchemaModelTypes DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1FraudType: type: string enum: - none - vishing - impersonation - romance_scam - tech_support_scam - financial_fraud - extortion - political_manipulation - synthetic_media_fraud - insurance_fraud - employment_fraud - other title: DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1FraudType DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1Fraud: type: object properties: type: $ref: >- #/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1FraudType confidence: type: number format: double reasoning: type: string title: DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1Fraud DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1LivenessAssessment: type: string enum: - real_person - not_real_person - inconclusive title: DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1LivenessAssessment DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1Liveness: type: object properties: assessment: $ref: >- #/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1LivenessAssessment confidence: type: number format: double indicators: type: string title: DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1Liveness DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1DigitallyAltered: type: object properties: detected: type: boolean confidence: type: number format: double alterations: type: string title: DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1DigitallyAltered DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescription1: type: object properties: speaker_info: type: string language: type: string dialect: type: string emotion: type: string speaking_style: type: string context: type: string message: type: string abnormalities: type: string transcription: type: string translation: type: - string - 'null' misinformation: type: string fraud: $ref: '#/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1Fraud' liveness: $ref: >- #/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1Liveness digitally_altered: $ref: >- #/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1DigitallyAltered title: DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescription1 DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescription: oneOf: - type: string - $ref: '#/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescription1' title: DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescription DetectPostResponsesContentApplicationJsonSchemaItemIntelligence: type: object properties: description: $ref: '#/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItemIntelligenceDescription' created_at: type: string format: date-time description: Intelligence results when requested title: DetectPostResponsesContentApplicationJsonSchemaItemIntelligence DetectPostResponsesContentApplicationJsonSchemaItem: type: object properties: uuid: type: string status: type: string zero_retention_mode: type: boolean description: Whether Zero Retention Mode is enabled for this detect file_deleted_at: type: - string - 'null' format: date-time description: ISO 8601 timestamp of when the file was purged, or null if not yet deleted url: type: - string - 'null' description: URL to the media file. Null when Zero Retention Mode is enabled. audio_url: type: - string - 'null' description: Alias of url. Null when Zero Retention Mode is enabled. filename: type: string description: Original filename, or tokenized (redacted_.) when Zero Retention Modeon Modeon Mode is enabled intelligence: oneOf: - $ref: '#/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItemIntelligence' - type: 'null' description: Intelligence results when requested title: DetectPostResponsesContentApplicationJsonSchemaItem Deepfake Detection_createDetection_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/DetectPostResponsesContentApplicationJsonSchemaItem' title: Deepfake Detection_createDetection_Response_200 DetectUuidGetResponsesContentApplicationJsonSchemaItemMediaType: type: string enum: - audio - video - image title: DetectUuidGetResponsesContentApplicationJsonSchemaItemMediaType DetectUuidGetResponsesContentApplicationJsonSchemaItemStatus: type: string enum: - processing - completed - failed title: DetectUuidGetResponsesContentApplicationJsonSchemaItemStatus DetectUuidGetResponsesContentApplicationJsonSchemaItemAudioSourceTracing: type: object properties: label: type: string description: Identified source (e.g., resemble_ai, elevenlabs) or "real" if audio is not synthetic error_message: type: - string - 'null' description: Source tracing results (only returned if audio is labeled fake) title: DetectUuidGetResponsesContentApplicationJsonSchemaItemAudioSourceTracing DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1FraudType: type: string enum: - none - vishing - impersonation - romance_scam - tech_support_scam - financial_fraud - extortion - political_manipulation - synthetic_media_fraud - insurance_fraud - employment_fraud - other title: DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1FraudType DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1Fraud: type: object properties: type: $ref: >- #/components/schemas/DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1FraudType confidence: type: number format: double reasoning: type: string title: DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1Fraud DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1LivenessAssessment: type: string enum: - real_person - not_real_person - inconclusive title: DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1LivenessAssessment DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1Liveness: type: object properties: assessment: $ref: >- #/components/schemas/DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1LivenessAssessment confidence: type: number format: double indicators: type: string title: DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1Liveness DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1DigitallyAltered: type: object properties: detected: type: boolean confidence: type: number format: double alterations: type: string title: DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1DigitallyAltered DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescription1: type: object properties: speaker_info: type: string language: type: string dialect: type: string emotion: type: string speaking_style: type: string context: type: string message: type: string abnormalities: type: string transcription: type: string translation: type: - string - 'null' misinformation: type: string fraud: $ref: >- #/components/schemas/DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1Fraud liveness: $ref: >- #/components/schemas/DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1Liveness digitally_altered: $ref: >- #/components/schemas/DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescriptionOneOf1DigitallyAltered title: DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescription1 DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescription: oneOf: - type: string - $ref: '#/components/schemas/DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescription1' title: DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescription DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligence: type: object properties: uuid: type: string description: $ref: '#/components/schemas/DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligenceDescription' created_at: type: string format: date-time description: Intelligence results when requested title: DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligence DetectUuidGetResponsesContentApplicationJsonSchemaItem: type: object properties: uuid: type: string media_type: $ref: '#/components/schemas/DetectUuidGetResponsesContentApplicationJsonSchemaItemMediaType' status: $ref: '#/components/schemas/DetectUuidGetResponsesContentApplicationJsonSchemaItemStatus' metrics: $ref: '#/components/schemas/DetectAudioMetrics' image_metrics: $ref: '#/components/schemas/DetectImageMetrics' video_metrics: $ref: '#/components/schemas/DetectVideoMetrics' audio_source_tracing: oneOf: - $ref: '#/components/schemas/DetectUuidGetResponsesContentApplicationJsonSchemaItemAudioSourceTracing' - type: 'null' description: Source tracing results (only returned if audio is labeled fake) intelligence: oneOf: - $ref: '#/components/schemas/DetectUuidGetResponsesContentApplicationJsonSchemaItemIntelligence' - type: 'null' description: Intelligence results when requested url: type: - string - 'null' description: URL to the media file. Null when Zero Retention Modeon Modeon Modeon Modeon Modeon Modeon Mode is enabled. audio_url: type: - string - 'null' description: Alias of url. Null when Zero Retention Mode is enabled. filename: type: string description: Original filename, or tokenized (redacted_.) when Zero Retention Mode is enabled duration: type: number format: double zero_retention_mode: type: boolean description: Whether Zero Retention Mode is enabled for this detect file_deleted_at: type: - string - 'null' format: date-time description: ISO 8601 timestamp of when the file was purged, or null if not yet deleted created_at: type: string format: date-time updated_at: type: string format: date-time title: DetectUuidGetResponsesContentApplicationJsonSchemaItem Deepfake Detection_getDetection_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/DetectUuidGetResponsesContentApplicationJsonSchemaItem' title: Deepfake Detection_getDetection_Response_200 DetectBatchStatus: type: string enum: - processing - completed - partially_failed - failed description: | Aggregate status across all child detects. - `processing` — at least one child detect is still running. - `completed` — every child detect completed successfully. - `partially_failed` — at least one succeeded and at least one failed. - `failed` — every child detect failed. title: DetectBatchStatus DetectBatch: type: object properties: uuid: type: string description: Batch UUID. status: $ref: '#/components/schemas/DetectBatchStatus' description: | Aggregate status across all child detects. - `processing` — at least one child detect is still running. - `completed` — every child detect completed successfully. - `partially_failed` — at least one succeeded and at least one failed. - `failed` — every child detect failed. total_files: type: integer description: Number of files in the batch (1–50). completed_count: type: integer description: Number of child detects that have completed successfully. failed_count: type: integer description: Number of child detects that have failed. created_at: type: string format: date-time detect_uuids: type: array items: type: string description: UUIDs of the child detects. Use `GET /detect/{uuid}` to retrieve per-file results. description: Aggregate state for a batch detection job. Returned by `POST /detect/batch` and `GET /detect/batch/{uuid}`. title: DetectBatch Deepfake Detection_createDetectBatch_Response_202: type: object properties: success: type: boolean item: $ref: '#/components/schemas/DetectBatch' title: Deepfake Detection_createDetectBatch_Response_202 Deepfake Detection_getDetectBatch_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/DetectBatch' title: Deepfake Detection_getDetectBatch_Response_200 IntelligencePostRequestBodyContentApplicationJsonSchemaMediaType: type: string enum: - audio - video - image description: Explicit media type (auto-detected if not provided) title: IntelligencePostRequestBodyContentApplicationJsonSchemaMediaType IntelligencePostResponsesContentApplicationJsonSchemaItemMediaType: type: string enum: - audio - video - image description: Type of media analyzed title: IntelligencePostResponsesContentApplicationJsonSchemaItemMediaType IntelligencePostResponsesContentApplicationJsonSchemaItem: type: object properties: uuid: type: string created_at: type: string format: date-time detect_uuid: type: string description: UUID of the associated detect object media_type: $ref: '#/components/schemas/IntelligencePostResponsesContentApplicationJsonSchemaItemMediaType' description: Type of media analyzed title: IntelligencePostResponsesContentApplicationJsonSchemaItem Intelligence_runIntelligence_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/IntelligencePostResponsesContentApplicationJsonSchemaItem' title: Intelligence_runIntelligence_Response_200 IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionFraudType: type: string enum: - none - vishing - impersonation - romance_scam - tech_support_scam - financial_fraud - extortion - political_manipulation - synthetic_media_fraud - insurance_fraud - employment_fraud - other title: IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionFraudType IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionFraud: type: object properties: type: $ref: '#/components/schemas/IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionFraudType' confidence: type: number format: double reasoning: type: string title: IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionFraud IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionLivenessAssessment: type: string enum: - real_person - not_real_person - inconclusive title: IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionLivenessAssessment IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionLiveness: type: object properties: assessment: $ref: >- #/components/schemas/IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionLivenessAssessment confidence: type: number format: double indicators: type: string title: IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionLiveness IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionDigitallyAltered: type: object properties: detected: type: boolean confidence: type: number format: double alterations: type: string title: IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionDigitallyAltered IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescription: type: object properties: speaker_info: type: string language: type: string dialect: type: string emotion: type: string speaking_style: type: string context: type: string message: type: string abnormalities: type: string transcription: type: string translation: type: - string - 'null' misinformation: type: string fraud: $ref: '#/components/schemas/IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionFraud' liveness: $ref: '#/components/schemas/IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionLiveness' digitally_altered: $ref: >- #/components/schemas/IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescriptionDigitallyAltered description: Structured intelligence analysis title: IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescription IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsMediaType: type: string enum: - audio - video - image description: Type of media analyzed title: IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsMediaType IntelligencesGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: uuid: type: string description: $ref: '#/components/schemas/IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsDescription' description: Structured intelligence analysis created_at: type: string format: date-time detect_uuid: type: string description: UUID of the associated detect object media_type: $ref: '#/components/schemas/IntelligencesGetResponsesContentApplicationJsonSchemaItemsItemsMediaType' description: Type of media analyzed title: IntelligencesGetResponsesContentApplicationJsonSchemaItemsItems Intelligence_listIntelligences_Response_200: type: object properties: success: type: boolean page: type: integer num_pages: type: integer page_size: type: integer total_count: type: integer items: type: array items: $ref: '#/components/schemas/IntelligencesGetResponsesContentApplicationJsonSchemaItemsItems' title: Intelligence_listIntelligences_Response_200 IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionFraudType: type: string enum: - none - vishing - impersonation - romance_scam - tech_support_scam - financial_fraud - extortion - political_manipulation - synthetic_media_fraud - insurance_fraud - employment_fraud - other title: IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionFraudType IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionFraud: type: object properties: type: $ref: '#/components/schemas/IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionFraudType' confidence: type: number format: double reasoning: type: string title: IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionFraud IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionLivenessAssessment: type: string enum: - real_person - not_real_person - inconclusive title: IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionLivenessAssessment IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionLiveness: type: object properties: assessment: $ref: >- #/components/schemas/IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionLivenessAssessment confidence: type: number format: double indicators: type: string title: IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionLiveness IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionDigitallyAltered: type: object properties: detected: type: boolean confidence: type: number format: double alterations: type: string title: IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionDigitallyAltered IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescription: type: object properties: speaker_info: type: string language: type: string dialect: type: string emotion: type: string speaking_style: type: string context: type: string message: type: string abnormalities: type: string transcription: type: string translation: type: - string - 'null' misinformation: type: string fraud: $ref: '#/components/schemas/IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionFraud' liveness: $ref: '#/components/schemas/IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionLiveness' digitally_altered: $ref: >- #/components/schemas/IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescriptionDigitallyAltered description: Structured intelligence analysis title: IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescription IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemMediaType: type: string enum: - audio - video - image description: Type of media analyzed title: IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemMediaType IntelligencesUuidGetResponsesContentApplicationJsonSchemaItem: type: object properties: uuid: type: string description: $ref: '#/components/schemas/IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemDescription' description: Structured intelligence analysis created_at: type: string format: date-time detect_uuid: type: string description: UUID of the associated detect object media_type: $ref: '#/components/schemas/IntelligencesUuidGetResponsesContentApplicationJsonSchemaItemMediaType' description: Type of media analyzed title: IntelligencesUuidGetResponsesContentApplicationJsonSchemaItem Intelligence_getIntelligence_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/IntelligencesUuidGetResponsesContentApplicationJsonSchemaItem' title: Intelligence_getIntelligence_Response_200 DetectsUuidIntelligencePostResponsesContentApplicationJsonSchemaItemStatus: type: string enum: - pending - processing - completed - failed description: Current status of the question title: DetectsUuidIntelligencePostResponsesContentApplicationJsonSchemaItemStatus DetectsUuidIntelligencePostResponsesContentApplicationJsonSchemaItem: type: object properties: uuid: type: string description: UUID of the question detect_uuid: type: string description: UUID of the associated detection report query: type: string description: The submitted question answer: type: - string - 'null' description: The generated answer (null until completed) status: $ref: '#/components/schemas/DetectsUuidIntelligencePostResponsesContentApplicationJsonSchemaItemStatus' description: Current status of the question error_message: type: - string - 'null' description: Error details when status is failed created_at: type: string format: date-time updated_at: type: string format: date-time title: DetectsUuidIntelligencePostResponsesContentApplicationJsonSchemaItem Detect Intelligence_askDetectIntelligenceQuestion_Response_202: type: object properties: success: type: boolean item: $ref: '#/components/schemas/DetectsUuidIntelligencePostResponsesContentApplicationJsonSchemaItem' title: Detect Intelligence_askDetectIntelligenceQuestion_Response_202 DetectsUuidIntelligenceQuestionUuidGetResponsesContentApplicationJsonSchemaItemStatus: type: string enum: - pending - processing - completed - failed description: Current status of the question title: DetectsUuidIntelligenceQuestionUuidGetResponsesContentApplicationJsonSchemaItemStatus DetectsUuidIntelligenceQuestionUuidGetResponsesContentApplicationJsonSchemaItem: type: object properties: uuid: type: string description: UUID of the question detect_uuid: type: string description: UUID of the associated detection report query: type: string description: The submitted question answer: type: - string - 'null' description: The generated answer (null until completed) status: $ref: '#/components/schemas/DetectsUuidIntelligenceQuestionUuidGetResponsesContentApplicationJsonSchemaItemStatus' description: Current status of the question error_message: type: - string - 'null' description: Error details when status is failed created_at: type: string format: date-time updated_at: type: string format: date-time title: DetectsUuidIntelligenceQuestionUuidGetResponsesContentApplicationJsonSchemaItem Detect Intelligence_getDetectIntelligenceQuestion_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/DetectsUuidIntelligenceQuestionUuidGetResponsesContentApplicationJsonSchemaItem' title: Detect Intelligence_getDetectIntelligenceQuestion_Response_200 AudioSourceTracingsGetResponsesContentApplicationJsonSchemaItemsItemsResults: type: object properties: label: type: string description: Identified source (e.g., resemble_ai, elevenlabs) or "real" if audio is not synthetic error_message: type: - string - 'null' title: AudioSourceTracingsGetResponsesContentApplicationJsonSchemaItemsItemsResults AudioSourceTracingsGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: uuid: type: string results: $ref: '#/components/schemas/AudioSourceTracingsGetResponsesContentApplicationJsonSchemaItemsItemsResults' created_at: type: string format: date-time detect_uuid: type: string description: UUID of the associated detect object title: AudioSourceTracingsGetResponsesContentApplicationJsonSchemaItemsItems Audio Source Tracing_listAudioSourceTracings_Response_200: type: object properties: success: type: boolean page: type: integer num_pages: type: integer page_size: type: integer total_count: type: integer items: type: array items: $ref: '#/components/schemas/AudioSourceTracingsGetResponsesContentApplicationJsonSchemaItemsItems' title: Audio Source Tracing_listAudioSourceTracings_Response_200 AudioSourceTracingsUuidGetResponsesContentApplicationJsonSchemaItemResults: type: object properties: label: type: string description: Identified source (e.g., resemble_ai, elevenlabs) or "real" if audio is not synthetic error_message: type: - string - 'null' title: AudioSourceTracingsUuidGetResponsesContentApplicationJsonSchemaItemResults AudioSourceTracingsUuidGetResponsesContentApplicationJsonSchemaItem: type: object properties: uuid: type: string results: $ref: '#/components/schemas/AudioSourceTracingsUuidGetResponsesContentApplicationJsonSchemaItemResults' created_at: type: string format: date-time detect_uuid: type: string description: UUID of the associated detect object title: AudioSourceTracingsUuidGetResponsesContentApplicationJsonSchemaItem Audio Source Tracing_getAudioSourceTracing_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/AudioSourceTracingsUuidGetResponsesContentApplicationJsonSchemaItem' title: Audio Source Tracing_getAudioSourceTracing_Response_200 IdentityGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: {} title: IdentityGetResponsesContentApplicationJsonSchemaItemsItems Identity_listIdentities_Response_200: type: object properties: success: type: boolean items: type: array items: $ref: '#/components/schemas/IdentityGetResponsesContentApplicationJsonSchemaItemsItems' title: Identity_listIdentities_Response_200 IdentityPostResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: IdentityPostResponsesContentApplicationJsonSchemaItem Identity_createIdentity_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/IdentityPostResponsesContentApplicationJsonSchemaItem' title: Identity_createIdentity_Response_200 IdentitySearchPostResponsesContentApplicationJsonSchemaMatchesItems: type: object properties: {} title: IdentitySearchPostResponsesContentApplicationJsonSchemaMatchesItems Identity_searchIdentities_Response_200: type: object properties: success: type: boolean matches: type: array items: $ref: '#/components/schemas/IdentitySearchPostResponsesContentApplicationJsonSchemaMatchesItems' title: Identity_searchIdentities_Response_200 WatermarkApplyPostParametersPrefer: type: string enum: - wait title: WatermarkApplyPostParametersPrefer WatermarkApplyPostResponsesContentApplicationJsonSchemaItemMediaType: type: string enum: - audio - image - video description: Detected media type of the source file. title: WatermarkApplyPostResponsesContentApplicationJsonSchemaItemMediaType WatermarkApplyPostResponsesContentApplicationJsonSchemaItemMetrics: type: object properties: {} title: WatermarkApplyPostResponsesContentApplicationJsonSchemaItemMetrics WatermarkApplyPostResponsesContentApplicationJsonSchemaItem: type: object properties: uuid: type: string media_type: $ref: '#/components/schemas/WatermarkApplyPostResponsesContentApplicationJsonSchemaItemMediaType' description: Detected media type of the source file. source_media_url: type: string format: uri description: The original source URL provided in the request. watermarked_media: type: - string - 'null' format: uri description: Signed URL to the watermarked file. Populated when processing is complete. metrics: oneOf: - $ref: '#/components/schemas/WatermarkApplyPostResponsesContentApplicationJsonSchemaItemMetrics' - type: 'null' created_at: type: string format: date-time updated_at: type: string format: date-time title: WatermarkApplyPostResponsesContentApplicationJsonSchemaItem Watermark_applyWatermark_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/WatermarkApplyPostResponsesContentApplicationJsonSchemaItem' title: Watermark_applyWatermark_Response_200 WatermarkApplyUuidResultGetResponsesContentApplicationJsonSchemaItemMediaType: type: string enum: - audio - image - video title: WatermarkApplyUuidResultGetResponsesContentApplicationJsonSchemaItemMediaType WatermarkApplyUuidResultGetResponsesContentApplicationJsonSchemaItemMetrics: type: object properties: {} title: WatermarkApplyUuidResultGetResponsesContentApplicationJsonSchemaItemMetrics WatermarkApplyUuidResultGetResponsesContentApplicationJsonSchemaItem: type: object properties: uuid: type: string media_type: $ref: '#/components/schemas/WatermarkApplyUuidResultGetResponsesContentApplicationJsonSchemaItemMediaType' source_media_url: type: string format: uri watermarked_media: type: - string - 'null' format: uri description: Signed URL to the watermarked file. Null while processing. metrics: oneOf: - $ref: '#/components/schemas/WatermarkApplyUuidResultGetResponsesContentApplicationJsonSchemaItemMetrics' - type: 'null' created_at: type: string format: date-time updated_at: type: string format: date-time title: WatermarkApplyUuidResultGetResponsesContentApplicationJsonSchemaItem Watermark_getWatermarkApplyResult_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/WatermarkApplyUuidResultGetResponsesContentApplicationJsonSchemaItem' title: Watermark_getWatermarkApplyResult_Response_200 WatermarkDetectPostParametersPrefer: type: string enum: - wait title: WatermarkDetectPostParametersPrefer WatermarkDetectPostResponsesContentApplicationJsonSchemaItemMediaType: type: string enum: - audio - image - video title: WatermarkDetectPostResponsesContentApplicationJsonSchemaItemMediaType WatermarkDetectPostResponsesContentApplicationJsonSchemaItemMetrics: type: object properties: {} description: Detection results. Null while processing. title: WatermarkDetectPostResponsesContentApplicationJsonSchemaItemMetrics WatermarkDetectPostResponsesContentApplicationJsonSchemaItem: type: object properties: uuid: type: string media_type: $ref: '#/components/schemas/WatermarkDetectPostResponsesContentApplicationJsonSchemaItemMediaType' source_media_url: type: string format: uri metrics: oneOf: - $ref: '#/components/schemas/WatermarkDetectPostResponsesContentApplicationJsonSchemaItemMetrics' - type: 'null' description: Detection results. Null while processing. watermarked_media: type: - string - 'null' created_at: type: string format: date-time updated_at: type: string format: date-time title: WatermarkDetectPostResponsesContentApplicationJsonSchemaItem Watermark_detectWatermark_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/WatermarkDetectPostResponsesContentApplicationJsonSchemaItem' title: Watermark_detectWatermark_Response_200 WatermarkDetectUuidResultGetResponsesContentApplicationJsonSchemaItemMediaType: type: string enum: - audio - image - video title: WatermarkDetectUuidResultGetResponsesContentApplicationJsonSchemaItemMediaType WatermarkDetectUuidResultGetResponsesContentApplicationJsonSchemaItemMetricsHasWatermark: oneOf: - type: object additionalProperties: type: boolean - type: boolean title: WatermarkDetectUuidResultGetResponsesContentApplicationJsonSchemaItemMetricsHasWatermark WatermarkDetectUuidResultGetResponsesContentApplicationJsonSchemaItemMetrics: type: object properties: has_watermark: $ref: >- #/components/schemas/WatermarkDetectUuidResultGetResponsesContentApplicationJsonSchemaItemMetricsHasWatermark description: >- Detection results. For audio, has_watermark is a per-channel object. For image/video, has_watermark is a boolean. title: WatermarkDetectUuidResultGetResponsesContentApplicationJsonSchemaItemMetrics WatermarkDetectUuidResultGetResponsesContentApplicationJsonSchemaItem: type: object properties: uuid: type: string media_type: $ref: '#/components/schemas/WatermarkDetectUuidResultGetResponsesContentApplicationJsonSchemaItemMediaType' source_media_url: type: string format: uri metrics: oneOf: - $ref: '#/components/schemas/WatermarkDetectUuidResultGetResponsesContentApplicationJsonSchemaItemMetrics' - type: 'null' description: >- Detection results. For audio, has_watermark is a per-channel object. For image/video, has_watermark is a boolean. watermarked_media: type: - string - 'null' created_at: type: string format: date-time updated_at: type: string format: date-time title: WatermarkDetectUuidResultGetResponsesContentApplicationJsonSchemaItem Watermark_getWatermarkDetectionResult_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/WatermarkDetectUuidResultGetResponsesContentApplicationJsonSchemaItem' title: Watermark_getWatermarkDetectionResult_Response_200 VoicesGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: {} title: VoicesGetResponsesContentApplicationJsonSchemaItemsItems Voices_listVoices_Response_200: type: object properties: success: type: boolean page: type: integer num_pages: type: integer page_size: type: integer items: type: array items: $ref: '#/components/schemas/VoicesGetResponsesContentApplicationJsonSchemaItemsItems' title: Voices_listVoices_Response_200 VoicesPostRequestBodyContentApplicationJsonSchemaVoiceType: type: string enum: - rapid - professional default: professional title: VoicesPostRequestBodyContentApplicationJsonSchemaVoiceType VoicesPostResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: VoicesPostResponsesContentApplicationJsonSchemaItem Voices_createVoice_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/VoicesPostResponsesContentApplicationJsonSchemaItem' title: Voices_createVoice_Response_200 VoicesVoiceUuidGetResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: VoicesVoiceUuidGetResponsesContentApplicationJsonSchemaItem Voices_getVoice_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/VoicesVoiceUuidGetResponsesContentApplicationJsonSchemaItem' title: Voices_getVoice_Response_200 Voices_deleteVoice_Response_200: type: object properties: success: type: boolean title: Voices_deleteVoice_Response_200 Voices_buildVoice_Response_200: type: object properties: success: type: boolean message: type: string title: Voices_buildVoice_Response_200 VoiceDesignPostResponsesContentApplicationJsonSchemaVoiceCandidatesItems: type: object properties: audio_url: type: string format: uri voice_sample_index: type: integer uuid: type: string title: VoiceDesignPostResponsesContentApplicationJsonSchemaVoiceCandidatesItems Voice Design_generateVoiceDesign_Response_200: type: object properties: voice_candidates: type: array items: $ref: '#/components/schemas/VoiceDesignPostResponsesContentApplicationJsonSchemaVoiceCandidatesItems' title: Voice Design_generateVoiceDesign_Response_200 Voice Design_createVoiceFromCandidate_Response_200: type: object properties: success: type: boolean voice_uuid: type: string title: Voice Design_createVoiceFromCandidate_Response_200 VoicesVoiceUuidRecordingsGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: {} title: VoicesVoiceUuidRecordingsGetResponsesContentApplicationJsonSchemaItemsItems Recordings_listRecordings_Response_200: type: object properties: success: type: boolean items: type: array items: $ref: '#/components/schemas/VoicesVoiceUuidRecordingsGetResponsesContentApplicationJsonSchemaItemsItems' title: Recordings_listRecordings_Response_200 VoicesVoiceUuidRecordingsPostResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: VoicesVoiceUuidRecordingsPostResponsesContentApplicationJsonSchemaItem Recordings_createRecording_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/VoicesVoiceUuidRecordingsPostResponsesContentApplicationJsonSchemaItem' title: Recordings_createRecording_Response_200 VoicesVoiceUuidRecordingsRecordingIdGetResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: VoicesVoiceUuidRecordingsRecordingIdGetResponsesContentApplicationJsonSchemaItem Recordings_getRecording_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/VoicesVoiceUuidRecordingsRecordingIdGetResponsesContentApplicationJsonSchemaItem' title: Recordings_getRecording_Response_200 Recordings_deleteRecording_Response_200: type: object properties: success: type: boolean title: Recordings_deleteRecording_Response_200 VoicesVoiceUuidRecordingsRecordingIdPatchResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: VoicesVoiceUuidRecordingsRecordingIdPatchResponsesContentApplicationJsonSchemaItem Recordings_updateRecording_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/VoicesVoiceUuidRecordingsRecordingIdPatchResponsesContentApplicationJsonSchemaItem' title: Recordings_updateRecording_Response_200 TermSubstitutionsGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: {} title: TermSubstitutionsGetResponsesContentApplicationJsonSchemaItemsItems Term Substitutions_listTermSubstitutions_Response_200: type: object properties: success: type: boolean items: type: array items: $ref: '#/components/schemas/TermSubstitutionsGetResponsesContentApplicationJsonSchemaItemsItems' title: Term Substitutions_listTermSubstitutions_Response_200 TermSubstitutionsPostResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: TermSubstitutionsPostResponsesContentApplicationJsonSchemaItem Term Substitutions_createTermSubstitution_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/TermSubstitutionsPostResponsesContentApplicationJsonSchemaItem' title: Term Substitutions_createTermSubstitution_Response_200 TermSubstitutionsIdGetResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: TermSubstitutionsIdGetResponsesContentApplicationJsonSchemaItem Term Substitutions_getTermSubstitution_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/TermSubstitutionsIdGetResponsesContentApplicationJsonSchemaItem' title: Term Substitutions_getTermSubstitution_Response_200 Term Substitutions_deleteTermSubstitution_Response_200: type: object properties: success: type: boolean title: Term Substitutions_deleteTermSubstitution_Response_200 PronunciationsGetParametersStatus: type: string enum: - pending - ready - failed title: PronunciationsGetParametersStatus CustomPronunciationStatus: type: string enum: - pending - ready - failed description: Processing status. Only "ready" pronunciations are applied during synthesis. title: CustomPronunciationStatus CustomPronunciation: type: object properties: uuid: type: string format: uuid description: Unique identifier for the pronunciation word: type: string description: The word or phrase this pronunciation applies to status: $ref: '#/components/schemas/CustomPronunciationStatus' description: Processing status. Only "ready" pronunciations are applied during synthesis. active: type: boolean description: Whether this pronunciation is active and will be applied during synthesis audio_url: type: string format: uri description: URL to the uploaded reference audio created_at: type: string format: date-time updated_at: type: string format: date-time title: CustomPronunciation Custom Pronunciations_listPronunciations_Response_200: type: object properties: success: type: boolean items: type: array items: $ref: '#/components/schemas/CustomPronunciation' title: Custom Pronunciations_listPronunciations_Response_200 Custom Pronunciations_createPronunciation_Response_201: type: object properties: success: type: boolean item: $ref: '#/components/schemas/CustomPronunciation' title: Custom Pronunciations_createPronunciation_Response_201 PronunciationsBulkPostResponsesContentApplicationJsonSchemaErrorsItems: type: object properties: {} title: PronunciationsBulkPostResponsesContentApplicationJsonSchemaErrorsItems Custom Pronunciations_bulkCreatePronunciations_Response_201: type: object properties: success: type: boolean total_created: type: integer description: Number of pronunciations successfully created total_errors: type: integer description: Number of files that failed validation items: type: array items: $ref: '#/components/schemas/CustomPronunciation' errors: type: array items: $ref: '#/components/schemas/PronunciationsBulkPostResponsesContentApplicationJsonSchemaErrorsItems' title: Custom Pronunciations_bulkCreatePronunciations_Response_201 Custom Pronunciations_getPronunciation_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/CustomPronunciation' title: Custom Pronunciations_getPronunciation_Response_200 Custom Pronunciations_deletePronunciation_Response_200: type: object properties: success: type: boolean title: Custom Pronunciations_deletePronunciation_Response_200 Custom Pronunciations_updatePronunciation_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/CustomPronunciation' title: Custom Pronunciations_updatePronunciation_Response_200 VoiceSettingsPresetsGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: {} title: VoiceSettingsPresetsGetResponsesContentApplicationJsonSchemaItemsItems Voice Settings Presets_listVoiceSettingsPresets_Response_200: type: object properties: success: type: boolean items: type: array items: $ref: '#/components/schemas/VoiceSettingsPresetsGetResponsesContentApplicationJsonSchemaItemsItems' title: Voice Settings Presets_listVoiceSettingsPresets_Response_200 VoiceSettingsPresetsPostResponsesContentApplicationJsonSchemaData: type: object properties: {} title: VoiceSettingsPresetsPostResponsesContentApplicationJsonSchemaData Voice Settings Presets_createVoiceSettingsPreset_Response_201: type: object properties: success: type: boolean data: $ref: '#/components/schemas/VoiceSettingsPresetsPostResponsesContentApplicationJsonSchemaData' message: type: string title: Voice Settings Presets_createVoiceSettingsPreset_Response_201 VoiceSettingsPresetsUuidGetResponsesContentApplicationJsonSchemaData: type: object properties: {} title: VoiceSettingsPresetsUuidGetResponsesContentApplicationJsonSchemaData Voice Settings Presets_getVoiceSettingsPreset_Response_200: type: object properties: success: type: boolean data: $ref: '#/components/schemas/VoiceSettingsPresetsUuidGetResponsesContentApplicationJsonSchemaData' title: Voice Settings Presets_getVoiceSettingsPreset_Response_200 Voice Settings Presets_deleteVoiceSettingsPreset_Response_200: type: object properties: success: type: boolean title: Voice Settings Presets_deleteVoiceSettingsPreset_Response_200 VoiceSettingsPresetsUuidPatchResponsesContentApplicationJsonSchemaData: type: object properties: {} title: VoiceSettingsPresetsUuidPatchResponsesContentApplicationJsonSchemaData Voice Settings Presets_updateVoiceSettingsPreset_Response_200: type: object properties: success: type: boolean data: $ref: '#/components/schemas/VoiceSettingsPresetsUuidPatchResponsesContentApplicationJsonSchemaData' title: Voice Settings Presets_updateVoiceSettingsPreset_Response_200 ProjectsGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: {} title: ProjectsGetResponsesContentApplicationJsonSchemaItemsItems Projects_listProjects_Response_200: type: object properties: success: type: boolean items: type: array items: $ref: '#/components/schemas/ProjectsGetResponsesContentApplicationJsonSchemaItemsItems' title: Projects_listProjects_Response_200 ProjectsPostResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: ProjectsPostResponsesContentApplicationJsonSchemaItem Projects_createProject_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/ProjectsPostResponsesContentApplicationJsonSchemaItem' title: Projects_createProject_Response_200 ProjectsProjectUuidGetResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: ProjectsProjectUuidGetResponsesContentApplicationJsonSchemaItem Projects_getProject_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/ProjectsProjectUuidGetResponsesContentApplicationJsonSchemaItem' title: Projects_getProject_Response_200 ProjectsProjectUuidPutResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: ProjectsProjectUuidPutResponsesContentApplicationJsonSchemaItem Projects_updateProject_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/ProjectsProjectUuidPutResponsesContentApplicationJsonSchemaItem' title: Projects_updateProject_Response_200 Projects_deleteProject_Response_200: type: object properties: success: type: boolean title: Projects_deleteProject_Response_200 ProjectsProjectUuidClipsGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: {} title: ProjectsProjectUuidClipsGetResponsesContentApplicationJsonSchemaItemsItems Clips_listClips_Response_200: type: object properties: success: type: boolean items: type: array items: $ref: '#/components/schemas/ProjectsProjectUuidClipsGetResponsesContentApplicationJsonSchemaItemsItems' title: Clips_listClips_Response_200 ProjectsProjectUuidClipsClipUuidGetResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: ProjectsProjectUuidClipsClipUuidGetResponsesContentApplicationJsonSchemaItem Clips_getClip_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/ProjectsProjectUuidClipsClipUuidGetResponsesContentApplicationJsonSchemaItem' title: Clips_getClip_Response_200 Clips_deleteClip_Response_200: type: object properties: success: type: boolean title: Clips_deleteClip_Response_200 ProjectsProjectUuidClipsClipUuidPatchResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: ProjectsProjectUuidClipsClipUuidPatchResponsesContentApplicationJsonSchemaItem Clips_updateClip_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/ProjectsProjectUuidClipsClipUuidPatchResponsesContentApplicationJsonSchemaItem' title: Clips_updateClip_Response_200 AccountGetResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: AccountGetResponsesContentApplicationJsonSchemaItem Account_getAccount_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/AccountGetResponsesContentApplicationJsonSchemaItem' title: Account_getAccount_Response_200 AccountTeamsGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: {} title: AccountTeamsGetResponsesContentApplicationJsonSchemaItemsItems Account_getTeams_Response_200: type: object properties: success: type: boolean items: type: array items: $ref: '#/components/schemas/AccountTeamsGetResponsesContentApplicationJsonSchemaItemsItems' title: Account_getTeams_Response_200 AccountTeamsTeamUuidGetResponsesContentApplicationJsonSchemaItem: type: object properties: uuid: type: string format: uuid name: type: string plan: type: string voice_limit: type: integer units: type: string rate: type: number format: double current_usage: type: integer title: AccountTeamsTeamUuidGetResponsesContentApplicationJsonSchemaItem Account_getTeam_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/AccountTeamsTeamUuidGetResponsesContentApplicationJsonSchemaItem' title: Account_getTeam_Response_200 AccountBillingUsageGetResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: AccountBillingUsageGetResponsesContentApplicationJsonSchemaItem Account_getBillingUsage_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/AccountBillingUsageGetResponsesContentApplicationJsonSchemaItem' title: Account_getBillingUsage_Response_200 DuetVoicesGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: {} title: DuetVoicesGetResponsesContentApplicationJsonSchemaItemsItems Duets_listDuetVoices_Response_200: type: object properties: success: type: boolean items: type: array items: $ref: '#/components/schemas/DuetVoicesGetResponsesContentApplicationJsonSchemaItemsItems' title: Duets_listDuetVoices_Response_200 DuetVoicesPostResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: DuetVoicesPostResponsesContentApplicationJsonSchemaItem Duets_createDuetVoice_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/DuetVoicesPostResponsesContentApplicationJsonSchemaItem' title: Duets_createDuetVoice_Response_200 DuetVoicesIdPutResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: DuetVoicesIdPutResponsesContentApplicationJsonSchemaItem Duets_updateDuetVoice_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/DuetVoicesIdPutResponsesContentApplicationJsonSchemaItem' title: Duets_updateDuetVoice_Response_200 Duets_deleteDuetVoice_Response_200: type: object properties: success: type: boolean title: Duets_deleteDuetVoice_Response_200 DuetVoicePairsGetResponsesContentApplicationJsonSchemaItemsItems: type: object properties: {} title: DuetVoicePairsGetResponsesContentApplicationJsonSchemaItemsItems Duets_listDuetVoicePairs_Response_200: type: object properties: success: type: boolean items: type: array items: $ref: '#/components/schemas/DuetVoicePairsGetResponsesContentApplicationJsonSchemaItemsItems' title: Duets_listDuetVoicePairs_Response_200 DuetVoicePairsPostResponsesContentApplicationJsonSchemaItem: type: object properties: {} title: DuetVoicePairsPostResponsesContentApplicationJsonSchemaItem Duets_createDuetVoicePair_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/DuetVoicePairsPostResponsesContentApplicationJsonSchemaItem' title: Duets_createDuetVoicePair_Response_200 DuetPostRequestBodyContentApplicationJsonSchemaScriptItemsSpeaker: type: string enum: - '0' - '1' description: Speaker index (0 or 1) title: DuetPostRequestBodyContentApplicationJsonSchemaScriptItemsSpeaker DuetPostRequestBodyContentApplicationJsonSchemaScriptItems: type: object properties: speaker: $ref: '#/components/schemas/DuetPostRequestBodyContentApplicationJsonSchemaScriptItemsSpeaker' description: Speaker index (0 or 1) text: type: string description: Text for this speaker required: - speaker - text title: DuetPostRequestBodyContentApplicationJsonSchemaScriptItems DuetPostResponsesContentApplicationJsonSchemaItem: type: object properties: uuid: type: string status: type: string title: DuetPostResponsesContentApplicationJsonSchemaItem Duets_generateDuet_Response_200: type: object properties: success: type: boolean item: $ref: '#/components/schemas/DuetPostResponsesContentApplicationJsonSchemaItem' title: Duets_generateDuet_Response_200 securitySchemes: BearerAuth: type: http scheme: bearer description: API token from https://app.resemble.ai/account/api