{"openapi":"3.1.0","info":{"title":"REST API","version":"1.0.0"},"paths":{"/v1/agent/settings/think/models":{"get":{"operationId":"list","summary":"List Agent Think Models","description":"Retrieves the available think models that can be used for AI agent processing","tags":["subpackage_agent.subpackage_agent/v1.subpackage_agent/v1/settings.subpackage_agent/v1/settings/think.subpackage_agent/v1/settings/think/models"],"responses":{"200":{"description":"List of available think models","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentThinkModelsV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/agents":{"post":{"operationId":"create","summary":"Create an Agent Configuration","description":"Creates a new reusable agent configuration. The `config` field must be a valid JSON string representing the `agent` block of a Settings message. The returned `agent_id` can be passed in place of the full `agent` object in future Settings messages.","tags":["subpackage_voiceAgent.subpackage_voiceAgent/configurations"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Agent configuration created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAgentConfigurationV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"Agent configuration details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAgentConfigurationV1Request"}}}}},"get":{"operationId":"list","summary":"List Agent Configurations","description":"Returns all agent configurations for the specified project. Configurations are returned in their uninterpolated form—template variable placeholders appear as-is rather than with their substituted values.","tags":["subpackage_voiceAgent.subpackage_voiceAgent/configurations"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of agent configurations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAgentConfigurationsV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/agents/{agent_id}":{"get":{"operationId":"get","summary":"Get an Agent Configuration","description":"Returns the specified agent configuration in its uninterpolated form","tags":["subpackage_voiceAgent.subpackage_voiceAgent/configurations"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"agent_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"An agent configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentConfigurationV1"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"operationId":"update","summary":"Update Agent Metadata","description":"Updates the metadata associated with an agent configuration. The config itself is immutable—to change the configuration, delete the existing agent and create a new one.","tags":["subpackage_voiceAgent.subpackage_voiceAgent/configurations"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"agent_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Agent configuration updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentConfigurationV1"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"Updated metadata for the agent configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAgentMetadataV1Request"}}}}},"delete":{"operationId":"delete","summary":"Delete an Agent Configuration","description":"Deletes the specified agent configuration. Deleting an agent configuration can cause a production outage if your service references this agent UUID. Migrate all active sessions to a new configuration before deleting.","tags":["subpackage_voiceAgent.subpackage_voiceAgent/configurations"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"agent_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Agent configuration deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAgentConfigurationV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/agent-variables":{"post":{"operationId":"create","summary":"Create an Agent Variable","description":"Creates a new template variable. Variables follow the `DG_<VARIABLE_NAME>` naming format and can substitute any JSON value in an agent configuration.","tags":["subpackage_voiceAgent.subpackage_voiceAgent/variables"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Agent variable created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentVariableV1"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"Agent variable details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAgentVariableV1Request"}}}}},"get":{"operationId":"list","summary":"List Agent Variables","description":"Returns all template variables for the specified project","tags":["subpackage_voiceAgent.subpackage_voiceAgent/variables"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of agent variables","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAgentVariablesV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/agent-variables/{variable_id}":{"get":{"operationId":"get","summary":"Get an Agent Variable","description":"Returns the specified template variable","tags":["subpackage_voiceAgent.subpackage_voiceAgent/variables"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"variable_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"An agent variable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentVariableV1"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"operationId":"update","summary":"Update an Agent Variable","description":"Updates the value of an existing template variable","tags":["subpackage_voiceAgent.subpackage_voiceAgent/variables"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"variable_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Agent variable updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentVariableV1"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"Updated value for the agent variable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAgentVariableV1Request"}}}}},"delete":{"operationId":"delete","summary":"Delete an Agent Variable","description":"Deletes the specified template variable","tags":["subpackage_voiceAgent.subpackage_voiceAgent/variables"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"variable_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Agent variable deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAgentVariableV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/listen":{"post":{"operationId":"transcribe","summary":"Transcribe and analyze pre-recorded audio and video","description":"Transcribe audio and video using Deepgram's speech-to-text REST API","tags":["subpackage_listen.subpackage_listen/v1.subpackage_listen/v1/media"],"parameters":[{"name":"callback","in":"query","description":"URL to which we'll make the callback request","required":false,"schema":{"type":"string"}},{"name":"callback_method","in":"query","description":"HTTP method by which the callback request will be made","required":false,"schema":{"$ref":"#/components/schemas/V1ListenPostParametersCallbackMethod"}},{"name":"extra","in":"query","description":"Arbitrary key-value pairs that are attached to the API response for usage in downstream processing","required":false,"schema":{"$ref":"#/components/schemas/V1ListenPostParametersExtra"}},{"name":"sentiment","in":"query","description":"Recognizes the sentiment throughout a transcript or text","required":false,"schema":{"type":"boolean","default":false}},{"name":"summarize","in":"query","description":"Summarize content. For Listen API, supports string version option. For Read API, accepts boolean only.","required":false,"schema":{"$ref":"#/components/schemas/V1ListenPostParametersSummarize"}},{"name":"tag","in":"query","description":"Label your requests for the purpose of identification during usage reporting","required":false,"schema":{"$ref":"#/components/schemas/V1ListenPostParametersTag"}},{"name":"topics","in":"query","description":"Detect topics throughout a transcript or text","required":false,"schema":{"type":"boolean","default":false}},{"name":"custom_topic","in":"query","description":"Custom topics you want the model to detect within your input audio or text if present Submit up to `100`.","required":false,"schema":{"$ref":"#/components/schemas/V1ListenPostParametersCustomTopic"}},{"name":"custom_topic_mode","in":"query","description":"Sets how the model will interpret strings submitted to the `custom_topic` param. When `strict`, the model will only return topics submitted using the `custom_topic` param. When `extended`, the model will return its own detected topics in addition to those submitted using the `custom_topic` param","required":false,"schema":{"$ref":"#/components/schemas/V1ListenPostParametersCustomTopicMode"}},{"name":"intents","in":"query","description":"Recognizes speaker intent throughout a transcript or text","required":false,"schema":{"type":"boolean","default":false}},{"name":"custom_intent","in":"query","description":"Custom intents you want the model to detect within your input audio if present","required":false,"schema":{"$ref":"#/components/schemas/V1ListenPostParametersCustomIntent"}},{"name":"custom_intent_mode","in":"query","description":"Sets how the model will interpret intents submitted to the `custom_intent` param. When `strict`, the model will only return intents submitted using the `custom_intent` param. When `extended`, the model will return its own detected intents in the `custom_intent` param.","required":false,"schema":{"$ref":"#/components/schemas/V1ListenPostParametersCustomIntentMode"}},{"name":"detect_entities","in":"query","description":"Identifies and extracts key entities from content in submitted audio","required":false,"schema":{"type":"boolean","default":false}},{"name":"detect_language","in":"query","description":"Identifies the dominant language spoken in submitted audio","required":false,"schema":{"$ref":"#/components/schemas/V1ListenPostParametersDetectLanguage"}},{"name":"diarize","in":"query","description":"Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0","required":false,"schema":{"type":"boolean","default":false}},{"name":"dictation","in":"query","description":"Dictation mode for controlling formatting with dictated speech","required":false,"schema":{"type":"boolean","default":false}},{"name":"encoding","in":"query","description":"Specify the expected encoding of your submitted audio","required":false,"schema":{"$ref":"#/components/schemas/V1ListenPostParametersEncoding"}},{"name":"filler_words","in":"query","description":"Filler Words can help transcribe interruptions in your audio, like \"uh\" and \"um\"","required":false,"schema":{"type":"boolean","default":false}},{"name":"keyterm","in":"query","description":"Key term prompting can boost or suppress specialized terminology and brands. Only compatible with Nova-3","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"keywords","in":"query","description":"Keywords can boost or suppress specialized terminology and brands","required":false,"schema":{"$ref":"#/components/schemas/V1ListenPostParametersKeywords"}},{"name":"language","in":"query","description":"The [BCP-47 language tag](https://tools.ietf.org/html/bcp47) that hints at the primary spoken language. Depending on the Model and API endpoint you choose only certain languages are available","required":false,"schema":{"type":"string","default":"en"}},{"name":"measurements","in":"query","description":"Spoken measurements will be converted to their corresponding abbreviations","required":false,"schema":{"type":"boolean","default":false}},{"name":"model","in":"query","description":"AI model used to process submitted audio","required":false,"schema":{"$ref":"#/components/schemas/V1ListenPostParametersModel"}},{"name":"multichannel","in":"query","description":"Transcribe each audio channel independently","required":false,"schema":{"type":"boolean","default":false}},{"name":"numerals","in":"query","description":"Numerals converts numbers from written format to numerical format","required":false,"schema":{"type":"boolean","default":false}},{"name":"paragraphs","in":"query","description":"Splits audio into paragraphs to improve transcript readability","required":false,"schema":{"type":"boolean","default":false}},{"name":"profanity_filter","in":"query","description":"Profanity Filter looks for recognized profanity and converts it to the nearest recognized non-profane word or removes it from the transcript completely","required":false,"schema":{"type":"boolean","default":false}},{"name":"punctuate","in":"query","description":"Add punctuation and capitalization to the transcript","required":false,"schema":{"type":"boolean","default":false}},{"name":"redact","in":"query","description":"Redaction removes sensitive information from your transcripts","required":false,"schema":{"$ref":"#/components/schemas/V1ListenPostParametersRedact"}},{"name":"replace","in":"query","description":"Search for terms or phrases in submitted audio and replaces them","required":false,"schema":{"$ref":"#/components/schemas/V1ListenPostParametersReplace"}},{"name":"search","in":"query","description":"Search for terms or phrases in submitted audio","required":false,"schema":{"$ref":"#/components/schemas/V1ListenPostParametersSearch"}},{"name":"smart_format","in":"query","description":"Apply formatting to transcript output. When set to true, additional formatting will be applied to transcripts to improve readability","required":false,"schema":{"type":"boolean","default":false}},{"name":"utterances","in":"query","description":"Segments speech into meaningful semantic units","required":false,"schema":{"type":"boolean","default":false}},{"name":"utt_split","in":"query","description":"Seconds to wait before detecting a pause between words in submitted audio","required":false,"schema":{"type":"number","format":"double","default":0.8}},{"name":"version","in":"query","description":"Version of an AI model to use","required":false,"schema":{"$ref":"#/components/schemas/V1ListenPostParametersVersion"}},{"name":"mip_opt_out","in":"query","description":"Opts out requests from the Deepgram Model Improvement Program. Refer to our Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip","required":false,"schema":{"type":"boolean","default":false}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns either transcription results, or a request_id when using a callback.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/listen_v1_media_transcribe_Response_200"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListenV1Response"}}}}},"requestBody":{"description":"Transcribe an audio or video file","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListenV1RequestUrl"}}}}}},"/v1/speak":{"post":{"operationId":"generate","summary":"Text to Speech transformation","description":"Convert text into natural-sounding speech using Deepgram's TTS REST API","tags":["subpackage_speak.subpackage_speak/v1.subpackage_speak/v1/audio"],"parameters":[{"name":"callback","in":"query","description":"URL to which we'll make the callback request","required":false,"schema":{"type":"string"}},{"name":"callback_method","in":"query","description":"HTTP method by which the callback request will be made","required":false,"schema":{"$ref":"#/components/schemas/V1SpeakPostParametersCallbackMethod"}},{"name":"mip_opt_out","in":"query","description":"Opts out requests from the Deepgram Model Improvement Program. Refer to our Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip","required":false,"schema":{"type":"boolean","default":false}},{"name":"tag","in":"query","description":"Label your requests for the purpose of identification during usage reporting","required":false,"schema":{"$ref":"#/components/schemas/V1SpeakPostParametersTag"}},{"name":"bit_rate","in":"query","description":"The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type.","required":false,"schema":{"$ref":"#/components/schemas/V1SpeakPostParametersBitRate"}},{"name":"container","in":"query","description":"Container specifies the file format wrapper for the output audio. The available options depend on the encoding type.","required":false,"schema":{"$ref":"#/components/schemas/V1SpeakPostParametersContainer"}},{"name":"encoding","in":"query","description":"Encoding allows you to specify the expected encoding of your audio output","required":false,"schema":{"$ref":"#/components/schemas/V1SpeakPostParametersEncoding"}},{"name":"model","in":"query","description":"AI model used to process submitted text","required":false,"schema":{"$ref":"#/components/schemas/V1SpeakPostParametersModel"}},{"name":"sample_rate","in":"query","description":"Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable","required":false,"schema":{"$ref":"#/components/schemas/V1SpeakPostParametersSampleRate"}},{"name":"speed","in":"query","description":"Speaking rate multiplier that adjusts the pace of generated speech while preserving natural prosody and voice quality. Not yet supported in all languages.","required":false,"schema":{"type":"number","format":"double","default":1}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful text-to-speech transformation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/speak_v1_audio_generate_Response_200"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"Transform text to speech","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeakV1Request"}}}}}},"/v1/read":{"post":{"operationId":"analyze","summary":"Analyze text content","description":"Analyze text content using Deepgrams text analysis API","tags":["subpackage_read.subpackage_read/v1.subpackage_read/v1/text"],"parameters":[{"name":"callback","in":"query","description":"URL to which we'll make the callback request","required":false,"schema":{"type":"string"}},{"name":"callback_method","in":"query","description":"HTTP method by which the callback request will be made","required":false,"schema":{"$ref":"#/components/schemas/V1ReadPostParametersCallbackMethod"}},{"name":"sentiment","in":"query","description":"Recognizes the sentiment throughout a transcript or text","required":false,"schema":{"type":"boolean","default":false}},{"name":"summarize","in":"query","description":"Summarize content. For Listen API, supports string version option. For Read API, accepts boolean only.","required":false,"schema":{"$ref":"#/components/schemas/V1ReadPostParametersSummarize"}},{"name":"tag","in":"query","description":"Label your requests for the purpose of identification during usage reporting","required":false,"schema":{"$ref":"#/components/schemas/V1ReadPostParametersTag"}},{"name":"topics","in":"query","description":"Detect topics throughout a transcript or text","required":false,"schema":{"type":"boolean","default":false}},{"name":"custom_topic","in":"query","description":"Custom topics you want the model to detect within your input audio or text if present Submit up to `100`.","required":false,"schema":{"$ref":"#/components/schemas/V1ReadPostParametersCustomTopic"}},{"name":"custom_topic_mode","in":"query","description":"Sets how the model will interpret strings submitted to the `custom_topic` param. When `strict`, the model will only return topics submitted using the `custom_topic` param. When `extended`, the model will return its own detected topics in addition to those submitted using the `custom_topic` param","required":false,"schema":{"$ref":"#/components/schemas/V1ReadPostParametersCustomTopicMode"}},{"name":"intents","in":"query","description":"Recognizes speaker intent throughout a transcript or text","required":false,"schema":{"type":"boolean","default":false}},{"name":"custom_intent","in":"query","description":"Custom intents you want the model to detect within your input audio if present","required":false,"schema":{"$ref":"#/components/schemas/V1ReadPostParametersCustomIntent"}},{"name":"custom_intent_mode","in":"query","description":"Sets how the model will interpret intents submitted to the `custom_intent` param. When `strict`, the model will only return intents submitted using the `custom_intent` param. When `extended`, the model will return its own detected intents in the `custom_intent` param.","required":false,"schema":{"$ref":"#/components/schemas/V1ReadPostParametersCustomIntentMode"}},{"name":"language","in":"query","description":"The [BCP-47 language tag](https://tools.ietf.org/html/bcp47) that hints at the primary spoken language. Depending on the Model and API endpoint you choose only certain languages are available","required":false,"schema":{"type":"string","default":"en"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful text analysis","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"Analyze a text file","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadV1Request"}}}}}},"/v1/projects":{"get":{"operationId":"list","summary":"List Projects","description":"Retrieves basic information about the projects associated with the API key","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects"],"parameters":[{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of projects","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProjectsV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}":{"get":{"operationId":"get","summary":"Get a Project","description":"Retrieves information about the specified project","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of results to return per page. Default 10. Range [1,1000]","required":false,"schema":{"type":"number","format":"double","default":10}},{"name":"page","in":"query","description":"Navigate and return the results to retrieve specific portions of information of the response","required":false,"schema":{"type":"number","format":"double"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProjectV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"operationId":"update","summary":"Update a Project","description":"Updates the name or other properties of an existing project","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProjectV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"The name of the project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProjectV1Request"}}}}},"delete":{"operationId":"delete","summary":"Delete a Project","description":"Deletes the specified project","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteProjectV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/leave":{"delete":{"operationId":"leave","summary":"Leave a Project","description":"Removes the authenticated account from the specific project","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully removed account from project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaveProjectV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/models":{"get":{"operationId":"list","summary":"List Project Models","description":"Returns metadata on all the latest models that a specific project has access to, including non-public models","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/models"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"include_outdated","in":"query","description":"returns non-latest versions of models","required":false,"schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of models","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListModelsV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/models/{model_id}":{"get":{"operationId":"get","summary":"Get a Project Model","description":"Returns metadata for a specific model","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/models"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"model_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A model object that can be either STT or TTS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetModelV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/models":{"get":{"operationId":"list","summary":"List Models","description":"Returns metadata on all the latest public models. To retrieve custom models, use Get Project Models.","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/models"],"parameters":[{"name":"include_outdated","in":"query","description":"returns non-latest versions of models","required":false,"schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of models","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListModelsV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/models/{model_id}":{"get":{"operationId":"get","summary":"Get a specific Model","description":"Returns metadata for a specific public model","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/models"],"parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A model object that can be either STT or TTS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetModelV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/keys":{"get":{"operationId":"list","summary":"List Project Keys","description":"Retrieves all API keys associated with the specified project","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/keys"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Only return keys with a specific status","required":false,"schema":{"$ref":"#/components/schemas/V1ProjectsProjectIdKeysGetParametersStatus"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of API keys","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProjectKeysV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"operationId":"create","summary":"Create a Project Key","description":"Creates a new API key with specified settings for the project","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/keys"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"API key created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateKeyV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"API key settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateKeyV1Request"}}}}}},"/v1/projects/{project_id}/keys/{key_id}":{"get":{"operationId":"get","summary":"Get a Project Key","description":"Retrieves information about a specified API key","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/keys"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"key_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A specific API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProjectKeyV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"operationId":"delete","summary":"Delete a Project Key","description":"Deletes an API key for a specific project","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/keys"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"key_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"API key deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteProjectKeyV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/members":{"get":{"operationId":"list","summary":"List Project Members","description":"Retrieves a list of members for a given project","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/members"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of members for a given project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProjectMembersV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/members/{member_id}":{"delete":{"operationId":"delete","summary":"Delete a Project Member","description":"Removes a member from the project using their unique member ID","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/members"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"member_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Delete the specific member from the project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteProjectMemberV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/members/{member_id}/scopes":{"get":{"operationId":"list","summary":"List Project Member Scopes","description":"Retrieves a list of scopes for a specific member","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/members.subpackage_manage/v1/projects/members/scopes"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"member_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of scopes for a specific member","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProjectMemberScopesV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"operationId":"update","summary":"Update Project Member Scopes","description":"Updates the scopes for a specific member","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/members.subpackage_manage/v1/projects/members/scopes"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"member_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Updated the scopes for a specific member","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProjectMemberScopesV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"A scope to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProjectMemberScopesV1Request"}}}}}},"/v1/projects/{project_id}/invites":{"get":{"operationId":"list","summary":"List Project Invites","description":"Generates a list of invites for a specific project","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/members.subpackage_manage/v1/projects/members/invites"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of invites for a specific project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProjectInvitesV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"operationId":"create","summary":"Create a Project Invite","description":"Generates an invite for a specific project","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/members.subpackage_manage/v1/projects/members/invites"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The invite was successfully generated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProjectInviteV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"email to invite to the project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProjectInviteV1Request"}}}}}},"/v1/projects/{project_id}/invites/{email}":{"delete":{"operationId":"delete","summary":"Delete a Project Invite","description":"Deletes an invite for a specific project","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/members.subpackage_manage/v1/projects/members/invites"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"email","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The invite was successfully deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteProjectInviteV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/requests":{"get":{"operationId":"list","summary":"List Project Requests","description":"Generates a list of requests for a specific project","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/requests"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start date of the requested date range. Formats accepted are YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, or YYYY-MM-DDTHH:MM:SS+HH:MM","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"end","in":"query","description":"End date of the requested date range. Formats accepted are YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, or YYYY-MM-DDTHH:MM:SS+HH:MM","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"limit","in":"query","description":"Number of results to return per page. Default 10. Range [1,1000]","required":false,"schema":{"type":"number","format":"double","default":10}},{"name":"page","in":"query","description":"Navigate and return the results to retrieve specific portions of information of the response","required":false,"schema":{"type":"number","format":"double"}},{"name":"accessor","in":"query","description":"Filter for requests where a specific accessor was used","required":false,"schema":{"type":"string"}},{"name":"request_id","in":"query","description":"Filter for a specific request id","required":false,"schema":{"type":"string"}},{"name":"deployment","in":"query","description":"Filter for requests where a specific deployment was used","required":false,"schema":{"$ref":"#/components/schemas/V1ProjectsProjectIdRequestsGetParametersDeployment"}},{"name":"endpoint","in":"query","description":"Filter for requests where a specific endpoint was used","required":false,"schema":{"$ref":"#/components/schemas/V1ProjectsProjectIdRequestsGetParametersEndpoint"}},{"name":"method","in":"query","description":"Filter for requests where a specific method was used","required":false,"schema":{"$ref":"#/components/schemas/V1ProjectsProjectIdRequestsGetParametersMethod"}},{"name":"status","in":"query","description":"Filter for requests that succeeded (status code < 300) or failed (status code >=400)","required":false,"schema":{"$ref":"#/components/schemas/V1ProjectsProjectIdRequestsGetParametersStatus"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of requests for a specific project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProjectRequestsV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/requests/{request_id}":{"get":{"operationId":"get","summary":"Get a Project Request","description":"Retrieves a specific request for a specific project","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/requests"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"request_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A specific request for a specific project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProjectRequestV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/usage":{"get":{"operationId":"get","summary":"Get Project Usage","description":"Retrieves the usage for a specific project. Use Get Project Usage Breakdown for a more comprehensive usage summary.","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/usage"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start date of the requested date range. Format accepted is YYYY-MM-DD","required":false,"schema":{"type":"string","format":"date"}},{"name":"end","in":"query","description":"End date of the requested date range. Format accepted is YYYY-MM-DD","required":false,"schema":{"type":"string","format":"date"}},{"name":"accessor","in":"query","description":"Filter for requests where a specific accessor was used","required":false,"schema":{"type":"string"}},{"name":"alternatives","in":"query","description":"Filter for requests where alternatives were used","required":false,"schema":{"type":"boolean"}},{"name":"callback_method","in":"query","description":"Filter for requests where callback method was used","required":false,"schema":{"type":"boolean"}},{"name":"callback","in":"query","description":"Filter for requests where callback was used","required":false,"schema":{"type":"boolean"}},{"name":"channels","in":"query","description":"Filter for requests where channels were used","required":false,"schema":{"type":"boolean"}},{"name":"custom_intent_mode","in":"query","description":"Filter for requests where custom intent mode was used","required":false,"schema":{"type":"boolean"}},{"name":"custom_intent","in":"query","description":"Filter for requests where custom intent was used","required":false,"schema":{"type":"boolean"}},{"name":"custom_topic_mode","in":"query","description":"Filter for requests where custom topic mode was used","required":false,"schema":{"type":"boolean"}},{"name":"custom_topic","in":"query","description":"Filter for requests where custom topic was used","required":false,"schema":{"type":"boolean"}},{"name":"deployment","in":"query","description":"Filter for requests where a specific deployment was used","required":false,"schema":{"$ref":"#/components/schemas/V1ProjectsProjectIdUsageGetParametersDeployment"}},{"name":"detect_entities","in":"query","description":"Filter for requests where detect entities was used","required":false,"schema":{"type":"boolean"}},{"name":"detect_language","in":"query","description":"Filter for requests where detect language was used","required":false,"schema":{"type":"boolean"}},{"name":"diarize","in":"query","description":"Filter for requests where diarize was used","required":false,"schema":{"type":"boolean"}},{"name":"dictation","in":"query","description":"Filter for requests where dictation was used","required":false,"schema":{"type":"boolean"}},{"name":"encoding","in":"query","description":"Filter for requests where encoding was used","required":false,"schema":{"type":"boolean"}},{"name":"endpoint","in":"query","description":"Filter for requests where a specific endpoint was used","required":false,"schema":{"$ref":"#/components/schemas/V1ProjectsProjectIdUsageGetParametersEndpoint"}},{"name":"extra","in":"query","description":"Filter for requests where extra was used","required":false,"schema":{"type":"boolean"}},{"name":"filler_words","in":"query","description":"Filter for requests where filler words was used","required":false,"schema":{"type":"boolean"}},{"name":"intents","in":"query","description":"Filter for requests where intents was used","required":false,"schema":{"type":"boolean"}},{"name":"keyterm","in":"query","description":"Filter for requests where keyterm was used","required":false,"schema":{"type":"boolean"}},{"name":"keywords","in":"query","description":"Filter for requests where keywords was used","required":false,"schema":{"type":"boolean"}},{"name":"language","in":"query","description":"Filter for requests where language was used","required":false,"schema":{"type":"boolean"}},{"name":"measurements","in":"query","description":"Filter for requests where measurements were used","required":false,"schema":{"type":"boolean"}},{"name":"method","in":"query","description":"Filter for requests where a specific method was used","required":false,"schema":{"$ref":"#/components/schemas/V1ProjectsProjectIdUsageGetParametersMethod"}},{"name":"model","in":"query","description":"Filter for requests where a specific model uuid was used","required":false,"schema":{"type":"string"}},{"name":"multichannel","in":"query","description":"Filter for requests where multichannel was used","required":false,"schema":{"type":"boolean"}},{"name":"numerals","in":"query","description":"Filter for requests where numerals were used","required":false,"schema":{"type":"boolean"}},{"name":"paragraphs","in":"query","description":"Filter for requests where paragraphs were used","required":false,"schema":{"type":"boolean"}},{"name":"profanity_filter","in":"query","description":"Filter for requests where profanity filter was used","required":false,"schema":{"type":"boolean"}},{"name":"punctuate","in":"query","description":"Filter for requests where punctuate was used","required":false,"schema":{"type":"boolean"}},{"name":"redact","in":"query","description":"Filter for requests where redact was used","required":false,"schema":{"type":"boolean"}},{"name":"replace","in":"query","description":"Filter for requests where replace was used","required":false,"schema":{"type":"boolean"}},{"name":"sample_rate","in":"query","description":"Filter for requests where sample rate was used","required":false,"schema":{"type":"boolean"}},{"name":"search","in":"query","description":"Filter for requests where search was used","required":false,"schema":{"type":"boolean"}},{"name":"sentiment","in":"query","description":"Filter for requests where sentiment was used","required":false,"schema":{"type":"boolean"}},{"name":"smart_format","in":"query","description":"Filter for requests where smart format was used","required":false,"schema":{"type":"boolean"}},{"name":"summarize","in":"query","description":"Filter for requests where summarize was used","required":false,"schema":{"type":"boolean"}},{"name":"tag","in":"query","description":"Filter for requests where a specific tag was used","required":false,"schema":{"type":"string"}},{"name":"topics","in":"query","description":"Filter for requests where topics was used","required":false,"schema":{"type":"boolean"}},{"name":"utt_split","in":"query","description":"Filter for requests where utt split was used","required":false,"schema":{"type":"boolean"}},{"name":"utterances","in":"query","description":"Filter for requests where utterances was used","required":false,"schema":{"type":"boolean"}},{"name":"version","in":"query","description":"Filter for requests where version was used","required":false,"schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A specific request for a specific project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/usage/fields":{"get":{"operationId":"list","summary":"List Project Usage Fields","description":"Lists the features, models, tags, languages, and processing method used for requests in the specified project","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/usage.subpackage_manage/v1/projects/usage/fields"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start date of the requested date range. Format accepted is YYYY-MM-DD","required":false,"schema":{"type":"string","format":"date"}},{"name":"end","in":"query","description":"End date of the requested date range. Format accepted is YYYY-MM-DD","required":false,"schema":{"type":"string","format":"date"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of fields for a specific project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageFieldsV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/usage/breakdown":{"get":{"operationId":"get","summary":"Get Project Usage Breakdown","description":"Retrieves the usage breakdown for a specific project, with various filter options by API feature or by groupings. Setting a feature (e.g. diarize) to true includes requests that used that feature, while false excludes requests that used it. Multiple true filters are combined with OR logic, while false filters use AND logic.","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/usage.subpackage_manage/v1/projects/usage/breakdown"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start date of the requested date range. Format accepted is YYYY-MM-DD","required":false,"schema":{"type":"string","format":"date"}},{"name":"end","in":"query","description":"End date of the requested date range. Format accepted is YYYY-MM-DD","required":false,"schema":{"type":"string","format":"date"}},{"name":"grouping","in":"query","description":"Common usage grouping parameters","required":false,"schema":{"$ref":"#/components/schemas/V1ProjectsProjectIdUsageBreakdownGetParametersGrouping"}},{"name":"accessor","in":"query","description":"Filter for requests where a specific accessor was used","required":false,"schema":{"type":"string"}},{"name":"alternatives","in":"query","description":"Filter for requests where alternatives were used","required":false,"schema":{"type":"boolean"}},{"name":"callback_method","in":"query","description":"Filter for requests where callback method was used","required":false,"schema":{"type":"boolean"}},{"name":"callback","in":"query","description":"Filter for requests where callback was used","required":false,"schema":{"type":"boolean"}},{"name":"channels","in":"query","description":"Filter for requests where channels were used","required":false,"schema":{"type":"boolean"}},{"name":"custom_intent_mode","in":"query","description":"Filter for requests where custom intent mode was used","required":false,"schema":{"type":"boolean"}},{"name":"custom_intent","in":"query","description":"Filter for requests where custom intent was used","required":false,"schema":{"type":"boolean"}},{"name":"custom_topic_mode","in":"query","description":"Filter for requests where custom topic mode was used","required":false,"schema":{"type":"boolean"}},{"name":"custom_topic","in":"query","description":"Filter for requests where custom topic was used","required":false,"schema":{"type":"boolean"}},{"name":"deployment","in":"query","description":"Filter for requests where a specific deployment was used","required":false,"schema":{"$ref":"#/components/schemas/V1ProjectsProjectIdUsageBreakdownGetParametersDeployment"}},{"name":"detect_entities","in":"query","description":"Filter for requests where detect entities was used","required":false,"schema":{"type":"boolean"}},{"name":"detect_language","in":"query","description":"Filter for requests where detect language was used","required":false,"schema":{"type":"boolean"}},{"name":"diarize","in":"query","description":"Filter for requests where diarize was used","required":false,"schema":{"type":"boolean"}},{"name":"dictation","in":"query","description":"Filter for requests where dictation was used","required":false,"schema":{"type":"boolean"}},{"name":"encoding","in":"query","description":"Filter for requests where encoding was used","required":false,"schema":{"type":"boolean"}},{"name":"endpoint","in":"query","description":"Filter for requests where a specific endpoint was used","required":false,"schema":{"$ref":"#/components/schemas/V1ProjectsProjectIdUsageBreakdownGetParametersEndpoint"}},{"name":"extra","in":"query","description":"Filter for requests where extra was used","required":false,"schema":{"type":"boolean"}},{"name":"filler_words","in":"query","description":"Filter for requests where filler words was used","required":false,"schema":{"type":"boolean"}},{"name":"intents","in":"query","description":"Filter for requests where intents was used","required":false,"schema":{"type":"boolean"}},{"name":"keyterm","in":"query","description":"Filter for requests where keyterm was used","required":false,"schema":{"type":"boolean"}},{"name":"keywords","in":"query","description":"Filter for requests where keywords was used","required":false,"schema":{"type":"boolean"}},{"name":"language","in":"query","description":"Filter for requests where language was used","required":false,"schema":{"type":"boolean"}},{"name":"measurements","in":"query","description":"Filter for requests where measurements were used","required":false,"schema":{"type":"boolean"}},{"name":"method","in":"query","description":"Filter for requests where a specific method was used","required":false,"schema":{"$ref":"#/components/schemas/V1ProjectsProjectIdUsageBreakdownGetParametersMethod"}},{"name":"model","in":"query","description":"Filter for requests where a specific model uuid was used","required":false,"schema":{"type":"string"}},{"name":"multichannel","in":"query","description":"Filter for requests where multichannel was used","required":false,"schema":{"type":"boolean"}},{"name":"numerals","in":"query","description":"Filter for requests where numerals were used","required":false,"schema":{"type":"boolean"}},{"name":"paragraphs","in":"query","description":"Filter for requests where paragraphs were used","required":false,"schema":{"type":"boolean"}},{"name":"profanity_filter","in":"query","description":"Filter for requests where profanity filter was used","required":false,"schema":{"type":"boolean"}},{"name":"punctuate","in":"query","description":"Filter for requests where punctuate was used","required":false,"schema":{"type":"boolean"}},{"name":"redact","in":"query","description":"Filter for requests where redact was used","required":false,"schema":{"type":"boolean"}},{"name":"replace","in":"query","description":"Filter for requests where replace was used","required":false,"schema":{"type":"boolean"}},{"name":"sample_rate","in":"query","description":"Filter for requests where sample rate was used","required":false,"schema":{"type":"boolean"}},{"name":"search","in":"query","description":"Filter for requests where search was used","required":false,"schema":{"type":"boolean"}},{"name":"sentiment","in":"query","description":"Filter for requests where sentiment was used","required":false,"schema":{"type":"boolean"}},{"name":"smart_format","in":"query","description":"Filter for requests where smart format was used","required":false,"schema":{"type":"boolean"}},{"name":"summarize","in":"query","description":"Filter for requests where summarize was used","required":false,"schema":{"type":"boolean"}},{"name":"tag","in":"query","description":"Filter for requests where a specific tag was used","required":false,"schema":{"type":"string"}},{"name":"topics","in":"query","description":"Filter for requests where topics was used","required":false,"schema":{"type":"boolean"}},{"name":"utt_split","in":"query","description":"Filter for requests where utt split was used","required":false,"schema":{"type":"boolean"}},{"name":"utterances","in":"query","description":"Filter for requests where utterances was used","required":false,"schema":{"type":"boolean"}},{"name":"version","in":"query","description":"Filter for requests where version was used","required":false,"schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Usage breakdown response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageBreakdownV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/balances":{"get":{"operationId":"list","summary":"Get Project Balances","description":"Generates a list of outstanding balances for the specified project","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/billing.subpackage_manage/v1/projects/billing/balances"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of outstanding balances","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProjectBalancesV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/balances/{balance_id}":{"get":{"operationId":"get","summary":"Get a Project Balance","description":"Retrieves details about the specified balance","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/billing.subpackage_manage/v1/projects/billing/balances"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"balance_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A specific balance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProjectBalanceV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/billing/breakdown":{"get":{"operationId":"list","summary":"Get Project Billing Breakdown","description":"Retrieves the billing summary for a specific project, with various filter options or by grouping options.","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/billing.subpackage_manage/v1/projects/billing/breakdown"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start date of the requested date range. Format accepted is YYYY-MM-DD","required":false,"schema":{"type":"string","format":"date"}},{"name":"end","in":"query","description":"End date of the requested date range. Format accepted is YYYY-MM-DD","required":false,"schema":{"type":"string","format":"date"}},{"name":"accessor","in":"query","description":"Filter for requests where a specific accessor was used","required":false,"schema":{"type":"string"}},{"name":"deployment","in":"query","description":"Filter for requests where a specific deployment was used","required":false,"schema":{"$ref":"#/components/schemas/V1ProjectsProjectIdBillingBreakdownGetParametersDeployment"}},{"name":"tag","in":"query","description":"Filter for requests where a specific tag was used","required":false,"schema":{"type":"string"}},{"name":"line_item","in":"query","description":"Filter requests by line item (e.g. streaming::nova-3)","required":false,"schema":{"type":"string"}},{"name":"grouping","in":"query","description":"Group billing breakdown by one or more dimensions (accessor, deployment, line_item, tags)","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/V1ProjectsProjectIdBillingBreakdownGetParametersGroupingSchemaItems"}}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Billing breakdown response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingBreakdownV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/billing/fields":{"get":{"operationId":"list","summary":"List Project Billing Fields","description":"Lists the accessors, deployment types, tags, and line items used for billing data in the specified time period. Use this endpoint if you want to filter your results from the Billing Breakdown endpoint and want to know what filters are available.","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/billing.subpackage_manage/v1/projects/billing/fields"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start date of the requested date range. Format accepted is YYYY-MM-DD","required":false,"schema":{"type":"string","format":"date"}},{"name":"end","in":"query","description":"End date of the requested date range. Format accepted is YYYY-MM-DD","required":false,"schema":{"type":"string","format":"date"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of billing fields for a specific project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBillingFieldsV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/purchases":{"get":{"operationId":"list","summary":"List Project Purchases","description":"Returns the original purchased amount on an order transaction","tags":["subpackage_manage.subpackage_manage/v1.subpackage_manage/v1/projects.subpackage_manage/v1/projects/billing.subpackage_manage/v1/projects/billing/purchases"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of results to return per page. Default 10. Range [1,1000]","required":false,"schema":{"type":"number","format":"double","default":10}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of purchases for a specific project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProjectPurchasesV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/projects/{project_id}/self-hosted/distribution/credentials":{"get":{"operationId":"list","summary":"List Project Self-Hosted Distribution Credentials","description":"Lists sets of distribution credentials for the specified project","tags":["subpackage_selfHosted.subpackage_selfHosted/v1.subpackage_selfHosted/v1/distributionCredentials"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of distribution credentials for a specific project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProjectDistributionCredentialsV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"operationId":"create","summary":"Create a Project Self-Hosted Distribution Credential","description":"Creates a set of distribution credentials for the specified project","tags":["subpackage_selfHosted.subpackage_selfHosted/v1.subpackage_selfHosted/v1/distributionCredentials"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"scopes","in":"query","description":"List of permission scopes for the credentials","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/V1ProjectsProjectIdSelfHostedDistributionCredentialsPostParametersScopesSchemaItems"}}},{"name":"provider","in":"query","description":"The provider of the distribution service","required":false,"schema":{"$ref":"#/components/schemas/V1ProjectsProjectIdSelfHostedDistributionCredentialsPostParametersProvider"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Single distribution credential","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProjectDistributionCredentialsV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"The set of distribution credentials to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProjectDistributionCredentialsV1Request"}}}}}},"/v1/projects/{project_id}/self-hosted/distribution/credentials/{distribution_credentials_id}":{"get":{"operationId":"get","summary":"Get a Project Self-Hosted Distribution Credential","description":"Returns a set of distribution credentials for the specified project","tags":["subpackage_selfHosted.subpackage_selfHosted/v1.subpackage_selfHosted/v1/distributionCredentials"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"distribution_credentials_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Single distribution credential","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProjectDistributionCredentialsV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"operationId":"delete","summary":"Delete a Project Self-Hosted Distribution Credential","description":"Deletes a set of distribution credentials for the specified project","tags":["subpackage_selfHosted.subpackage_selfHosted/v1.subpackage_selfHosted/v1/distributionCredentials"],"parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"distribution_credentials_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Single distribution credential","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProjectDistributionCredentialsV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/auth/grant":{"post":{"operationId":"grant","summary":"Token-based Authentication","description":"Generates a temporary JSON Web Token (JWT) with a 30-second (by default) TTL and usage::write permission for core voice APIs, requiring an API key with Member or higher authorization. Tokens created with this endpoint will not work with the Manage APIs.","tags":["subpackage_auth.subpackage_auth/v1.subpackage_auth/v1/tokens"],"parameters":[{"name":"Authorization","in":"header","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Grant response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantV1Response"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"Time to live settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantV1Request"}}}}}}},"servers":[{"url":"https://api.deepgram.com"},{"url":"https://agent.deepgram.com"}],"components":{"schemas":{"AgentThinkModelsV1ResponseModelsItemsOneOf0Id":{"type":"string","enum":["gpt-5","gpt-5-mini","gpt-5-nano","gpt-4.1","gpt-4.1-mini","gpt-4.1-nano","gpt-4o","gpt-4o-mini"],"description":"The unique identifier of the OpenAI model","title":"AgentThinkModelsV1ResponseModelsItemsOneOf0Id"},"AgentThinkModelsV1ResponseModelsItems0":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AgentThinkModelsV1ResponseModelsItemsOneOf0Id","description":"The unique identifier of the OpenAI model"},"name":{"type":"string","description":"The display name of the model"},"provider":{"description":"The provider of the model"}},"required":["id","name","provider"],"description":"OpenAI models","title":"AgentThinkModelsV1ResponseModelsItems0"},"AgentThinkModelsV1ResponseModelsItemsOneOf1Id":{"type":"string","enum":["claude-3-5-haiku-latest","claude-sonnet-4-20250514"],"description":"The unique identifier of the Anthropic model","title":"AgentThinkModelsV1ResponseModelsItemsOneOf1Id"},"AgentThinkModelsV1ResponseModelsItems1":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AgentThinkModelsV1ResponseModelsItemsOneOf1Id","description":"The unique identifier of the Anthropic model"},"name":{"type":"string","description":"The display name of the model"},"provider":{"description":"The provider of the model"}},"required":["id","name","provider"],"description":"Anthropic models","title":"AgentThinkModelsV1ResponseModelsItems1"},"AgentThinkModelsV1ResponseModelsItemsOneOf2Id":{"type":"string","enum":["gemini-2.5-flash","gemini-2.0-flash","gemini-2.0-flash-lite"],"description":"The unique identifier of the Google model","title":"AgentThinkModelsV1ResponseModelsItemsOneOf2Id"},"AgentThinkModelsV1ResponseModelsItems2":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AgentThinkModelsV1ResponseModelsItemsOneOf2Id","description":"The unique identifier of the Google model"},"name":{"type":"string","description":"The display name of the model"},"provider":{"description":"The provider of the model"}},"required":["id","name","provider"],"description":"Google models","title":"AgentThinkModelsV1ResponseModelsItems2"},"AgentThinkModelsV1ResponseModelsItemsOneOf3Id":{"type":"string","enum":["openai/gpt-oss-20b"],"description":"The unique identifier of the Groq model","title":"AgentThinkModelsV1ResponseModelsItemsOneOf3Id"},"AgentThinkModelsV1ResponseModelsItems3":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AgentThinkModelsV1ResponseModelsItemsOneOf3Id","description":"The unique identifier of the Groq model"},"name":{"type":"string","description":"The display name of the model"},"provider":{"description":"The provider of the model"}},"required":["id","name","provider"],"description":"Groq models","title":"AgentThinkModelsV1ResponseModelsItems3"},"AgentThinkModelsV1ResponseModelsItems4":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the AWS Bedrock model (any model string accepted for BYO LLMs)"},"name":{"type":"string","description":"The display name of the model"},"provider":{"description":"The provider of the model"}},"required":["id","name","provider"],"description":"AWS Bedrock models (custom models accepted)","title":"AgentThinkModelsV1ResponseModelsItems4"},"AgentThinkModelsV1ResponseModelsItems":{"oneOf":[{"$ref":"#/components/schemas/AgentThinkModelsV1ResponseModelsItems0"},{"$ref":"#/components/schemas/AgentThinkModelsV1ResponseModelsItems1"},{"$ref":"#/components/schemas/AgentThinkModelsV1ResponseModelsItems2"},{"$ref":"#/components/schemas/AgentThinkModelsV1ResponseModelsItems3"},{"$ref":"#/components/schemas/AgentThinkModelsV1ResponseModelsItems4"}],"title":"AgentThinkModelsV1ResponseModelsItems"},"AgentThinkModelsV1Response":{"type":"object","properties":{"models":{"type":"array","items":{"$ref":"#/components/schemas/AgentThinkModelsV1ResponseModelsItems"}}},"required":["models"],"title":"AgentThinkModelsV1Response"},"ErrorResponseTextError":{"type":"string","title":"ErrorResponseTextError"},"ErrorResponseLegacyError":{"type":"object","properties":{"err_code":{"type":"string","description":"The error code"},"err_msg":{"type":"string","description":"The error message"},"request_id":{"type":"string","description":"The request ID"}},"title":"ErrorResponseLegacyError"},"ErrorResponseModernError":{"type":"object","properties":{"category":{"type":"string","description":"The category of the error"},"message":{"type":"string","description":"A message about the error"},"details":{"type":"string","description":"A description of the error"},"request_id":{"type":"string","description":"The unique identifier of the request"}},"title":"ErrorResponseModernError"},"ErrorResponse":{"oneOf":[{"$ref":"#/components/schemas/ErrorResponseTextError"},{"$ref":"#/components/schemas/ErrorResponseLegacyError"},{"$ref":"#/components/schemas/ErrorResponseModernError"}],"title":"ErrorResponse"},"CreateAgentConfigurationV1Request":{"type":"object","properties":{"config":{"type":"string","description":"A valid JSON string representing the agent block of a Settings message"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"A map of arbitrary key-value pairs for labeling or organizing the agent configuration"},"api_version":{"type":"integer","default":1,"description":"API version. Defaults to 1"}},"required":["config"],"description":"Request body for creating an agent configuration","title":"CreateAgentConfigurationV1Request"},"CreateAgentConfigurationV1ResponseConfig":{"type":"object","properties":{},"description":"The parsed agent configuration object","title":"CreateAgentConfigurationV1ResponseConfig"},"CreateAgentConfigurationV1Response":{"type":"object","properties":{"agent_id":{"type":"string","description":"The unique identifier of the newly created agent configuration"},"config":{"$ref":"#/components/schemas/CreateAgentConfigurationV1ResponseConfig","description":"The parsed agent configuration object"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Metadata associated with the agent configuration"}},"required":["agent_id","config"],"title":"CreateAgentConfigurationV1Response"},"AgentConfigurationV1Config":{"type":"object","properties":{},"description":"The agent configuration object","title":"AgentConfigurationV1Config"},"AgentConfigurationV1":{"type":"object","properties":{"agent_id":{"type":"string","description":"The unique identifier of the agent configuration"},"config":{"$ref":"#/components/schemas/AgentConfigurationV1Config","description":"The agent configuration object"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"A map of arbitrary key-value pairs for labeling or organizing the agent configuration"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the configuration was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the configuration was last updated"}},"required":["agent_id","config"],"description":"A reusable agent configuration","title":"AgentConfigurationV1"},"ListAgentConfigurationsV1Response":{"type":"object","properties":{"agents":{"type":"array","items":{"$ref":"#/components/schemas/AgentConfigurationV1"},"description":"A list of agent configurations for the project"}},"title":"ListAgentConfigurationsV1Response"},"UpdateAgentMetadataV1Request":{"type":"object","properties":{"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"A map of string key-value pairs to associate with this agent configuration"}},"required":["metadata"],"description":"Request body for updating agent configuration metadata","title":"UpdateAgentMetadataV1Request"},"DeleteAgentConfigurationV1Response":{"type":"object","properties":{},"description":"Confirmation that the agent configuration was deleted","title":"DeleteAgentConfigurationV1Response"},"CreateAgentVariableV1Request":{"type":"object","properties":{"key":{"type":"string","description":"The variable name, following the DG_<VARIABLE_NAME> format"},"value":{"description":"The value to substitute. Can be any valid JSON type (string, number, boolean, object, or array)"},"api_version":{"type":"integer","default":1,"description":"API version. Defaults to 1"}},"required":["key","value"],"description":"Request body for creating an agent variable","title":"CreateAgentVariableV1Request"},"AgentVariableV1":{"type":"object","properties":{"variable_id":{"type":"string","description":"The unique identifier of the variable"},"key":{"type":"string","description":"The variable name, following the DG_<VARIABLE_NAME> format"},"value":{"description":"The value to substitute. Can be any valid JSON type"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the variable was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the variable was last updated"}},"required":["variable_id","key","value"],"description":"A template variable for agent configurations","title":"AgentVariableV1"},"ListAgentVariablesV1Response":{"type":"object","properties":{"variables":{"type":"array","items":{"$ref":"#/components/schemas/AgentVariableV1"},"description":"A list of agent variables for the project"}},"title":"ListAgentVariablesV1Response"},"UpdateAgentVariableV1Request":{"type":"object","properties":{"value":{"description":"The new value to substitute"}},"required":["value"],"description":"Request body for updating an agent variable","title":"UpdateAgentVariableV1Request"},"DeleteAgentVariableV1Response":{"type":"object","properties":{},"description":"Confirmation that the agent variable was deleted","title":"DeleteAgentVariableV1Response"},"V1ListenPostParametersCallbackMethod":{"type":"string","enum":["POST","PUT"],"default":"POST","title":"V1ListenPostParametersCallbackMethod"},"V1ListenPostParametersExtra":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"title":"V1ListenPostParametersExtra"},"V1ListenPostParametersSummarize0":{"type":"string","enum":["v2"],"title":"V1ListenPostParametersSummarize0"},"V1ListenPostParametersSummarize":{"oneOf":[{"$ref":"#/components/schemas/V1ListenPostParametersSummarize0"},{"type":"boolean","default":false}],"title":"V1ListenPostParametersSummarize"},"V1ListenPostParametersTag":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"title":"V1ListenPostParametersTag"},"V1ListenPostParametersCustomTopic":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"title":"V1ListenPostParametersCustomTopic"},"V1ListenPostParametersCustomTopicMode":{"type":"string","enum":["extended","strict"],"default":"extended","title":"V1ListenPostParametersCustomTopicMode"},"V1ListenPostParametersCustomIntent":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"title":"V1ListenPostParametersCustomIntent"},"V1ListenPostParametersCustomIntentMode":{"type":"string","enum":["extended","strict"],"default":"extended","title":"V1ListenPostParametersCustomIntentMode"},"V1ListenPostParametersDetectLanguage":{"oneOf":[{"type":"boolean","default":false},{"type":"array","items":{"type":"string"}}],"title":"V1ListenPostParametersDetectLanguage"},"V1ListenPostParametersEncoding":{"type":"string","enum":["linear16","flac","mulaw","amr-nb","amr-wb","opus","speex","g729"],"title":"V1ListenPostParametersEncoding"},"V1ListenPostParametersKeywords":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"title":"V1ListenPostParametersKeywords"},"V1ListenPostParametersModel0":{"type":"string","enum":["nova-3","nova-3-general","nova-3-medical","nova-2","nova-2-general","nova-2-meeting","nova-2-finance","nova-2-conversationalai","nova-2-voicemail","nova-2-video","nova-2-medical","nova-2-drivethru","nova-2-automotive","nova","nova-general","nova-phonecall","nova-medical","enhanced","enhanced-general","enhanced-meeting","enhanced-phonecall","enhanced-finance","base","meeting","phonecall","finance","conversationalai","voicemail","video"],"description":"Our public models available to all accounts","title":"V1ListenPostParametersModel0"},"V1ListenPostParametersModel":{"oneOf":[{"$ref":"#/components/schemas/V1ListenPostParametersModel0"},{"type":"string"}],"title":"V1ListenPostParametersModel"},"V1ListenPostParametersRedactSchemaOneOf1Items":{"type":"string","enum":["pci","pii","numbers"],"title":"V1ListenPostParametersRedactSchemaOneOf1Items"},"V1ListenPostParametersRedact1":{"type":"array","items":{"$ref":"#/components/schemas/V1ListenPostParametersRedactSchemaOneOf1Items"},"title":"V1ListenPostParametersRedact1"},"V1ListenPostParametersRedact":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/V1ListenPostParametersRedact1"}],"title":"V1ListenPostParametersRedact"},"V1ListenPostParametersReplace":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"title":"V1ListenPostParametersReplace"},"V1ListenPostParametersSearch":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"title":"V1ListenPostParametersSearch"},"V1ListenPostParametersVersion0":{"type":"string","enum":["latest"],"description":"Use the latest version of a model","title":"V1ListenPostParametersVersion0"},"V1ListenPostParametersVersion":{"oneOf":[{"$ref":"#/components/schemas/V1ListenPostParametersVersion0"},{"type":"string"}],"title":"V1ListenPostParametersVersion"},"ListenV1RequestUrl":{"type":"object","properties":{"url":{"type":"string","format":"uri"}},"required":["url"],"description":"Audio file URL to transcribe","title":"ListenV1RequestUrl"},"ListenV1ResponseMetadataModelInfo":{"type":"object","properties":{},"title":"ListenV1ResponseMetadataModelInfo"},"ListenV1ResponseMetadataSummaryInfo":{"type":"object","properties":{"model_uuid":{"type":"string"},"input_tokens":{"type":"integer"},"output_tokens":{"type":"integer"}},"title":"ListenV1ResponseMetadataSummaryInfo"},"ListenV1ResponseMetadataSentimentInfo":{"type":"object","properties":{"model_uuid":{"type":"string"},"input_tokens":{"type":"integer"},"output_tokens":{"type":"integer"}},"title":"ListenV1ResponseMetadataSentimentInfo"},"ListenV1ResponseMetadataTopicsInfo":{"type":"object","properties":{"model_uuid":{"type":"string"},"input_tokens":{"type":"integer"},"output_tokens":{"type":"integer"}},"title":"ListenV1ResponseMetadataTopicsInfo"},"ListenV1ResponseMetadataIntentsInfo":{"type":"object","properties":{"model_uuid":{"type":"string"},"input_tokens":{"type":"integer"},"output_tokens":{"type":"integer"}},"title":"ListenV1ResponseMetadataIntentsInfo"},"ListenV1ResponseMetadata":{"type":"object","properties":{"transaction_key":{"type":"string","default":"deprecated"},"request_id":{"type":"string","format":"uuid"},"sha256":{"type":"string"},"created":{"type":"string","format":"date-time"},"duration":{"type":"number","format":"double"},"channels":{"type":"integer"},"models":{"type":"array","items":{"type":"string"}},"model_info":{"$ref":"#/components/schemas/ListenV1ResponseMetadataModelInfo"},"summary_info":{"$ref":"#/components/schemas/ListenV1ResponseMetadataSummaryInfo"},"sentiment_info":{"$ref":"#/components/schemas/ListenV1ResponseMetadataSentimentInfo"},"topics_info":{"$ref":"#/components/schemas/ListenV1ResponseMetadataTopicsInfo"},"intents_info":{"$ref":"#/components/schemas/ListenV1ResponseMetadataIntentsInfo"},"tags":{"type":"array","items":{"type":"string"}}},"required":["request_id","sha256","created","duration","channels","models","model_info"],"title":"ListenV1ResponseMetadata"},"ListenV1ResponseResultsChannelsItemsSearchItemsHitsItems":{"type":"object","properties":{"confidence":{"type":"number","format":"double"},"start":{"type":"number","format":"double"},"end":{"type":"number","format":"double"},"snippet":{"type":"string"}},"title":"ListenV1ResponseResultsChannelsItemsSearchItemsHitsItems"},"ListenV1ResponseResultsChannelsItemsSearchItems":{"type":"object","properties":{"query":{"type":"string"},"hits":{"type":"array","items":{"$ref":"#/components/schemas/ListenV1ResponseResultsChannelsItemsSearchItemsHitsItems"}}},"title":"ListenV1ResponseResultsChannelsItemsSearchItems"},"ListenV1ResponseResultsChannelsItemsAlternativesItemsWordsItems":{"type":"object","properties":{"word":{"type":"string"},"start":{"type":"number","format":"double"},"end":{"type":"number","format":"double"},"confidence":{"type":"number","format":"double"}},"title":"ListenV1ResponseResultsChannelsItemsAlternativesItemsWordsItems"},"ListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphsParagraphsItemsSentencesItems":{"type":"object","properties":{"text":{"type":"string"},"start":{"type":"number","format":"double"},"end":{"type":"number","format":"double"}},"title":"ListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphsParagraphsItemsSentencesItems"},"ListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphsParagraphsItems":{"type":"object","properties":{"sentences":{"type":"array","items":{"$ref":"#/components/schemas/ListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphsParagraphsItemsSentencesItems"}},"speaker":{"type":"integer"},"num_words":{"type":"integer"},"start":{"type":"number","format":"double"},"end":{"type":"number","format":"double"}},"title":"ListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphsParagraphsItems"},"ListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphs":{"type":"object","properties":{"transcript":{"type":"string"},"paragraphs":{"type":"array","items":{"$ref":"#/components/schemas/ListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphsParagraphsItems"}}},"title":"ListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphs"},"ListenV1ResponseResultsChannelsItemsAlternativesItemsEntitiesItems":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"raw_value":{"type":"string"},"confidence":{"type":"number","format":"double"},"start_word":{"type":"number","format":"double"},"end_word":{"type":"number","format":"double"}},"title":"ListenV1ResponseResultsChannelsItemsAlternativesItemsEntitiesItems"},"ListenV1ResponseResultsChannelsItemsAlternativesItemsSummariesItems":{"type":"object","properties":{"summary":{"type":"string"},"start_word":{"type":"number","format":"double"},"end_word":{"type":"number","format":"double"}},"title":"ListenV1ResponseResultsChannelsItemsAlternativesItemsSummariesItems"},"ListenV1ResponseResultsChannelsItemsAlternativesItemsTopicsItems":{"type":"object","properties":{"text":{"type":"string"},"start_word":{"type":"number","format":"double"},"end_word":{"type":"number","format":"double"},"topics":{"type":"array","items":{"type":"string"}}},"title":"ListenV1ResponseResultsChannelsItemsAlternativesItemsTopicsItems"},"ListenV1ResponseResultsChannelsItemsAlternativesItems":{"type":"object","properties":{"transcript":{"type":"string"},"confidence":{"type":"number","format":"double"},"words":{"type":"array","items":{"$ref":"#/components/schemas/ListenV1ResponseResultsChannelsItemsAlternativesItemsWordsItems"}},"paragraphs":{"$ref":"#/components/schemas/ListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphs"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/ListenV1ResponseResultsChannelsItemsAlternativesItemsEntitiesItems"}},"summaries":{"type":"array","items":{"$ref":"#/components/schemas/ListenV1ResponseResultsChannelsItemsAlternativesItemsSummariesItems"}},"topics":{"type":"array","items":{"$ref":"#/components/schemas/ListenV1ResponseResultsChannelsItemsAlternativesItemsTopicsItems"}}},"title":"ListenV1ResponseResultsChannelsItemsAlternativesItems"},"ListenV1ResponseResultsChannelsItems":{"type":"object","properties":{"search":{"type":"array","items":{"$ref":"#/components/schemas/ListenV1ResponseResultsChannelsItemsSearchItems"}},"alternatives":{"type":"array","items":{"$ref":"#/components/schemas/ListenV1ResponseResultsChannelsItemsAlternativesItems"}},"detected_language":{"type":"string"}},"title":"ListenV1ResponseResultsChannelsItems"},"ListenV1ResponseResultsChannels":{"type":"array","items":{"$ref":"#/components/schemas/ListenV1ResponseResultsChannelsItems"},"title":"ListenV1ResponseResultsChannels"},"ListenV1ResponseResultsUtterancesItemsWordsItems":{"type":"object","properties":{"word":{"type":"string"},"start":{"type":"number","format":"double"},"end":{"type":"number","format":"double"},"confidence":{"type":"number","format":"double"},"speaker":{"type":"integer"},"speaker_confidence":{"type":"number","format":"double"},"punctuated_word":{"type":"string"}},"title":"ListenV1ResponseResultsUtterancesItemsWordsItems"},"ListenV1ResponseResultsUtterancesItems":{"type":"object","properties":{"start":{"type":"number","format":"double"},"end":{"type":"number","format":"double"},"confidence":{"type":"number","format":"double"},"channel":{"type":"integer"},"transcript":{"type":"string"},"words":{"type":"array","items":{"$ref":"#/components/schemas/ListenV1ResponseResultsUtterancesItemsWordsItems"}},"speaker":{"type":"integer"},"id":{"type":"string","format":"uuid"}},"title":"ListenV1ResponseResultsUtterancesItems"},"ListenV1ResponseResultsUtterances":{"type":"array","items":{"$ref":"#/components/schemas/ListenV1ResponseResultsUtterancesItems"},"title":"ListenV1ResponseResultsUtterances"},"ListenV1ResponseResultsSummary":{"type":"object","properties":{"result":{"type":"string"},"short":{"type":"string"}},"title":"ListenV1ResponseResultsSummary"},"SharedTopicsResultsTopicsSegmentsItemsTopicsItems":{"type":"object","properties":{"topic":{"type":"string"},"confidence_score":{"type":"number","format":"double"}},"title":"SharedTopicsResultsTopicsSegmentsItemsTopicsItems"},"SharedTopicsResultsTopicsSegmentsItems":{"type":"object","properties":{"text":{"type":"string"},"start_word":{"type":"number","format":"double"},"end_word":{"type":"number","format":"double"},"topics":{"type":"array","items":{"$ref":"#/components/schemas/SharedTopicsResultsTopicsSegmentsItemsTopicsItems"}}},"title":"SharedTopicsResultsTopicsSegmentsItems"},"SharedTopicsResultsTopics":{"type":"object","properties":{"segments":{"type":"array","items":{"$ref":"#/components/schemas/SharedTopicsResultsTopicsSegmentsItems"}}},"title":"SharedTopicsResultsTopics"},"SharedTopicsResults":{"type":"object","properties":{"topics":{"$ref":"#/components/schemas/SharedTopicsResultsTopics"}},"title":"SharedTopicsResults"},"SharedTopics":{"type":"object","properties":{"results":{"$ref":"#/components/schemas/SharedTopicsResults"}},"description":"Output whenever `topics=true` is used","title":"SharedTopics"},"SharedIntentsResultsIntentsSegmentsItemsIntentsItems":{"type":"object","properties":{"intent":{"type":"string"},"confidence_score":{"type":"number","format":"double"}},"title":"SharedIntentsResultsIntentsSegmentsItemsIntentsItems"},"SharedIntentsResultsIntentsSegmentsItems":{"type":"object","properties":{"text":{"type":"string"},"start_word":{"type":"number","format":"double"},"end_word":{"type":"number","format":"double"},"intents":{"type":"array","items":{"$ref":"#/components/schemas/SharedIntentsResultsIntentsSegmentsItemsIntentsItems"}}},"title":"SharedIntentsResultsIntentsSegmentsItems"},"SharedIntentsResultsIntents":{"type":"object","properties":{"segments":{"type":"array","items":{"$ref":"#/components/schemas/SharedIntentsResultsIntentsSegmentsItems"}}},"title":"SharedIntentsResultsIntents"},"SharedIntentsResults":{"type":"object","properties":{"intents":{"$ref":"#/components/schemas/SharedIntentsResultsIntents"}},"title":"SharedIntentsResults"},"SharedIntents":{"type":"object","properties":{"results":{"$ref":"#/components/schemas/SharedIntentsResults"}},"description":"Output whenever `intents=true` is used","title":"SharedIntents"},"SharedSentimentsSegmentsItems":{"type":"object","properties":{"text":{"type":"string"},"start_word":{"type":"number","format":"double"},"end_word":{"type":"number","format":"double"},"sentiment":{"type":"string"},"sentiment_score":{"type":"number","format":"double"}},"title":"SharedSentimentsSegmentsItems"},"SharedSentimentsAverage":{"type":"object","properties":{"sentiment":{"type":"string"},"sentiment_score":{"type":"number","format":"double"}},"title":"SharedSentimentsAverage"},"SharedSentiments":{"type":"object","properties":{"segments":{"type":"array","items":{"$ref":"#/components/schemas/SharedSentimentsSegmentsItems"}},"average":{"$ref":"#/components/schemas/SharedSentimentsAverage"}},"description":"Output whenever `sentiment=true` is used","title":"SharedSentiments"},"ListenV1ResponseResults":{"type":"object","properties":{"channels":{"$ref":"#/components/schemas/ListenV1ResponseResultsChannels"},"utterances":{"$ref":"#/components/schemas/ListenV1ResponseResultsUtterances"},"summary":{"$ref":"#/components/schemas/ListenV1ResponseResultsSummary"},"topics":{"$ref":"#/components/schemas/SharedTopics"},"intents":{"$ref":"#/components/schemas/SharedIntents"},"sentiments":{"$ref":"#/components/schemas/SharedSentiments"}},"required":["channels"],"title":"ListenV1ResponseResults"},"ListenV1Response":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/ListenV1ResponseMetadata"},"results":{"$ref":"#/components/schemas/ListenV1ResponseResults"}},"required":["metadata","results"],"description":"The standard transcription response","title":"ListenV1Response"},"ListenV1AcceptedResponse":{"type":"object","properties":{"request_id":{"type":"string","format":"uuid","description":"Unique identifier for tracking the asynchronous request"}},"required":["request_id"],"description":"Accepted response for asynchronous transcription requests","title":"ListenV1AcceptedResponse"},"listen_v1_media_transcribe_Response_200":{"oneOf":[{"$ref":"#/components/schemas/ListenV1Response"},{"$ref":"#/components/schemas/ListenV1AcceptedResponse"}],"title":"listen_v1_media_transcribe_Response_200"},"V1SpeakPostParametersCallbackMethod":{"type":"string","enum":["POST","PUT"],"default":"POST","title":"V1SpeakPostParametersCallbackMethod"},"V1SpeakPostParametersTag":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"title":"V1SpeakPostParametersTag"},"V1SpeakPostParametersBitRate0":{"type":"string","enum":["32000","48000"],"description":"Encoding - mp3(default). Supported bitrates - 32000, 48000(default) bps.","title":"V1SpeakPostParametersBitRate0"},"V1SpeakPostParametersBitRate":{"oneOf":[{"$ref":"#/components/schemas/V1SpeakPostParametersBitRate0"},{"type":"number","format":"double"},{"type":"number","format":"double"}],"title":"V1SpeakPostParametersBitRate"},"V1SpeakPostParametersContainer0":{"type":"string","enum":["none"],"description":"No container.","title":"V1SpeakPostParametersContainer0"},"V1SpeakPostParametersContainer1":{"type":"string","enum":["wav"],"description":"Encoding - linear16. Supported container - wav (default), or no container.","title":"V1SpeakPostParametersContainer1"},"V1SpeakPostParametersContainer2":{"type":"string","enum":["wav"],"description":"Encoding - mulaw. Supported container - wav (default), or no container.","title":"V1SpeakPostParametersContainer2"},"V1SpeakPostParametersContainer3":{"type":"string","enum":["wav"],"description":"Encoding - alaw. Supported container - wav (default), or no container.","title":"V1SpeakPostParametersContainer3"},"V1SpeakPostParametersContainer4":{"type":"string","enum":["ogg"],"description":"Encoding - opus. Supported container - ogg (default).","title":"V1SpeakPostParametersContainer4"},"V1SpeakPostParametersContainer":{"oneOf":[{"$ref":"#/components/schemas/V1SpeakPostParametersContainer0"},{"$ref":"#/components/schemas/V1SpeakPostParametersContainer1"},{"$ref":"#/components/schemas/V1SpeakPostParametersContainer2"},{"$ref":"#/components/schemas/V1SpeakPostParametersContainer3"},{"$ref":"#/components/schemas/V1SpeakPostParametersContainer4"}],"title":"V1SpeakPostParametersContainer"},"V1SpeakPostParametersEncoding0":{"type":"string","enum":["linear16"],"description":"Encoding - linear16. Uncompressed, high-quality audio format often used for telephony or audio processing.","title":"V1SpeakPostParametersEncoding0"},"V1SpeakPostParametersEncoding1":{"type":"string","enum":["flac"],"description":"Encoding - flac. Lossless audio format for high-quality compression.","title":"V1SpeakPostParametersEncoding1"},"V1SpeakPostParametersEncoding2":{"type":"string","enum":["mulaw"],"description":"Encoding - mulaw. Compressed audio format commonly used in telephony.","title":"V1SpeakPostParametersEncoding2"},"V1SpeakPostParametersEncoding3":{"type":"string","enum":["alaw"],"description":"Encoding - alaw. Similar to mulaw but used in international telephony.","title":"V1SpeakPostParametersEncoding3"},"V1SpeakPostParametersEncoding4":{"type":"string","enum":["mp3"],"description":"Encoding - mp3. Popular compressed audio format for music and streaming.","title":"V1SpeakPostParametersEncoding4"},"V1SpeakPostParametersEncoding5":{"type":"string","enum":["opus"],"description":"Encoding - opus. High-compression audio format optimized for real-time communications.","title":"V1SpeakPostParametersEncoding5"},"V1SpeakPostParametersEncoding6":{"type":"string","enum":["aac"],"description":"Encoding - aac. Advanced audio format offering better quality at smaller file sizes than mp3.","title":"V1SpeakPostParametersEncoding6"},"V1SpeakPostParametersEncoding":{"oneOf":[{"$ref":"#/components/schemas/V1SpeakPostParametersEncoding0"},{"$ref":"#/components/schemas/V1SpeakPostParametersEncoding1"},{"$ref":"#/components/schemas/V1SpeakPostParametersEncoding2"},{"$ref":"#/components/schemas/V1SpeakPostParametersEncoding3"},{"$ref":"#/components/schemas/V1SpeakPostParametersEncoding4"},{"$ref":"#/components/schemas/V1SpeakPostParametersEncoding5"},{"$ref":"#/components/schemas/V1SpeakPostParametersEncoding6"}],"title":"V1SpeakPostParametersEncoding"},"V1SpeakPostParametersModel":{"type":"string","enum":["aura-asteria-en","aura-luna-en","aura-stella-en","aura-athena-en","aura-hera-en","aura-orion-en","aura-arcas-en","aura-perseus-en","aura-angus-en","aura-orpheus-en","aura-helios-en","aura-zeus-en","aura-2-amalthea-en","aura-2-andromeda-en","aura-2-apollo-en","aura-2-arcas-en","aura-2-aries-en","aura-2-asteria-en","aura-2-athena-en","aura-2-atlas-en","aura-2-aurora-en","aura-2-callista-en","aura-2-cordelia-en","aura-2-cora-en","aura-2-delia-en","aura-2-draco-en","aura-2-electra-en","aura-2-harmonia-en","aura-2-helena-en","aura-2-hera-en","aura-2-hermes-en","aura-2-hyperion-en","aura-2-iris-en","aura-2-janus-en","aura-2-juno-en","aura-2-jupiter-en","aura-2-luna-en","aura-2-mars-en","aura-2-minerva-en","aura-2-neptune-en","aura-2-odysseus-en","aura-2-ophelia-en","aura-2-orion-en","aura-2-orpheus-en","aura-2-pandora-en","aura-2-phoebe-en","aura-2-pluto-en","aura-2-saturn-en","aura-2-selene-en","aura-2-thalia-en","aura-2-theia-en","aura-2-vesta-en","aura-2-zeus-en","aura-2-sirio-es","aura-2-nestor-es","aura-2-carina-es","aura-2-celeste-es","aura-2-alvaro-es","aura-2-diana-es","aura-2-aquila-es","aura-2-selena-es","aura-2-estrella-es","aura-2-javier-es"],"default":"aura-asteria-en","title":"V1SpeakPostParametersModel"},"V1SpeakPostParametersSampleRate0":{"type":"string","enum":["8000","16000","24000","32000","48000"],"description":"Encoding - linear16. Supported sample rates - 8000, 16000, 24000, 32000, 48000 Hz.","title":"V1SpeakPostParametersSampleRate0"},"V1SpeakPostParametersSampleRate1":{"type":"string","enum":["8000","16000"],"description":"Encoding - mulaw. Supported sample rates - 8000, 16000 Hz.","title":"V1SpeakPostParametersSampleRate1"},"V1SpeakPostParametersSampleRate2":{"type":"string","enum":["8000","16000"],"description":"Encoding - alaw. Supported sample rates - 8000, 16000 Hz.","title":"V1SpeakPostParametersSampleRate2"},"V1SpeakPostParametersSampleRate3":{"type":"string","enum":["22050"],"description":"Encoding - mp3. Sample rate is fixed and not configurable (22050 Hz).","title":"V1SpeakPostParametersSampleRate3"},"V1SpeakPostParametersSampleRate4":{"type":"string","enum":["48000"],"description":"Encoding - opus. Sample rate is fixed at 48000 Hz.","title":"V1SpeakPostParametersSampleRate4"},"V1SpeakPostParametersSampleRate":{"oneOf":[{"$ref":"#/components/schemas/V1SpeakPostParametersSampleRate0"},{"$ref":"#/components/schemas/V1SpeakPostParametersSampleRate1"},{"$ref":"#/components/schemas/V1SpeakPostParametersSampleRate2"},{"$ref":"#/components/schemas/V1SpeakPostParametersSampleRate3"},{"$ref":"#/components/schemas/V1SpeakPostParametersSampleRate4"}],"title":"V1SpeakPostParametersSampleRate"},"SpeakV1Request":{"type":"object","properties":{"text":{"type":"string","description":"The text content to be converted to speech"}},"required":["text"],"description":"Request body for text-to-speech conversion","title":"SpeakV1Request"},"speak_v1_audio_generate_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"speak_v1_audio_generate_Response_200"},"V1ReadPostParametersCallbackMethod":{"type":"string","enum":["POST","PUT"],"default":"POST","title":"V1ReadPostParametersCallbackMethod"},"V1ReadPostParametersSummarize0":{"type":"string","enum":["v2"],"title":"V1ReadPostParametersSummarize0"},"V1ReadPostParametersSummarize":{"oneOf":[{"$ref":"#/components/schemas/V1ReadPostParametersSummarize0"},{"type":"boolean","default":false}],"title":"V1ReadPostParametersSummarize"},"V1ReadPostParametersTag":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"title":"V1ReadPostParametersTag"},"V1ReadPostParametersCustomTopic":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"title":"V1ReadPostParametersCustomTopic"},"V1ReadPostParametersCustomTopicMode":{"type":"string","enum":["extended","strict"],"default":"extended","title":"V1ReadPostParametersCustomTopicMode"},"V1ReadPostParametersCustomIntent":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"title":"V1ReadPostParametersCustomIntent"},"V1ReadPostParametersCustomIntentMode":{"type":"string","enum":["extended","strict"],"default":"extended","title":"V1ReadPostParametersCustomIntentMode"},"ReadV1RequestUrl":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"A URL pointing to the text source"}},"required":["url"],"title":"ReadV1RequestUrl"},"ReadV1RequestText":{"type":"object","properties":{"text":{"type":"string","description":"The plain text to analyze"}},"required":["text"],"title":"ReadV1RequestText"},"ReadV1Request":{"oneOf":[{"$ref":"#/components/schemas/ReadV1RequestUrl"},{"$ref":"#/components/schemas/ReadV1RequestText"}],"title":"ReadV1Request"},"ReadV1ResponseMetadataMetadataSummaryInfo":{"type":"object","properties":{"model_uuid":{"type":"string","format":"uuid"},"input_tokens":{"type":"integer"},"output_tokens":{"type":"integer"}},"title":"ReadV1ResponseMetadataMetadataSummaryInfo"},"ReadV1ResponseMetadataMetadataSentimentInfo":{"type":"object","properties":{"model_uuid":{"type":"string","format":"uuid"},"input_tokens":{"type":"integer"},"output_tokens":{"type":"integer"}},"title":"ReadV1ResponseMetadataMetadataSentimentInfo"},"ReadV1ResponseMetadataMetadataTopicsInfo":{"type":"object","properties":{"model_uuid":{"type":"string","format":"uuid"},"input_tokens":{"type":"integer"},"output_tokens":{"type":"integer"}},"title":"ReadV1ResponseMetadataMetadataTopicsInfo"},"ReadV1ResponseMetadataMetadataIntentsInfo":{"type":"object","properties":{"model_uuid":{"type":"string","format":"uuid"},"input_tokens":{"type":"integer"},"output_tokens":{"type":"integer"}},"title":"ReadV1ResponseMetadataMetadataIntentsInfo"},"ReadV1ResponseMetadataMetadata":{"type":"object","properties":{"request_id":{"type":"string","format":"uuid"},"created":{"type":"string","format":"date-time"},"language":{"type":"string"},"summary_info":{"$ref":"#/components/schemas/ReadV1ResponseMetadataMetadataSummaryInfo"},"sentiment_info":{"$ref":"#/components/schemas/ReadV1ResponseMetadataMetadataSentimentInfo"},"topics_info":{"$ref":"#/components/schemas/ReadV1ResponseMetadataMetadataTopicsInfo"},"intents_info":{"$ref":"#/components/schemas/ReadV1ResponseMetadataMetadataIntentsInfo"}},"title":"ReadV1ResponseMetadataMetadata"},"ReadV1ResponseMetadata":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/ReadV1ResponseMetadataMetadata"}},"title":"ReadV1ResponseMetadata"},"ReadV1ResponseResultsSummaryResultsSummary":{"type":"object","properties":{"text":{"type":"string"}},"title":"ReadV1ResponseResultsSummaryResultsSummary"},"ReadV1ResponseResultsSummaryResults":{"type":"object","properties":{"summary":{"$ref":"#/components/schemas/ReadV1ResponseResultsSummaryResultsSummary"}},"title":"ReadV1ResponseResultsSummaryResults"},"ReadV1ResponseResultsSummary":{"type":"object","properties":{"results":{"$ref":"#/components/schemas/ReadV1ResponseResultsSummaryResults"}},"description":"Output whenever `summary=true` is used","title":"ReadV1ResponseResultsSummary"},"ReadV1ResponseResults":{"type":"object","properties":{"summary":{"$ref":"#/components/schemas/ReadV1ResponseResultsSummary"},"topics":{"$ref":"#/components/schemas/SharedTopics"},"intents":{"$ref":"#/components/schemas/SharedIntents"},"sentiments":{"$ref":"#/components/schemas/SharedSentiments"}},"title":"ReadV1ResponseResults"},"ReadV1Response":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/ReadV1ResponseMetadata"},"results":{"$ref":"#/components/schemas/ReadV1ResponseResults"}},"required":["metadata","results"],"description":"The standard text response","title":"ReadV1Response"},"ListProjectsV1ResponseProjectsItems":{"type":"object","properties":{"project_id":{"type":"string","description":"The unique identifier of the project"},"name":{"type":"string","description":"The name of the project"}},"title":"ListProjectsV1ResponseProjectsItems"},"ListProjectsV1Response":{"type":"object","properties":{"projects":{"type":"array","items":{"$ref":"#/components/schemas/ListProjectsV1ResponseProjectsItems"}}},"title":"ListProjectsV1Response"},"GetProjectV1Response":{"type":"object","properties":{"project_id":{"type":"string","description":"The unique identifier of the project"},"mip_opt_out":{"type":"boolean","description":"Model Improvement Program opt-out"},"name":{"type":"string","description":"The name of the project"}},"title":"GetProjectV1Response"},"UpdateProjectV1Request":{"type":"object","properties":{"name":{"type":"string","description":"The name of the project"}},"title":"UpdateProjectV1Request"},"UpdateProjectV1Response":{"type":"object","properties":{"message":{"type":"string","description":"confirmation message"}},"title":"UpdateProjectV1Response"},"DeleteProjectV1Response":{"type":"object","properties":{"message":{"type":"string","description":"Confirmation message"}},"title":"DeleteProjectV1Response"},"LeaveProjectV1Response":{"type":"object","properties":{"message":{"type":"string","description":"confirmation message"}},"title":"LeaveProjectV1Response"},"ListModelsV1ResponseSttModels":{"type":"object","properties":{"name":{"type":"string"},"canonical_name":{"type":"string"},"architecture":{"type":"string"},"languages":{"type":"array","items":{"type":"string"}},"version":{"type":"string"},"uuid":{"type":"string"},"batch":{"type":"boolean"},"streaming":{"type":"boolean"},"formatted_output":{"type":"boolean"}},"title":"ListModelsV1ResponseSttModels"},"ListModelsV1ResponseTtsModelsMetadata":{"type":"object","properties":{"accent":{"type":"string"},"age":{"type":"string"},"color":{"type":"string"},"image":{"type":"string","format":"uri"},"sample":{"type":"string","format":"uri"},"tags":{"type":"array","items":{"type":"string"}},"use_cases":{"type":"array","items":{"type":"string"}}},"title":"ListModelsV1ResponseTtsModelsMetadata"},"ListModelsV1ResponseTtsModels":{"type":"object","properties":{"name":{"type":"string"},"canonical_name":{"type":"string"},"architecture":{"type":"string"},"languages":{"type":"array","items":{"type":"string"}},"version":{"type":"string"},"uuid":{"type":"string","format":"uuid"},"metadata":{"$ref":"#/components/schemas/ListModelsV1ResponseTtsModelsMetadata"}},"title":"ListModelsV1ResponseTtsModels"},"ListModelsV1Response":{"type":"object","properties":{"stt":{"type":"array","items":{"$ref":"#/components/schemas/ListModelsV1ResponseSttModels"}},"tts":{"type":"array","items":{"$ref":"#/components/schemas/ListModelsV1ResponseTtsModels"}}},"title":"ListModelsV1Response"},"GetModelV1Response0":{"type":"object","properties":{"name":{"type":"string"},"canonical_name":{"type":"string"},"architecture":{"type":"string"},"languages":{"type":"array","items":{"type":"string"}},"version":{"type":"string"},"uuid":{"type":"string","format":"uuid"},"batch":{"type":"boolean"},"streaming":{"type":"boolean"},"formatted_output":{"type":"boolean"}},"title":"GetModelV1Response0"},"GetModelV1ResponseOneOf1Metadata":{"type":"object","properties":{"accent":{"type":"string"},"age":{"type":"string"},"color":{"type":"string"},"image":{"type":"string","format":"uri"},"sample":{"type":"string","format":"uri"},"tags":{"type":"array","items":{"type":"string"}},"use_cases":{"type":"array","items":{"type":"string"}}},"title":"GetModelV1ResponseOneOf1Metadata"},"GetModelV1Response1":{"type":"object","properties":{"name":{"type":"string"},"canonical_name":{"type":"string"},"architecture":{"type":"string"},"languages":{"type":"array","items":{"type":"string"}},"version":{"type":"string"},"uuid":{"type":"string","format":"uuid"},"metadata":{"$ref":"#/components/schemas/GetModelV1ResponseOneOf1Metadata"}},"title":"GetModelV1Response1"},"GetModelV1Response":{"oneOf":[{"$ref":"#/components/schemas/GetModelV1Response0"},{"$ref":"#/components/schemas/GetModelV1Response1"}],"title":"GetModelV1Response"},"V1ProjectsProjectIdKeysGetParametersStatus":{"type":"string","enum":["active","expired"],"title":"V1ProjectsProjectIdKeysGetParametersStatus"},"ListProjectKeysV1ResponseApiKeysItemsMember":{"type":"object","properties":{"member_id":{"type":"string"},"email":{"type":"string"}},"title":"ListProjectKeysV1ResponseApiKeysItemsMember"},"ListProjectKeysV1ResponseApiKeysItemsApiKey":{"type":"object","properties":{"api_key_id":{"type":"string"},"comment":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}},"created":{"type":"string","format":"date-time"}},"title":"ListProjectKeysV1ResponseApiKeysItemsApiKey"},"ListProjectKeysV1ResponseApiKeysItems":{"type":"object","properties":{"member":{"$ref":"#/components/schemas/ListProjectKeysV1ResponseApiKeysItemsMember"},"api_key":{"$ref":"#/components/schemas/ListProjectKeysV1ResponseApiKeysItemsApiKey"}},"title":"ListProjectKeysV1ResponseApiKeysItems"},"ListProjectKeysV1Response":{"type":"object","properties":{"api_keys":{"type":"array","items":{"$ref":"#/components/schemas/ListProjectKeysV1ResponseApiKeysItems"}}},"title":"ListProjectKeysV1Response"},"CreateKeyV1Request":{"oneOf":[{"description":"Any type"},{"description":"Any type"}],"title":"CreateKeyV1Request"},"CreateKeyV1Response":{"type":"object","properties":{"api_key_id":{"type":"string","description":"The unique identifier of the API key"},"key":{"type":"string","description":"The API key"},"comment":{"type":"string","description":"A comment for the API key"},"scopes":{"type":"array","items":{"type":"string"},"description":"The scopes for the API key"},"tags":{"type":"array","items":{"type":"string"},"description":"The tags for the API key"},"expiration_date":{"type":"string","format":"date-time","description":"The expiration date of the API key"}},"description":"API key created","title":"CreateKeyV1Response"},"GetProjectKeyV1ResponseItemMemberApiKey":{"type":"object","properties":{"api_key_id":{"type":"string"},"comment":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"expiration_date":{"type":"string","format":"date-time"},"created":{"type":"string","format":"date-time"}},"title":"GetProjectKeyV1ResponseItemMemberApiKey"},"GetProjectKeyV1ResponseItemMember":{"type":"object","properties":{"member_id":{"type":"string"},"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"api_key":{"$ref":"#/components/schemas/GetProjectKeyV1ResponseItemMemberApiKey"}},"title":"GetProjectKeyV1ResponseItemMember"},"GetProjectKeyV1ResponseItem":{"type":"object","properties":{"member":{"$ref":"#/components/schemas/GetProjectKeyV1ResponseItemMember"}},"title":"GetProjectKeyV1ResponseItem"},"GetProjectKeyV1Response":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/GetProjectKeyV1ResponseItem"}},"title":"GetProjectKeyV1Response"},"DeleteProjectKeyV1Response":{"type":"object","properties":{"message":{"type":"string"}},"title":"DeleteProjectKeyV1Response"},"ListProjectMembersV1ResponseMembersItems":{"type":"object","properties":{"member_id":{"type":"string","description":"The unique identifier of the member"},"email":{"type":"string"}},"title":"ListProjectMembersV1ResponseMembersItems"},"ListProjectMembersV1Response":{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/ListProjectMembersV1ResponseMembersItems"}}},"title":"ListProjectMembersV1Response"},"DeleteProjectMemberV1Response":{"type":"object","properties":{"message":{"type":"string","description":"confirmation message"}},"title":"DeleteProjectMemberV1Response"},"ListProjectMemberScopesV1Response":{"type":"object","properties":{"scopes":{"type":"array","items":{"type":"string"},"description":"The API scopes of the member"}},"title":"ListProjectMemberScopesV1Response"},"UpdateProjectMemberScopesV1Request":{"type":"object","properties":{"scope":{"type":"string","description":"A scope to update"}},"required":["scope"],"title":"UpdateProjectMemberScopesV1Request"},"UpdateProjectMemberScopesV1Response":{"type":"object","properties":{"message":{"type":"string","description":"confirmation message"}},"title":"UpdateProjectMemberScopesV1Response"},"ListProjectInvitesV1ResponseInvitesItems":{"type":"object","properties":{"email":{"type":"string","description":"The email address of the invitee"},"scope":{"type":"string","description":"The scope of the invitee"}},"title":"ListProjectInvitesV1ResponseInvitesItems"},"ListProjectInvitesV1Response":{"type":"object","properties":{"invites":{"type":"array","items":{"$ref":"#/components/schemas/ListProjectInvitesV1ResponseInvitesItems"}}},"title":"ListProjectInvitesV1Response"},"CreateProjectInviteV1Request":{"type":"object","properties":{"email":{"type":"string","description":"The email address of the invitee"},"scope":{"type":"string","description":"The scope of the invitee"}},"required":["email","scope"],"description":"Request body for creating a project invite","title":"CreateProjectInviteV1Request"},"CreateProjectInviteV1Response":{"type":"object","properties":{"message":{"type":"string","description":"confirmation message"}},"title":"CreateProjectInviteV1Response"},"DeleteProjectInviteV1Response":{"type":"object","properties":{"message":{"type":"string","description":"confirmation message"}},"title":"DeleteProjectInviteV1Response"},"V1ProjectsProjectIdRequestsGetParametersDeployment":{"type":"string","enum":["hosted","beta","self-hosted"],"description":"Deployment type for the requests","title":"V1ProjectsProjectIdRequestsGetParametersDeployment"},"V1ProjectsProjectIdRequestsGetParametersEndpoint":{"type":"string","enum":["listen","read","speak","agent"],"title":"V1ProjectsProjectIdRequestsGetParametersEndpoint"},"V1ProjectsProjectIdRequestsGetParametersMethod":{"type":"string","enum":["sync","async","streaming"],"description":"Method type for the request","title":"V1ProjectsProjectIdRequestsGetParametersMethod"},"V1ProjectsProjectIdRequestsGetParametersStatus":{"type":"string","enum":["succeeded","failed"],"title":"V1ProjectsProjectIdRequestsGetParametersStatus"},"ProjectRequestResponseResponse":{"type":"object","properties":{},"description":"The response of the request","title":"ProjectRequestResponseResponse"},"ProjectRequestResponse":{"type":"object","properties":{"request_id":{"type":"string","description":"The unique identifier of the request"},"project_uuid":{"type":"string","description":"The unique identifier of the project"},"created":{"type":"string","format":"date-time","description":"The date and time the request was created"},"path":{"type":"string","description":"The API path of the request"},"api_key_id":{"type":"string","description":"The unique identifier of the API key"},"response":{"$ref":"#/components/schemas/ProjectRequestResponseResponse","description":"The response of the request"},"code":{"type":"number","format":"double","description":"The response code of the request"},"deployment":{"type":"string","description":"The deployment type"},"callback":{"type":"string","description":"The callback URL for the request"}},"description":"A single request","title":"ProjectRequestResponse"},"ListProjectRequestsV1Response":{"type":"object","properties":{"page":{"type":"number","format":"double","description":"The page number of the paginated response"},"limit":{"type":"number","format":"double","description":"The number of results per page"},"requests":{"type":"array","items":{"$ref":"#/components/schemas/ProjectRequestResponse"}}},"title":"ListProjectRequestsV1Response"},"GetProjectRequestV1Response":{"type":"object","properties":{"request":{"$ref":"#/components/schemas/ProjectRequestResponse"}},"title":"GetProjectRequestV1Response"},"V1ProjectsProjectIdUsageGetParametersDeployment":{"type":"string","enum":["hosted","beta","self-hosted"],"description":"Deployment type for the requests","title":"V1ProjectsProjectIdUsageGetParametersDeployment"},"V1ProjectsProjectIdUsageGetParametersEndpoint":{"type":"string","enum":["listen","read","speak","agent"],"title":"V1ProjectsProjectIdUsageGetParametersEndpoint"},"V1ProjectsProjectIdUsageGetParametersMethod":{"type":"string","enum":["sync","async","streaming"],"description":"Method type for the request","title":"V1ProjectsProjectIdUsageGetParametersMethod"},"UsageV1ResponseResolution":{"type":"object","properties":{"units":{"type":"string"},"amount":{"type":"number","format":"double"}},"title":"UsageV1ResponseResolution"},"UsageV1Response":{"type":"object","properties":{"start":{"type":"string","format":"date"},"end":{"type":"string","format":"date"},"resolution":{"$ref":"#/components/schemas/UsageV1ResponseResolution"}},"title":"UsageV1Response"},"UsageFieldsV1ResponseModelsItems":{"type":"object","properties":{"name":{"type":"string","description":"Name of the model."},"language":{"type":"string","description":"The language supported by the model (IETF language tag)."},"version":{"type":"string","description":"Version identifier of the model, typically with a date and a revision number."},"model_id":{"type":"string","description":"Unique identifier for the model."}},"title":"UsageFieldsV1ResponseModelsItems"},"UsageFieldsV1Response":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":"List of tags associated with the project"},"models":{"type":"array","items":{"$ref":"#/components/schemas/UsageFieldsV1ResponseModelsItems"},"description":"List of models available for the project."},"processing_methods":{"type":"array","items":{"type":"string"},"description":"Processing methods supported by the API"},"features":{"type":"array","items":{"type":"string"},"description":"API features available to the project"}},"title":"UsageFieldsV1Response"},"V1ProjectsProjectIdUsageBreakdownGetParametersGrouping":{"type":"string","enum":["accessor","endpoint","feature_set","models","method","tags","deployment"],"title":"V1ProjectsProjectIdUsageBreakdownGetParametersGrouping"},"V1ProjectsProjectIdUsageBreakdownGetParametersDeployment":{"type":"string","enum":["hosted","beta","self-hosted"],"description":"Deployment type for the requests","title":"V1ProjectsProjectIdUsageBreakdownGetParametersDeployment"},"V1ProjectsProjectIdUsageBreakdownGetParametersEndpoint":{"type":"string","enum":["listen","read","speak","agent"],"title":"V1ProjectsProjectIdUsageBreakdownGetParametersEndpoint"},"V1ProjectsProjectIdUsageBreakdownGetParametersMethod":{"type":"string","enum":["sync","async","streaming"],"description":"Method type for the request","title":"V1ProjectsProjectIdUsageBreakdownGetParametersMethod"},"UsageBreakdownV1ResponseResolution":{"type":"object","properties":{"units":{"type":"string","description":"Time unit for the resolution"},"amount":{"type":"number","format":"double","description":"Amount of units"}},"required":["units","amount"],"title":"UsageBreakdownV1ResponseResolution"},"UsageBreakdownV1ResponseResultsItemsGrouping":{"type":"object","properties":{"start":{"type":"string","format":"date","description":"Start date for this group"},"end":{"type":"string","format":"date","description":"End date for this group"},"accessor":{"type":["string","null"],"description":"Optional accessor identifier"},"endpoint":{"type":["string","null"],"description":"Optional endpoint identifier"},"feature_set":{"type":["string","null"],"description":"Optional feature set identifier"},"models":{"type":"array","items":{"type":"string"}},"method":{"type":["string","null"],"description":"Optional method identifier"},"tags":{"type":["array","null"],"items":{"type":"string"},"description":"Optional list of tags, null unless grouped by tags."},"deployment":{"type":["string","null"],"description":"Optional deployment identifier"}},"title":"UsageBreakdownV1ResponseResultsItemsGrouping"},"UsageBreakdownV1ResponseResultsItems":{"type":"object","properties":{"hours":{"type":"number","format":"double","description":"Audio hours processed"},"total_hours":{"type":"number","format":"double","description":"Total hours including all processing"},"agent_hours":{"type":"number","format":"double","description":"Agent hours used"},"tokens_in":{"type":"number","format":"double","description":"Number of input tokens"},"tokens_out":{"type":"number","format":"double","description":"Number of output tokens"},"tts_characters":{"type":"number","format":"double","description":"Number of text-to-speech characters processed"},"requests":{"type":"number","format":"double","description":"Number of requests"},"grouping":{"$ref":"#/components/schemas/UsageBreakdownV1ResponseResultsItemsGrouping"}},"required":["hours","total_hours","agent_hours","tokens_in","tokens_out","tts_characters","requests","grouping"],"title":"UsageBreakdownV1ResponseResultsItems"},"UsageBreakdownV1Response":{"type":"object","properties":{"start":{"type":"string","format":"date","description":"Start date of the usage period"},"end":{"type":"string","format":"date","description":"End date of the usage period"},"resolution":{"$ref":"#/components/schemas/UsageBreakdownV1ResponseResolution"},"results":{"type":"array","items":{"$ref":"#/components/schemas/UsageBreakdownV1ResponseResultsItems"}}},"required":["start","end","resolution","results"],"title":"UsageBreakdownV1Response"},"ListProjectBalancesV1ResponseBalancesItems":{"type":"object","properties":{"balance_id":{"type":"string","description":"The unique identifier of the balance"},"amount":{"type":"number","format":"double","default":0,"description":"The amount of the balance"},"units":{"type":"string","description":"The units of the balance, such as \"USD\""},"purchase_order_id":{"type":"string","description":"Description or reference of the purchase"}},"title":"ListProjectBalancesV1ResponseBalancesItems"},"ListProjectBalancesV1Response":{"type":"object","properties":{"balances":{"type":"array","items":{"$ref":"#/components/schemas/ListProjectBalancesV1ResponseBalancesItems"}}},"title":"ListProjectBalancesV1Response"},"GetProjectBalanceV1Response":{"type":"object","properties":{"balance_id":{"type":"string","description":"The unique identifier of the balance"},"amount":{"type":"number","format":"double","default":0,"description":"The amount of the balance"},"units":{"type":"string","description":"The units of the balance, such as \"USD\""},"purchase_order_id":{"type":"string","description":"Description or reference of the purchase"}},"title":"GetProjectBalanceV1Response"},"V1ProjectsProjectIdBillingBreakdownGetParametersDeployment":{"type":"string","enum":["hosted","beta","self-hosted"],"description":"Deployment type for the requests","title":"V1ProjectsProjectIdBillingBreakdownGetParametersDeployment"},"V1ProjectsProjectIdBillingBreakdownGetParametersGroupingSchemaItems":{"type":"string","enum":["accessor","deployment","line_item","tags"],"title":"V1ProjectsProjectIdBillingBreakdownGetParametersGroupingSchemaItems"},"BillingBreakdownV1ResponseResolution":{"type":"object","properties":{"units":{"type":"string","description":"Time unit for the resolution"},"amount":{"type":"number","format":"double","description":"Amount of units"}},"required":["units","amount"],"title":"BillingBreakdownV1ResponseResolution"},"BillingBreakdownV1ResponseResultsItemsGrouping":{"type":"object","properties":{"start":{"type":"string","format":"date","description":"Start date for this group"},"end":{"type":"string","format":"date","description":"End date for this group"},"accessor":{"type":["string","null"],"description":"Optional accessor identifier, null unless grouped by accessor."},"deployment":{"type":["string","null"],"description":"Optional deployment identifier, null unless grouped by deployment."},"line_item":{"type":["string","null"],"description":"Optional line item identifier, null unless grouped by line item."},"tags":{"type":["array","null"],"items":{"type":"string"},"description":"Optional list of tags, null unless grouped by tags."}},"title":"BillingBreakdownV1ResponseResultsItemsGrouping"},"BillingBreakdownV1ResponseResultsItems":{"type":"object","properties":{"dollars":{"type":"number","format":"double","description":"USD cost of the billing for this grouping"},"grouping":{"$ref":"#/components/schemas/BillingBreakdownV1ResponseResultsItemsGrouping"}},"required":["dollars","grouping"],"title":"BillingBreakdownV1ResponseResultsItems"},"BillingBreakdownV1Response":{"type":"object","properties":{"start":{"type":"string","format":"date","description":"Start date of the billing summmary period"},"end":{"type":"string","format":"date","description":"End date of the billing summary period"},"resolution":{"$ref":"#/components/schemas/BillingBreakdownV1ResponseResolution"},"results":{"type":"array","items":{"$ref":"#/components/schemas/BillingBreakdownV1ResponseResultsItems"}}},"required":["start","end","resolution","results"],"title":"BillingBreakdownV1Response"},"ListBillingFieldsV1ResponseDeploymentsItems":{"type":"string","enum":["hosted","beta","self-hosted","dedicated"],"title":"ListBillingFieldsV1ResponseDeploymentsItems"},"ListBillingFieldsV1Response":{"type":"object","properties":{"accessors":{"type":"array","items":{"type":"string","format":"uuid"},"description":"List of accessor UUIDs for the time period"},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ListBillingFieldsV1ResponseDeploymentsItems"},"description":"List of deployment types for the time period"},"tags":{"type":"array","items":{"type":"string"},"description":"List of tags for the time period"},"line_items":{"type":"object","additionalProperties":{"type":"string"},"description":"Map of line item names to human-readable descriptions for the time period"}},"title":"ListBillingFieldsV1Response"},"ListProjectPurchasesV1ResponseOrdersItems":{"type":"object","properties":{"order_id":{"type":"string","format":"uuid"},"expiration":{"type":"string","format":"date-time"},"created":{"type":"string","format":"date-time"},"amount":{"type":"number","format":"double"},"units":{"type":"string"},"order_type":{"type":"string"}},"title":"ListProjectPurchasesV1ResponseOrdersItems"},"ListProjectPurchasesV1Response":{"type":"object","properties":{"orders":{"type":"array","items":{"$ref":"#/components/schemas/ListProjectPurchasesV1ResponseOrdersItems"}}},"title":"ListProjectPurchasesV1Response"},"ListProjectDistributionCredentialsV1ResponseDistributionCredentialsItemsMember":{"type":"object","properties":{"member_id":{"type":"string","format":"uuid","description":"Unique identifier for the member"},"email":{"type":"string","format":"email","description":"Email address of the member"}},"required":["member_id","email"],"title":"ListProjectDistributionCredentialsV1ResponseDistributionCredentialsItemsMember"},"ListProjectDistributionCredentialsV1ResponseDistributionCredentialsItemsDistributionCredentials":{"type":"object","properties":{"distribution_credentials_id":{"type":"string","format":"uuid","description":"Unique identifier for the distribution credentials"},"provider":{"type":"string","description":"The provider of the distribution service"},"comment":{"type":"string","description":"Optional comment about the credentials"},"scopes":{"type":"array","items":{"type":"string"},"description":"List of permission scopes for the credentials"},"created":{"type":"string","format":"date-time","description":"Timestamp when the credentials were created"}},"required":["distribution_credentials_id","provider","scopes","created"],"title":"ListProjectDistributionCredentialsV1ResponseDistributionCredentialsItemsDistributionCredentials"},"ListProjectDistributionCredentialsV1ResponseDistributionCredentialsItems":{"type":"object","properties":{"member":{"$ref":"#/components/schemas/ListProjectDistributionCredentialsV1ResponseDistributionCredentialsItemsMember"},"distribution_credentials":{"$ref":"#/components/schemas/ListProjectDistributionCredentialsV1ResponseDistributionCredentialsItemsDistributionCredentials"}},"required":["member","distribution_credentials"],"title":"ListProjectDistributionCredentialsV1ResponseDistributionCredentialsItems"},"ListProjectDistributionCredentialsV1Response":{"type":"object","properties":{"distribution_credentials":{"type":"array","items":{"$ref":"#/components/schemas/ListProjectDistributionCredentialsV1ResponseDistributionCredentialsItems"},"description":"Array of distribution credentials with associated member information"}},"title":"ListProjectDistributionCredentialsV1Response"},"V1ProjectsProjectIdSelfHostedDistributionCredentialsPostParametersScopesSchemaItems":{"type":"string","enum":["self-hosted:products","self-hosted:product:api","self-hosted:product:engine","self-hosted:product:license-proxy","self-hosted:product:dgtools","self-hosted:product:billing","self-hosted:product:hotpepper","self-hosted:product:metrics-server"],"title":"V1ProjectsProjectIdSelfHostedDistributionCredentialsPostParametersScopesSchemaItems"},"V1ProjectsProjectIdSelfHostedDistributionCredentialsPostParametersProvider":{"type":"string","enum":["quay"],"default":"quay","title":"V1ProjectsProjectIdSelfHostedDistributionCredentialsPostParametersProvider"},"CreateProjectDistributionCredentialsV1Request":{"type":"object","properties":{"comment":{"type":"string","description":"Optional comment about the credentials"}},"description":"Request body for creating distribution credentials","title":"CreateProjectDistributionCredentialsV1Request"},"CreateProjectDistributionCredentialsV1ResponseMember":{"type":"object","properties":{"member_id":{"type":"string","format":"uuid","description":"Unique identifier for the member"},"email":{"type":"string","format":"email","description":"Email address of the member"}},"required":["member_id","email"],"title":"CreateProjectDistributionCredentialsV1ResponseMember"},"CreateProjectDistributionCredentialsV1ResponseDistributionCredentials":{"type":"object","properties":{"distribution_credentials_id":{"type":"string","format":"uuid","description":"Unique identifier for the distribution credentials"},"provider":{"type":"string","description":"The provider of the distribution service"},"comment":{"type":"string","description":"Optional comment about the credentials"},"scopes":{"type":"array","items":{"type":"string"},"description":"List of permission scopes for the credentials"},"created":{"type":"string","format":"date-time","description":"Timestamp when the credentials were created"}},"required":["distribution_credentials_id","provider","scopes","created"],"title":"CreateProjectDistributionCredentialsV1ResponseDistributionCredentials"},"CreateProjectDistributionCredentialsV1Response":{"type":"object","properties":{"member":{"$ref":"#/components/schemas/CreateProjectDistributionCredentialsV1ResponseMember"},"distribution_credentials":{"$ref":"#/components/schemas/CreateProjectDistributionCredentialsV1ResponseDistributionCredentials"}},"required":["member","distribution_credentials"],"title":"CreateProjectDistributionCredentialsV1Response"},"GetProjectDistributionCredentialsV1ResponseMember":{"type":"object","properties":{"member_id":{"type":"string","format":"uuid","description":"Unique identifier for the member"},"email":{"type":"string","format":"email","description":"Email address of the member"}},"required":["member_id","email"],"title":"GetProjectDistributionCredentialsV1ResponseMember"},"GetProjectDistributionCredentialsV1ResponseDistributionCredentials":{"type":"object","properties":{"distribution_credentials_id":{"type":"string","format":"uuid","description":"Unique identifier for the distribution credentials"},"provider":{"type":"string","description":"The provider of the distribution service"},"comment":{"type":"string","description":"Optional comment about the credentials"},"scopes":{"type":"array","items":{"type":"string"},"description":"List of permission scopes for the credentials"},"created":{"type":"string","format":"date-time","description":"Timestamp when the credentials were created"}},"required":["distribution_credentials_id","provider","scopes","created"],"title":"GetProjectDistributionCredentialsV1ResponseDistributionCredentials"},"GetProjectDistributionCredentialsV1Response":{"type":"object","properties":{"member":{"$ref":"#/components/schemas/GetProjectDistributionCredentialsV1ResponseMember"},"distribution_credentials":{"$ref":"#/components/schemas/GetProjectDistributionCredentialsV1ResponseDistributionCredentials"}},"required":["member","distribution_credentials"],"title":"GetProjectDistributionCredentialsV1Response"},"GrantV1Request":{"type":"object","properties":{"ttl_seconds":{"type":"number","format":"double","description":"Time to live in seconds for the token. Defaults to 30 seconds."}},"title":"GrantV1Request"},"GrantV1Response":{"type":"object","properties":{"access_token":{"type":"string","description":"JSON Web Token (JWT)"},"expires_in":{"type":"number","format":"double","description":"Time in seconds until the JWT expires"}},"required":["access_token"],"title":"GrantV1Response"}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Use `Authorization: Token <API_KEY>`\nExample: `Authorization: Token 12345abcdef`\n"},"JwtAuth":{"type":"http","scheme":"bearer","description":"Use `Authorization: Bearer <JWT>`\nExample: `Authorization: Bearer eyJhbGciOiJ...`\n"}}}}