From 2a091a76f971325fbbaf2036e4a55b94ba8bf758 Mon Sep 17 00:00:00 2001 From: Nikhil Gupta Date: Sat, 15 Jun 2024 20:28:34 -0700 Subject: [PATCH] update schema --- api.json | 4923 +++++++++--------------------------------------------- 1 file changed, 822 insertions(+), 4101 deletions(-) diff --git a/api.json b/api.json index cba295e..142db47 100644 --- a/api.json +++ b/api.json @@ -10,9 +10,7 @@ "required": true, "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateAssistantDTO" - } + "schema": { "$ref": "#/components/schemas/CreateAssistantDTO" } } } }, @@ -21,21 +19,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/Assistant" - } + "schema": { "$ref": "#/components/schemas/Assistant" } } } } }, - "tags": [ - "Assistants" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Assistants"], + "security": [{ "bearer": [] }] }, "get": { "operationId": "AssistantController_findAll", @@ -46,91 +36,63 @@ "required": false, "in": "query", "description": "This is the maximum number of items to return. Defaults to 100.", - "schema": { - "minimum": 0, - "maximum": 1000, - "type": "number" - } + "schema": { "minimum": 0, "maximum": 1000, "type": "number" } }, { "name": "createdAtGt", "required": false, "in": "query", "description": "This will return items where the createdAt is greater than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "createdAtLt", "required": false, "in": "query", "description": "This will return items where the createdAt is less than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "createdAtGe", "required": false, "in": "query", "description": "This will return items where the createdAt is greater than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "createdAtLe", "required": false, "in": "query", "description": "This will return items where the createdAt is less than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtGt", "required": false, "in": "query", "description": "This will return items where the updatedAt is greater than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtLt", "required": false, "in": "query", "description": "This will return items where the updatedAt is less than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtGe", "required": false, "in": "query", "description": "This will return items where the updatedAt is greater than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtLe", "required": false, "in": "query", "description": "This will return items where the updatedAt is less than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } } ], "responses": { @@ -140,22 +102,14 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/Assistant" - } + "items": { "$ref": "#/components/schemas/Assistant" } } } } } }, - "tags": [ - "Assistants" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Assistants"], + "security": [{ "bearer": [] }] } }, "/assistant/{id}": { @@ -167,9 +121,7 @@ "name": "id", "required": true, "in": "path", - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "responses": { @@ -177,21 +129,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/Assistant" - } + "schema": { "$ref": "#/components/schemas/Assistant" } } } } }, - "tags": [ - "Assistants" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Assistants"], + "security": [{ "bearer": [] }] }, "patch": { "operationId": "AssistantController_update", @@ -201,18 +145,14 @@ "name": "id", "required": true, "in": "path", - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateAssistantDTO" - } + "schema": { "$ref": "#/components/schemas/UpdateAssistantDTO" } } } }, @@ -221,21 +161,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/Assistant" - } + "schema": { "$ref": "#/components/schemas/Assistant" } } } } }, - "tags": [ - "Assistants" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Assistants"], + "security": [{ "bearer": [] }] }, "delete": { "operationId": "AssistantController_remove", @@ -245,9 +177,7 @@ "name": "id", "required": true, "in": "path", - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "responses": { @@ -255,21 +185,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/Assistant" - } + "schema": { "$ref": "#/components/schemas/Assistant" } } } } }, - "tags": [ - "Assistants" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Assistants"], + "security": [{ "bearer": [] }] } }, "/call": { @@ -282,100 +204,70 @@ "required": false, "in": "query", "description": "This will return calls with the specified assistantId.", - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "This is the maximum number of items to return. Defaults to 100.", - "schema": { - "minimum": 0, - "maximum": 1000, - "type": "number" - } + "schema": { "minimum": 0, "maximum": 1000, "type": "number" } }, { "name": "createdAtGt", "required": false, "in": "query", "description": "This will return items where the createdAt is greater than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "createdAtLt", "required": false, "in": "query", "description": "This will return items where the createdAt is less than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "createdAtGe", "required": false, "in": "query", "description": "This will return items where the createdAt is greater than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "createdAtLe", "required": false, "in": "query", "description": "This will return items where the createdAt is less than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtGt", "required": false, "in": "query", "description": "This will return items where the updatedAt is greater than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtLt", "required": false, "in": "query", "description": "This will return items where the updatedAt is less than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtGe", "required": false, "in": "query", "description": "This will return items where the updatedAt is greater than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtLe", "required": false, "in": "query", "description": "This will return items where the updatedAt is less than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } } ], "responses": { @@ -385,22 +277,14 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/Call" - } + "items": { "$ref": "#/components/schemas/Call" } } } } } }, - "tags": [ - "Calls" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Calls"], + "security": [{ "bearer": [] }] } }, "/call/{id}": { @@ -412,9 +296,7 @@ "name": "id", "required": true, "in": "path", - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "responses": { @@ -422,21 +304,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/Call" - } + "schema": { "$ref": "#/components/schemas/Call" } } } } }, - "tags": [ - "Calls" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Calls"], + "security": [{ "bearer": [] }] }, "delete": { "operationId": "CallController_deleteCallData", @@ -446,9 +320,7 @@ "name": "id", "required": true, "in": "path", - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "responses": { @@ -456,21 +328,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/Call" - } + "schema": { "$ref": "#/components/schemas/Call" } } } } }, - "tags": [ - "Calls" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Calls"], + "security": [{ "bearer": [] }] }, "patch": { "operationId": "CallController_update", @@ -480,18 +344,14 @@ "name": "id", "required": true, "in": "path", - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateCallDTO" - } + "schema": { "$ref": "#/components/schemas/UpdateCallDTO" } } } }, @@ -500,21 +360,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/Call" - } + "schema": { "$ref": "#/components/schemas/Call" } } } } }, - "tags": [ - "Calls" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Calls"], + "security": [{ "bearer": [] }] } }, "/call/phone": { @@ -526,9 +378,7 @@ "required": true, "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateOutboundCallDTO" - } + "schema": { "$ref": "#/components/schemas/CreateOutboundCallDTO" } } } }, @@ -537,146 +387,25 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/Call" - } + "schema": { "$ref": "#/components/schemas/Call" } } } } }, - "tags": [ - "Calls" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Calls"], + "security": [{ "bearer": [] }] } }, - "/credential": { + "/squad": { "post": { - "operationId": "CredentialController_create", - "summary": "Create Credential", + "operationId": "SquadController_create", + "summary": "Create Squad", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/CreateAnthropicCredentialDTO", - "title": "AnthropicCredential" - }, - { - "$ref": "#/components/schemas/CreateAnyscaleCredentialDTO", - "title": "AnyscaleCredential" - }, - { - "$ref": "#/components/schemas/CreateAzureOpenAICredentialDTO", - "title": "AzureOpenAICredential" - }, - { - "$ref": "#/components/schemas/CreateCartesiaCredentialDTO", - "title": "CartesiaCredential" - }, - { - "$ref": "#/components/schemas/CreateCustomLLMCredentialDTO", - "title": "CustomLLMCredential" - }, - { - "$ref": "#/components/schemas/CreateDeepgramCredentialDTO", - "title": "DeepgramCredential" - }, - { - "$ref": "#/components/schemas/CreateDeepInfraCredentialDTO", - "title": "DeepInfraCredential" - }, - { - "$ref": "#/components/schemas/CreateElevenLabsCredentialDTO", - "title": "ElevenLabsCredential" - }, - { - "$ref": "#/components/schemas/CreateGoHighLevelCredentialDTO", - "title": "GhlCredential" - }, - { - "$ref": "#/components/schemas/CreateGroqCredentialDTO", - "title": "GroqCredential" - }, - { - "$ref": "#/components/schemas/CreateLmntCredentialDTO", - "title": "LmntCredential" - }, - { - "$ref": "#/components/schemas/CreateMakeCredentialDTO", - "title": "MakeCredential" - }, - { - "$ref": "#/components/schemas/CreateOpenAICredentialDTO", - "title": "OpenAICredential" - }, - { - "$ref": "#/components/schemas/CreateOpenRouterCredentialDTO", - "title": "OpenRouterCredential" - }, - { - "$ref": "#/components/schemas/CreatePerplexityAICredentialDTO", - "title": "PerplexityAICredential" - }, - { - "$ref": "#/components/schemas/CreatePlayHTCredentialDTO", - "title": "PlayHTCredential" - }, - { - "$ref": "#/components/schemas/CreateRimeAICredentialDTO", - "title": "RimeAICredential" - }, - { - "$ref": "#/components/schemas/CreateRunpodCredentialDTO", - "title": "RunpodCredential" - }, - { - "$ref": "#/components/schemas/CreateTogetherAICredentialDTO", - "title": "TogetherAICredential" - }, - { - "$ref": "#/components/schemas/CreateTwilioCredentialDTO", - "title": "TwilioCredential" - }, - { - "$ref": "#/components/schemas/CreateVonageCredentialDTO", - "title": "VonageCredential" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "11labs": "#/components/schemas/CreateElevenLabsCredentialDTO", - "anthropic": "#/components/schemas/CreateAnthropicCredentialDTO", - "anyscale": "#/components/schemas/CreateAnyscaleCredentialDTO", - "azure-openai": "#/components/schemas/CreateAzureOpenAICredentialDTO", - "cartesia": "#/components/schemas/CreateCartesiaCredentialDTO", - "custom-llm": "#/components/schemas/CreateCustomLLMCredentialDTO", - "deepgram": "#/components/schemas/CreateDeepgramCredentialDTO", - "deepinfra": "#/components/schemas/CreateDeepInfraCredentialDTO", - "gohighlevel": "#/components/schemas/CreateGoHighLevelCredentialDTO", - "groq": "#/components/schemas/CreateGroqCredentialDTO", - "lmnt": "#/components/schemas/CreateLmntCredentialDTO", - "make": "#/components/schemas/CreateMakeCredentialDTO", - "openai": "#/components/schemas/CreateOpenAICredentialDTO", - "openrouter": "#/components/schemas/CreateOpenRouterCredentialDTO", - "perplexity-ai": "#/components/schemas/CreatePerplexityAICredentialDTO", - "playht": "#/components/schemas/CreatePlayHTCredentialDTO", - "rime-ai": "#/components/schemas/CreateRimeAICredentialDTO", - "runpod": "#/components/schemas/CreateRunpodCredentialDTO", - "together-ai": "#/components/schemas/CreateTogetherAICredentialDTO", - "twilio": "#/components/schemas/CreateTwilioCredentialDTO", - "vonage": "#/components/schemas/CreateVonageCredentialDTO" - } - } - } + "schema": { "$ref": "#/components/schemas/CreateSquadDTO" } } } }, @@ -685,227 +414,80 @@ "description": "", "content": { "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/AnyscaleCredential", - "title": "AnyscaleCredential" - }, - { - "$ref": "#/components/schemas/AzureOpenAICredential", - "title": "AzureOpenAICredential" - }, - { - "$ref": "#/components/schemas/CartesiaCredential", - "title": "CartesiaCredential" - }, - { - "$ref": "#/components/schemas/CustomLLMCredential", - "title": "CustomLLMCredential" - }, - { - "$ref": "#/components/schemas/DeepgramCredential", - "title": "DeepgramCredential" - }, - { - "$ref": "#/components/schemas/DeepInfraCredential", - "title": "DeepInfraCredential" - }, - { - "$ref": "#/components/schemas/ElevenLabsCredential", - "title": "ElevenLabsCredential" - }, - { - "$ref": "#/components/schemas/GoHighLevelCredential", - "title": "GhlCredential" - }, - { - "$ref": "#/components/schemas/UpdateGroqCredentialDTO", - "title": "GroqCredential" - }, - { - "$ref": "#/components/schemas/LmntCredential", - "title": "LmntCredential" - }, - { - "$ref": "#/components/schemas/MakeCredential", - "title": "MakeCredential" - }, - { - "$ref": "#/components/schemas/OpenAICredential", - "title": "OpenAICredential" - }, - { - "$ref": "#/components/schemas/OpenRouterCredential", - "title": "OpenRouterCredential" - }, - { - "$ref": "#/components/schemas/PerplexityAICredential", - "title": "PerplexityAICredential" - }, - { - "$ref": "#/components/schemas/PlayHTCredential", - "title": "PlayHTCredential" - }, - { - "$ref": "#/components/schemas/RimeAICredential", - "title": "RimeAICredential" - }, - { - "$ref": "#/components/schemas/UpdateAnthropicCredentialDTO", - "title": "AnthropicCredential" - }, - { - "$ref": "#/components/schemas/UpdateRunpodCredentialDTO", - "title": "RunpodCredential" - }, - { - "$ref": "#/components/schemas/TogetherAICredential", - "title": "TogetherAICredential" - }, - { - "$ref": "#/components/schemas/TwilioCredential", - "title": "TwilioCredential" - }, - { - "$ref": "#/components/schemas/UpdateVonageCredentialDTO", - "title": "VonageCredential" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "11labs": "#/components/schemas/ElevenLabsCredential", - "anthropic": "#/components/schemas/AnthropicCredential", - "anyscale": "#/components/schemas/AnyscaleCredential", - "azure-openai": "#/components/schemas/AzureOpenAICredential", - "cartesia": "#/components/schemas/CartesiaCredential", - "custom-llm": "#/components/schemas/CustomLLMCredential", - "deepgram": "#/components/schemas/DeepgramCredential", - "deepinfra": "#/components/schemas/DeepInfraCredential", - "gohighlevel": "#/components/schemas/GoHighLevelCredential", - "groq": "#/components/schemas/GroqCredential", - "lmnt": "#/components/schemas/LmntCredential", - "make": "#/components/schemas/MakeCredential", - "openai": "#/components/schemas/OpenAICredential", - "openrouter": "#/components/schemas/OpenRouterCredential", - "perplexity-ai": "#/components/schemas/PerplexityAICredential", - "playht": "#/components/schemas/PlayHTCredential", - "rime-ai": "#/components/schemas/RimeAICredential", - "runpod": "#/components/schemas/RunpodCredential", - "together-ai": "#/components/schemas/TogetherAICredential", - "twilio": "#/components/schemas/TwilioCredential", - "vonage": "#/components/schemas/VonageCredential" - } - } - } + "schema": { "$ref": "#/components/schemas/Squad" } } } } }, - "tags": [ - "Credentials" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Squads"], + "security": [{ "bearer": [] }] }, "get": { - "operationId": "CredentialController_findAll", - "summary": "List Credentials", + "operationId": "SquadController_findAll", + "summary": "List Squads", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "This is the maximum number of items to return. Defaults to 100.", - "schema": { - "minimum": 0, - "maximum": 1000, - "type": "number" - } + "schema": { "minimum": 0, "maximum": 1000, "type": "number" } }, { "name": "createdAtGt", "required": false, "in": "query", "description": "This will return items where the createdAt is greater than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "createdAtLt", "required": false, "in": "query", "description": "This will return items where the createdAt is less than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "createdAtGe", "required": false, "in": "query", "description": "This will return items where the createdAt is greater than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "createdAtLe", "required": false, "in": "query", "description": "This will return items where the createdAt is less than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtGt", "required": false, "in": "query", "description": "This will return items where the updatedAt is greater than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtLt", "required": false, "in": "query", "description": "This will return items where the updatedAt is less than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtGe", "required": false, "in": "query", "description": "This will return items where the updatedAt is greater than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtLe", "required": false, "in": "query", "description": "This will return items where the updatedAt is less than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } } ], "responses": { @@ -915,848 +497,14 @@ "application/json": { "schema": { "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AnyscaleCredential", - "title": "AnyscaleCredential" - }, - { - "$ref": "#/components/schemas/AzureOpenAICredential", - "title": "AzureOpenAICredential" - }, - { - "$ref": "#/components/schemas/CartesiaCredential", - "title": "CartesiaCredential" - }, - { - "$ref": "#/components/schemas/CustomLLMCredential", - "title": "CustomLLMCredential" - }, - { - "$ref": "#/components/schemas/DeepgramCredential", - "title": "DeepgramCredential" - }, - { - "$ref": "#/components/schemas/DeepInfraCredential", - "title": "DeepInfraCredential" - }, - { - "$ref": "#/components/schemas/ElevenLabsCredential", - "title": "ElevenLabsCredential" - }, - { - "$ref": "#/components/schemas/GoHighLevelCredential", - "title": "GhlCredential" - }, - { - "$ref": "#/components/schemas/UpdateGroqCredentialDTO", - "title": "GroqCredential" - }, - { - "$ref": "#/components/schemas/LmntCredential", - "title": "LmntCredential" - }, - { - "$ref": "#/components/schemas/MakeCredential", - "title": "MakeCredential" - }, - { - "$ref": "#/components/schemas/OpenAICredential", - "title": "OpenAICredential" - }, - { - "$ref": "#/components/schemas/OpenRouterCredential", - "title": "OpenRouterCredential" - }, - { - "$ref": "#/components/schemas/PerplexityAICredential", - "title": "PerplexityAICredential" - }, - { - "$ref": "#/components/schemas/PlayHTCredential", - "title": "PlayHTCredential" - }, - { - "$ref": "#/components/schemas/RimeAICredential", - "title": "RimeAICredential" - }, - { - "$ref": "#/components/schemas/UpdateAnthropicCredentialDTO", - "title": "AnthropicCredential" - }, - { - "$ref": "#/components/schemas/UpdateRunpodCredentialDTO", - "title": "RunpodCredential" - }, - { - "$ref": "#/components/schemas/TogetherAICredential", - "title": "TogetherAICredential" - }, - { - "$ref": "#/components/schemas/TwilioCredential", - "title": "TwilioCredential" - }, - { - "$ref": "#/components/schemas/UpdateVonageCredentialDTO", - "title": "VonageCredential" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "11labs": "#/components/schemas/ElevenLabsCredential", - "anthropic": "#/components/schemas/AnthropicCredential", - "anyscale": "#/components/schemas/AnyscaleCredential", - "azure-openai": "#/components/schemas/AzureOpenAICredential", - "cartesia": "#/components/schemas/CartesiaCredential", - "custom-llm": "#/components/schemas/CustomLLMCredential", - "deepgram": "#/components/schemas/DeepgramCredential", - "deepinfra": "#/components/schemas/DeepInfraCredential", - "gohighlevel": "#/components/schemas/GoHighLevelCredential", - "groq": "#/components/schemas/GroqCredential", - "lmnt": "#/components/schemas/LmntCredential", - "make": "#/components/schemas/MakeCredential", - "openai": "#/components/schemas/OpenAICredential", - "openrouter": "#/components/schemas/OpenRouterCredential", - "perplexity-ai": "#/components/schemas/PerplexityAICredential", - "playht": "#/components/schemas/PlayHTCredential", - "rime-ai": "#/components/schemas/RimeAICredential", - "runpod": "#/components/schemas/RunpodCredential", - "together-ai": "#/components/schemas/TogetherAICredential", - "twilio": "#/components/schemas/TwilioCredential", - "vonage": "#/components/schemas/VonageCredential" - } - } - } + "items": { "$ref": "#/components/schemas/Squad" } } } } } }, - "tags": [ - "Credentials" - ], - "security": [ - { - "bearer": [] - } - ] - } - }, - "/credential/{id}": { - "get": { - "operationId": "CredentialController_findOne", - "summary": "Get Credential", - "parameters": [ - { - "name": "id", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/AnyscaleCredential", - "title": "AnyscaleCredential" - }, - { - "$ref": "#/components/schemas/AzureOpenAICredential", - "title": "AzureOpenAICredential" - }, - { - "$ref": "#/components/schemas/CartesiaCredential", - "title": "CartesiaCredential" - }, - { - "$ref": "#/components/schemas/CustomLLMCredential", - "title": "CustomLLMCredential" - }, - { - "$ref": "#/components/schemas/DeepgramCredential", - "title": "DeepgramCredential" - }, - { - "$ref": "#/components/schemas/DeepInfraCredential", - "title": "DeepInfraCredential" - }, - { - "$ref": "#/components/schemas/ElevenLabsCredential", - "title": "ElevenLabsCredential" - }, - { - "$ref": "#/components/schemas/GoHighLevelCredential", - "title": "GhlCredential" - }, - { - "$ref": "#/components/schemas/UpdateGroqCredentialDTO", - "title": "GroqCredential" - }, - { - "$ref": "#/components/schemas/LmntCredential", - "title": "LmntCredential" - }, - { - "$ref": "#/components/schemas/MakeCredential", - "title": "MakeCredential" - }, - { - "$ref": "#/components/schemas/OpenAICredential", - "title": "OpenAICredential" - }, - { - "$ref": "#/components/schemas/OpenRouterCredential", - "title": "OpenRouterCredential" - }, - { - "$ref": "#/components/schemas/PerplexityAICredential", - "title": "PerplexityAICredential" - }, - { - "$ref": "#/components/schemas/PlayHTCredential", - "title": "PlayHTCredential" - }, - { - "$ref": "#/components/schemas/RimeAICredential", - "title": "RimeAICredential" - }, - { - "$ref": "#/components/schemas/UpdateAnthropicCredentialDTO", - "title": "AnthropicCredential" - }, - { - "$ref": "#/components/schemas/UpdateRunpodCredentialDTO", - "title": "RunpodCredential" - }, - { - "$ref": "#/components/schemas/TogetherAICredential", - "title": "TogetherAICredential" - }, - { - "$ref": "#/components/schemas/TwilioCredential", - "title": "TwilioCredential" - }, - { - "$ref": "#/components/schemas/UpdateVonageCredentialDTO", - "title": "VonageCredential" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "11labs": "#/components/schemas/ElevenLabsCredential", - "anthropic": "#/components/schemas/AnthropicCredential", - "anyscale": "#/components/schemas/AnyscaleCredential", - "azure-openai": "#/components/schemas/AzureOpenAICredential", - "cartesia": "#/components/schemas/CartesiaCredential", - "custom-llm": "#/components/schemas/CustomLLMCredential", - "deepgram": "#/components/schemas/DeepgramCredential", - "deepinfra": "#/components/schemas/DeepInfraCredential", - "gohighlevel": "#/components/schemas/GoHighLevelCredential", - "groq": "#/components/schemas/GroqCredential", - "lmnt": "#/components/schemas/LmntCredential", - "make": "#/components/schemas/MakeCredential", - "openai": "#/components/schemas/OpenAICredential", - "openrouter": "#/components/schemas/OpenRouterCredential", - "perplexity-ai": "#/components/schemas/PerplexityAICredential", - "playht": "#/components/schemas/PlayHTCredential", - "rime-ai": "#/components/schemas/RimeAICredential", - "runpod": "#/components/schemas/RunpodCredential", - "together-ai": "#/components/schemas/TogetherAICredential", - "twilio": "#/components/schemas/TwilioCredential", - "vonage": "#/components/schemas/VonageCredential" - } - } - } - } - } - } - }, - "tags": [ - "Credentials" - ], - "security": [ - { - "bearer": [] - } - ] - }, - "put": { - "operationId": "CredentialController_update", - "summary": "Update Credential", - "parameters": [ - { - "name": "id", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/UpdateAnyscaleCredentialDTO", - "title": "AnyscaleCredential" - }, - { - "$ref": "#/components/schemas/UpdateAnthropicCredentialDTO", - "title": "AnthropicCredential" - }, - { - "$ref": "#/components/schemas/UpdateAzureOpenAICredentialDTO", - "title": "AzureOpenAICredential" - }, - { - "$ref": "#/components/schemas/UpdateCartesiaCredentialDTO", - "title": "CartesiaCredential" - }, - { - "$ref": "#/components/schemas/UpdateCustomLLMCredentialDTO", - "title": "CustomLLMCredential" - }, - { - "$ref": "#/components/schemas/UpdateDeepgramCredentialDTO", - "title": "DeepgramCredential" - }, - { - "$ref": "#/components/schemas/UpdateDeepInfraCredentialDTO", - "title": "DeepInfraCredential" - }, - { - "$ref": "#/components/schemas/UpdateElevenLabsCredentialDTO", - "title": "ElevenLabsCredential" - }, - { - "$ref": "#/components/schemas/UpdateGoHighLevelCredentialDTO", - "title": "GhlCredential" - }, - { - "$ref": "#/components/schemas/UpdateGroqCredentialDTO", - "title": "GroqCredential" - }, - { - "$ref": "#/components/schemas/UpdateLmntCredentialDTO", - "title": "LmntCredential" - }, - { - "$ref": "#/components/schemas/UpdateMakeCredentialDTO", - "title": "MakeCredential" - }, - { - "$ref": "#/components/schemas/UpdateOpenAICredentialDTO", - "title": "OpenAICredential" - }, - { - "$ref": "#/components/schemas/UpdateOpenRouterCredentialDTO", - "title": "OpenRouterCredential" - }, - { - "$ref": "#/components/schemas/UpdatePerplexityAICredentialDTO", - "title": "PerplexityAICredential" - }, - { - "$ref": "#/components/schemas/UpdatePlayHTCredentialDTO", - "title": "PlayHTCredential" - }, - { - "$ref": "#/components/schemas/UpdateRimeAICredentialDTO", - "title": "RimeAICredential" - }, - { - "$ref": "#/components/schemas/UpdateRunpodCredentialDTO", - "title": "RunpodCredential" - }, - { - "$ref": "#/components/schemas/UpdateTogetherAICredentialDTO", - "title": "TogetherAICredential" - }, - { - "$ref": "#/components/schemas/UpdateTwilioCredentialDTO", - "title": "TwilioCredential" - }, - { - "$ref": "#/components/schemas/UpdateVonageCredentialDTO", - "title": "VonageCredential" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "11labs": "#/components/schemas/UpdateElevenLabsCredentialDTO", - "anthropic": "#/components/schemas/UpdateAnthropicCredentialDTO", - "anyscale": "#/components/schemas/UpdateAnyscaleCredentialDTO", - "azure-openai": "#/components/schemas/UpdateAzureOpenAICredentialDTO", - "cartesia": "#/components/schemas/UpdateCartesiaCredentialDTO", - "custom-llm": "#/components/schemas/UpdateCustomLLMCredentialDTO", - "deepgram": "#/components/schemas/UpdateDeepgramCredentialDTO", - "deepinfra": "#/components/schemas/UpdateDeepInfraCredentialDTO", - "gohighlevel": "#/components/schemas/UpdateGoHighLevelCredentialDTO", - "groq": "#/components/schemas/UpdateGroqCredentialDTO", - "lmnt": "#/components/schemas/UpdateLmntCredentialDTO", - "make": "#/components/schemas/UpdateMakeCredentialDTO", - "openai": "#/components/schemas/UpdateOpenAICredentialDTO", - "openrouter": "#/components/schemas/UpdateOpenRouterCredentialDTO", - "perplexity-ai": "#/components/schemas/UpdatePerplexityAICredentialDTO", - "playht": "#/components/schemas/UpdatePlayHTCredentialDTO", - "rime-ai": "#/components/schemas/UpdateRimeAICredentialDTO", - "runpod": "#/components/schemas/UpdateRunpodCredentialDTO", - "together-ai": "#/components/schemas/UpdateTogetherAICredentialDTO", - "twilio": "#/components/schemas/UpdateTwilioCredentialDTO", - "vonage": "#/components/schemas/UpdateVonageCredentialDTO" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/AnyscaleCredential", - "title": "AnyscaleCredential" - }, - { - "$ref": "#/components/schemas/AzureOpenAICredential", - "title": "AzureOpenAICredential" - }, - { - "$ref": "#/components/schemas/CartesiaCredential", - "title": "CartesiaCredential" - }, - { - "$ref": "#/components/schemas/CustomLLMCredential", - "title": "CustomLLMCredential" - }, - { - "$ref": "#/components/schemas/DeepgramCredential", - "title": "DeepgramCredential" - }, - { - "$ref": "#/components/schemas/DeepInfraCredential", - "title": "DeepInfraCredential" - }, - { - "$ref": "#/components/schemas/ElevenLabsCredential", - "title": "ElevenLabsCredential" - }, - { - "$ref": "#/components/schemas/GoHighLevelCredential", - "title": "GhlCredential" - }, - { - "$ref": "#/components/schemas/UpdateGroqCredentialDTO", - "title": "GroqCredential" - }, - { - "$ref": "#/components/schemas/LmntCredential", - "title": "LmntCredential" - }, - { - "$ref": "#/components/schemas/MakeCredential", - "title": "MakeCredential" - }, - { - "$ref": "#/components/schemas/OpenAICredential", - "title": "OpenAICredential" - }, - { - "$ref": "#/components/schemas/OpenRouterCredential", - "title": "OpenRouterCredential" - }, - { - "$ref": "#/components/schemas/PerplexityAICredential", - "title": "PerplexityAICredential" - }, - { - "$ref": "#/components/schemas/PlayHTCredential", - "title": "PlayHTCredential" - }, - { - "$ref": "#/components/schemas/RimeAICredential", - "title": "RimeAICredential" - }, - { - "$ref": "#/components/schemas/UpdateAnthropicCredentialDTO", - "title": "AnthropicCredential" - }, - { - "$ref": "#/components/schemas/UpdateRunpodCredentialDTO", - "title": "RunpodCredential" - }, - { - "$ref": "#/components/schemas/TogetherAICredential", - "title": "TogetherAICredential" - }, - { - "$ref": "#/components/schemas/TwilioCredential", - "title": "TwilioCredential" - }, - { - "$ref": "#/components/schemas/UpdateVonageCredentialDTO", - "title": "VonageCredential" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "11labs": "#/components/schemas/ElevenLabsCredential", - "anthropic": "#/components/schemas/AnthropicCredential", - "anyscale": "#/components/schemas/AnyscaleCredential", - "azure-openai": "#/components/schemas/AzureOpenAICredential", - "cartesia": "#/components/schemas/CartesiaCredential", - "custom-llm": "#/components/schemas/CustomLLMCredential", - "deepgram": "#/components/schemas/DeepgramCredential", - "deepinfra": "#/components/schemas/DeepInfraCredential", - "gohighlevel": "#/components/schemas/GoHighLevelCredential", - "groq": "#/components/schemas/GroqCredential", - "lmnt": "#/components/schemas/LmntCredential", - "make": "#/components/schemas/MakeCredential", - "openai": "#/components/schemas/OpenAICredential", - "openrouter": "#/components/schemas/OpenRouterCredential", - "perplexity-ai": "#/components/schemas/PerplexityAICredential", - "playht": "#/components/schemas/PlayHTCredential", - "rime-ai": "#/components/schemas/RimeAICredential", - "runpod": "#/components/schemas/RunpodCredential", - "together-ai": "#/components/schemas/TogetherAICredential", - "twilio": "#/components/schemas/TwilioCredential", - "vonage": "#/components/schemas/VonageCredential" - } - } - } - } - } - } - }, - "tags": [ - "Credentials" - ], - "security": [ - { - "bearer": [] - } - ] - }, - "delete": { - "operationId": "CredentialController_remove", - "summary": "Delete Credential", - "parameters": [ - { - "name": "id", - "required": true, - "in": "path", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/AnyscaleCredential", - "title": "AnyscaleCredential" - }, - { - "$ref": "#/components/schemas/AzureOpenAICredential", - "title": "AzureOpenAICredential" - }, - { - "$ref": "#/components/schemas/CartesiaCredential", - "title": "CartesiaCredential" - }, - { - "$ref": "#/components/schemas/CustomLLMCredential", - "title": "CustomLLMCredential" - }, - { - "$ref": "#/components/schemas/DeepgramCredential", - "title": "DeepgramCredential" - }, - { - "$ref": "#/components/schemas/DeepInfraCredential", - "title": "DeepInfraCredential" - }, - { - "$ref": "#/components/schemas/ElevenLabsCredential", - "title": "ElevenLabsCredential" - }, - { - "$ref": "#/components/schemas/GoHighLevelCredential", - "title": "GhlCredential" - }, - { - "$ref": "#/components/schemas/UpdateGroqCredentialDTO", - "title": "GroqCredential" - }, - { - "$ref": "#/components/schemas/LmntCredential", - "title": "LmntCredential" - }, - { - "$ref": "#/components/schemas/MakeCredential", - "title": "MakeCredential" - }, - { - "$ref": "#/components/schemas/OpenAICredential", - "title": "OpenAICredential" - }, - { - "$ref": "#/components/schemas/OpenRouterCredential", - "title": "OpenRouterCredential" - }, - { - "$ref": "#/components/schemas/PerplexityAICredential", - "title": "PerplexityAICredential" - }, - { - "$ref": "#/components/schemas/PlayHTCredential", - "title": "PlayHTCredential" - }, - { - "$ref": "#/components/schemas/RimeAICredential", - "title": "RimeAICredential" - }, - { - "$ref": "#/components/schemas/UpdateAnthropicCredentialDTO", - "title": "AnthropicCredential" - }, - { - "$ref": "#/components/schemas/UpdateRunpodCredentialDTO", - "title": "RunpodCredential" - }, - { - "$ref": "#/components/schemas/TogetherAICredential", - "title": "TogetherAICredential" - }, - { - "$ref": "#/components/schemas/TwilioCredential", - "title": "TwilioCredential" - }, - { - "$ref": "#/components/schemas/UpdateVonageCredentialDTO", - "title": "VonageCredential" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "11labs": "#/components/schemas/ElevenLabsCredential", - "anthropic": "#/components/schemas/AnthropicCredential", - "anyscale": "#/components/schemas/AnyscaleCredential", - "azure-openai": "#/components/schemas/AzureOpenAICredential", - "cartesia": "#/components/schemas/CartesiaCredential", - "custom-llm": "#/components/schemas/CustomLLMCredential", - "deepgram": "#/components/schemas/DeepgramCredential", - "deepinfra": "#/components/schemas/DeepInfraCredential", - "gohighlevel": "#/components/schemas/GoHighLevelCredential", - "groq": "#/components/schemas/GroqCredential", - "lmnt": "#/components/schemas/LmntCredential", - "make": "#/components/schemas/MakeCredential", - "openai": "#/components/schemas/OpenAICredential", - "openrouter": "#/components/schemas/OpenRouterCredential", - "perplexity-ai": "#/components/schemas/PerplexityAICredential", - "playht": "#/components/schemas/PlayHTCredential", - "rime-ai": "#/components/schemas/RimeAICredential", - "runpod": "#/components/schemas/RunpodCredential", - "together-ai": "#/components/schemas/TogetherAICredential", - "twilio": "#/components/schemas/TwilioCredential", - "vonage": "#/components/schemas/VonageCredential" - } - } - } - } - } - } - }, - "tags": [ - "Credentials" - ], - "security": [ - { - "bearer": [] - } - ] - } - }, - "/squad": { - "post": { - "operationId": "SquadController_create", - "summary": "Create Squad", - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateSquadDTO" - } - } - } - }, - "responses": { - "201": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Squad" - } - } - } - } - }, - "tags": [ - "Squads" - ], - "security": [ - { - "bearer": [] - } - ] - }, - "get": { - "operationId": "SquadController_findAll", - "summary": "List Squads", - "parameters": [ - { - "name": "limit", - "required": false, - "in": "query", - "description": "This is the maximum number of items to return. Defaults to 100.", - "schema": { - "minimum": 0, - "maximum": 1000, - "type": "number" - } - }, - { - "name": "createdAtGt", - "required": false, - "in": "query", - "description": "This will return items where the createdAt is greater than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "name": "createdAtLt", - "required": false, - "in": "query", - "description": "This will return items where the createdAt is less than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "name": "createdAtGe", - "required": false, - "in": "query", - "description": "This will return items where the createdAt is greater than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "name": "createdAtLe", - "required": false, - "in": "query", - "description": "This will return items where the createdAt is less than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "name": "updatedAtGt", - "required": false, - "in": "query", - "description": "This will return items where the updatedAt is greater than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "name": "updatedAtLt", - "required": false, - "in": "query", - "description": "This will return items where the updatedAt is less than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "name": "updatedAtGe", - "required": false, - "in": "query", - "description": "This will return items where the updatedAt is greater than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "name": "updatedAtLe", - "required": false, - "in": "query", - "description": "This will return items where the updatedAt is less than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Squad" - } - } - } - } - } - }, - "tags": [ - "Squads" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Squads"], + "security": [{ "bearer": [] }] } }, "/squad/{id}": { @@ -1768,9 +516,7 @@ "name": "id", "required": true, "in": "path", - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "responses": { @@ -1778,21 +524,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/Squad" - } + "schema": { "$ref": "#/components/schemas/Squad" } } } } }, - "tags": [ - "Squads" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Squads"], + "security": [{ "bearer": [] }] }, "patch": { "operationId": "SquadController_update", @@ -1802,18 +540,14 @@ "name": "id", "required": true, "in": "path", - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateSquadDTO" - } + "schema": { "$ref": "#/components/schemas/UpdateSquadDTO" } } } }, @@ -1822,21 +556,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/Squad" - } + "schema": { "$ref": "#/components/schemas/Squad" } } } } }, - "tags": [ - "Squads" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Squads"], + "security": [{ "bearer": [] }] }, "delete": { "operationId": "SquadController_remove", @@ -1846,9 +572,7 @@ "name": "id", "required": true, "in": "path", - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "responses": { @@ -1856,21 +580,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/Squad" - } + "schema": { "$ref": "#/components/schemas/Squad" } } } } }, - "tags": [ - "Squads" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Squads"], + "security": [{ "bearer": [] }] } }, "/phone-number/buy": { @@ -1882,9 +598,7 @@ "required": true, "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/BuyPhoneNumberDTO" - } + "schema": { "$ref": "#/components/schemas/BuyPhoneNumberDTO" } } } }, @@ -1893,21 +607,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/PhoneNumber" - } + "schema": { "$ref": "#/components/schemas/PhoneNumber" } } } } }, - "tags": [ - "Phone Numbers" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Phone Numbers"], + "security": [{ "bearer": [] }] } }, "/phone-number/import/twilio": { @@ -1930,21 +636,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/PhoneNumber" - } + "schema": { "$ref": "#/components/schemas/PhoneNumber" } } } } }, - "tags": [ - "Phone Numbers" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Phone Numbers"], + "security": [{ "bearer": [] }] } }, "/phone-number/import/vonage": { @@ -1967,21 +665,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/PhoneNumber" - } + "schema": { "$ref": "#/components/schemas/PhoneNumber" } } } } }, - "tags": [ - "Phone Numbers" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Phone Numbers"], + "security": [{ "bearer": [] }] } }, "/phone-number": { @@ -1993,9 +683,7 @@ "required": true, "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/CreatePhoneNumberDTO" - } + "schema": { "$ref": "#/components/schemas/CreatePhoneNumberDTO" } } } }, @@ -2004,21 +692,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/PhoneNumber" - } + "schema": { "$ref": "#/components/schemas/PhoneNumber" } } } } }, - "tags": [ - "Phone Numbers" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Phone Numbers"], + "security": [{ "bearer": [] }] }, "get": { "operationId": "PhoneNumberController_findAll", @@ -2029,91 +709,63 @@ "required": false, "in": "query", "description": "This is the maximum number of items to return. Defaults to 100.", - "schema": { - "minimum": 0, - "maximum": 1000, - "type": "number" - } + "schema": { "minimum": 0, "maximum": 1000, "type": "number" } }, { "name": "createdAtGt", "required": false, "in": "query", "description": "This will return items where the createdAt is greater than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "createdAtLt", "required": false, "in": "query", "description": "This will return items where the createdAt is less than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "createdAtGe", "required": false, "in": "query", "description": "This will return items where the createdAt is greater than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "createdAtLe", "required": false, "in": "query", "description": "This will return items where the createdAt is less than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtGt", "required": false, "in": "query", "description": "This will return items where the updatedAt is greater than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtLt", "required": false, "in": "query", "description": "This will return items where the updatedAt is less than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtGe", "required": false, "in": "query", "description": "This will return items where the updatedAt is greater than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtLe", "required": false, "in": "query", "description": "This will return items where the updatedAt is less than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } } ], "responses": { @@ -2123,22 +775,14 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/PhoneNumber" - } + "items": { "$ref": "#/components/schemas/PhoneNumber" } } } } } }, - "tags": [ - "Phone Numbers" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Phone Numbers"], + "security": [{ "bearer": [] }] } }, "/phone-number/{id}": { @@ -2150,9 +794,7 @@ "name": "id", "required": true, "in": "path", - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "responses": { @@ -2160,21 +802,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/PhoneNumber" - } + "schema": { "$ref": "#/components/schemas/PhoneNumber" } } } } - }, - "tags": [ - "Phone Numbers" - ], - "security": [ - { - "bearer": [] - } - ] + }, + "tags": ["Phone Numbers"], + "security": [{ "bearer": [] }] }, "patch": { "operationId": "PhoneNumberController_update", @@ -2184,18 +818,14 @@ "name": "id", "required": true, "in": "path", - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdatePhoneNumberDTO" - } + "schema": { "$ref": "#/components/schemas/UpdatePhoneNumberDTO" } } } }, @@ -2204,21 +834,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/PhoneNumber" - } + "schema": { "$ref": "#/components/schemas/PhoneNumber" } } } } }, - "tags": [ - "Phone Numbers" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Phone Numbers"], + "security": [{ "bearer": [] }] }, "delete": { "operationId": "PhoneNumberController_remove", @@ -2228,9 +850,7 @@ "name": "id", "required": true, "in": "path", - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "responses": { @@ -2238,21 +858,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/PhoneNumber" - } + "schema": { "$ref": "#/components/schemas/PhoneNumber" } } } } }, - "tags": [ - "Phone Numbers" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Phone Numbers"], + "security": [{ "bearer": [] }] } }, "/metrics": { @@ -2266,29 +878,21 @@ "in": "query", "example": "PST", "description": "Convert date & and time to provided timezone. https://popsql.com/learn-sql/postgresql/how-to-convert-utc-to-local-time-zone-in-postgresql", - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "rangeStart", "required": false, "in": "query", "description": "This will include calls with a createdAt timestamp greater than or equal to the specified value.\n\nIf not provided, defaults to the org's current period start.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "rangeEnd", "required": false, "in": "query", "description": "This will include calls with a createdAt timestamp less than the specified value.\n\nIf not provided, the default value will be the current timestamp.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } } ], "responses": { @@ -2298,22 +902,14 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/Metrics" - } + "items": { "$ref": "#/components/schemas/Metrics" } } } } } }, - "tags": [ - "Metrics" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Metrics"], + "security": [{ "bearer": [] }] } }, "/log": { @@ -2325,123 +921,84 @@ "name": "callId", "required": true, "in": "query", - "schema": { - "type": "string" - } + "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "This is the page number to return. Defaults to 1.", - "schema": { - "minimum": 1, - "type": "number" - } + "schema": { "minimum": 1, "type": "number" } }, { "name": "sortOrder", "required": false, "in": "query", "description": "This is the sort order for pagination. Defaults to 'ASC'.", - "schema": { - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - } + "schema": { "enum": ["ASC", "DESC"], "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "This is the maximum number of items to return. Defaults to 100.", - "schema": { - "minimum": 0, - "maximum": 1000, - "type": "number" - } + "schema": { "minimum": 0, "maximum": 1000, "type": "number" } }, { "name": "createdAtGt", "required": false, "in": "query", "description": "This will return items where the createdAt is greater than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "createdAtLt", "required": false, "in": "query", "description": "This will return items where the createdAt is less than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "createdAtGe", "required": false, "in": "query", "description": "This will return items where the createdAt is greater than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "createdAtLe", "required": false, "in": "query", "description": "This will return items where the createdAt is less than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtGt", "required": false, "in": "query", "description": "This will return items where the updatedAt is greater than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtLt", "required": false, "in": "query", "description": "This will return items where the updatedAt is less than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtGe", "required": false, "in": "query", "description": "This will return items where the updatedAt is greater than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtLe", "required": false, "in": "query", "description": "This will return items where the updatedAt is less than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } } ], "responses": { @@ -2456,14 +1013,8 @@ } } }, - "tags": [ - "Logs" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Logs"], + "security": [{ "bearer": [] }] } }, "/tool": { @@ -2535,14 +1086,8 @@ } } }, - "tags": [ - "Tools" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Tools"], + "security": [{ "bearer": [] }] }, "get": { "operationId": "ToolController_findAll", @@ -2553,91 +1098,63 @@ "required": false, "in": "query", "description": "This is the maximum number of items to return. Defaults to 100.", - "schema": { - "minimum": 0, - "maximum": 1000, - "type": "number" - } + "schema": { "minimum": 0, "maximum": 1000, "type": "number" } }, { "name": "createdAtGt", "required": false, "in": "query", "description": "This will return items where the createdAt is greater than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "createdAtLt", "required": false, "in": "query", "description": "This will return items where the createdAt is less than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "createdAtGe", "required": false, "in": "query", "description": "This will return items where the createdAt is greater than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "createdAtLe", "required": false, "in": "query", "description": "This will return items where the createdAt is less than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtGt", "required": false, "in": "query", "description": "This will return items where the updatedAt is greater than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtLt", "required": false, "in": "query", "description": "This will return items where the updatedAt is less than the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtGe", "required": false, "in": "query", "description": "This will return items where the updatedAt is greater than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } }, { "name": "updatedAtLe", "required": false, "in": "query", "description": "This will return items where the updatedAt is less than or equal to the specified value.", - "schema": { - "format": "date-time", - "type": "string" - } + "schema": { "format": "date-time", "type": "string" } } ], "responses": { @@ -2676,14 +1193,8 @@ } } }, - "tags": [ - "Tools" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Tools"], + "security": [{ "bearer": [] }] } }, "/tool/{id}": { @@ -2695,9 +1206,7 @@ "name": "id", "required": true, "in": "path", - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "responses": { @@ -2733,14 +1242,8 @@ } } }, - "tags": [ - "Tools" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Tools"], + "security": [{ "bearer": [] }] }, "patch": { "operationId": "ToolController_update", @@ -2750,9 +1253,7 @@ "name": "id", "required": true, "in": "path", - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "requestBody": { @@ -2819,14 +1320,8 @@ } } }, - "tags": [ - "Tools" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Tools"], + "security": [{ "bearer": [] }] }, "delete": { "operationId": "ToolController_remove", @@ -2836,9 +1331,7 @@ "name": "id", "required": true, "in": "path", - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "responses": { @@ -2874,14 +1367,8 @@ } } }, - "tags": [ - "Tools" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Tools"], + "security": [{ "bearer": [] }] } }, "/file/upload": { @@ -2893,9 +1380,7 @@ "required": true, "content": { "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/CreateFileDTO" - } + "schema": { "$ref": "#/components/schemas/CreateFileDTO" } } } }, @@ -2904,24 +1389,14 @@ "description": "File uploaded successfully", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/File" - } + "schema": { "$ref": "#/components/schemas/File" } } } }, - "400": { - "description": "Invalid file" - } + "400": { "description": "Invalid file" } }, - "tags": [ - "Files" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Files"], + "security": [{ "bearer": [] }] } }, "/file": { @@ -2936,22 +1411,14 @@ "application/json": { "schema": { "type": "array", - "items": { - "$ref": "#/components/schemas/File" - } + "items": { "$ref": "#/components/schemas/File" } } } } } }, - "tags": [ - "Files" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Files"], + "security": [{ "bearer": [] }] } }, "/file/{id}": { @@ -2963,9 +1430,7 @@ "name": "id", "required": true, "in": "path", - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "responses": { @@ -2973,21 +1438,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/File" - } + "schema": { "$ref": "#/components/schemas/File" } } } } }, - "tags": [ - "Files" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Files"], + "security": [{ "bearer": [] }] }, "delete": { "operationId": "FileController_remove", @@ -2997,9 +1454,7 @@ "name": "id", "required": true, "in": "path", - "schema": { - "type": "string" - } + "schema": { "type": "string" } } ], "responses": { @@ -3007,21 +1462,13 @@ "description": "", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/File" - } + "schema": { "$ref": "#/components/schemas/File" } } } } }, - "tags": [ - "Files" - ], - "security": [ - { - "bearer": [] - } - ] + "tags": ["Files"], + "security": [{ "bearer": [] }] } } }, @@ -3029,16 +1476,10 @@ "title": "Vapi API", "description": "API for building voice assistants", "version": "1.0", - "contact": { - - } + "contact": {} }, "tags": [], - "servers": [ - { - "url": "https://api.vapi.ai" - } - ], + "servers": [{ "url": "https://api.vapi.ai" }], "components": { "securitySchemes": { "bearer": { @@ -3055,9 +1496,7 @@ "provider": { "type": "string", "description": "This is the transcription provider that will be used.", - "enum": [ - "deepgram" - ] + "enum": ["deepgram"] }, "model": { "description": "This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview", @@ -3095,9 +1534,7 @@ "base-video" ] }, - { - "type": "string" - } + { "type": "string" } ] }, "language": { @@ -3160,9 +1597,7 @@ } } }, - "required": [ - "provider" - ] + "required": ["provider"] }, "TalkscriberTranscriber": { "type": "object", @@ -3170,16 +1605,12 @@ "provider": { "type": "string", "description": "This is the transcription provider that will be used.", - "enum": [ - "talkscriber" - ] + "enum": ["talkscriber"] }, "model": { "type": "string", "description": "This is the model that will be used for the transcription.", - "enum": [ - "whisper" - ] + "enum": ["whisper"] }, "language": { "type": "string", @@ -3288,9 +1719,7 @@ ] } }, - "required": [ - "provider" - ] + "required": ["provider"] }, "Condition": { "type": "object", @@ -3306,30 +1735,17 @@ "operator": { "type": "string", "description": "This is the operator you want to use to compare the parameter and value.", - "enum": [ - "eq", - "neq", - "gt", - "gte", - "lt", - "lte" - ] + "enum": ["eq", "neq", "gt", "gte", "lt", "lte"] } }, - "required": [ - "param", - "value", - "operator" - ] + "required": ["param", "value", "operator"] }, "ToolMessageStart": { "type": "object", "properties": { "type": { "type": "string", - "enum": [ - "request-start" - ], + "enum": ["request-start"], "description": "This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used." }, "content": { @@ -3339,15 +1755,10 @@ "conditions": { "description": "This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.", "type": "array", - "items": { - "$ref": "#/components/schemas/Condition" - } + "items": { "$ref": "#/components/schemas/Condition" } } }, - "required": [ - "type", - "content" - ] + "required": ["type", "content"] }, "ToolMessageComplete": { "type": "object", @@ -3355,17 +1766,12 @@ "type": { "type": "string", "description": "This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.", - "enum": [ - "request-complete" - ] + "enum": ["request-complete"] }, "role": { "type": "string", - "description": "This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003C--- system prompt as hint\n ---\u003E model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.", - "enum": [ - "assistant", - "system" - ] + "description": "This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n <--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.", + "enum": ["assistant", "system"] }, "content": { "type": "string", @@ -3374,15 +1780,10 @@ "conditions": { "description": "This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.", "type": "array", - "items": { - "$ref": "#/components/schemas/Condition" - } + "items": { "$ref": "#/components/schemas/Condition" } } }, - "required": [ - "type", - "content" - ] + "required": ["type", "content"] }, "ToolMessageFailed": { "type": "object", @@ -3390,9 +1791,7 @@ "type": { "type": "string", "description": "This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.", - "enum": [ - "request-failed" - ] + "enum": ["request-failed"] }, "content": { "type": "string", @@ -3401,15 +1800,10 @@ "conditions": { "description": "This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.", "type": "array", - "items": { - "$ref": "#/components/schemas/Condition" - } + "items": { "$ref": "#/components/schemas/Condition" } } }, - "required": [ - "type", - "content" - ] + "required": ["type", "content"] }, "ToolMessageDelayed": { "type": "object", @@ -3417,9 +1811,7 @@ "type": { "type": "string", "description": "This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.", - "enum": [ - "request-response-delayed" - ] + "enum": ["request-response-delayed"] }, "timingMilliseconds": { "type": "number", @@ -3435,15 +1827,10 @@ "conditions": { "description": "This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.", "type": "array", - "items": { - "$ref": "#/components/schemas/Condition" - } + "items": { "$ref": "#/components/schemas/Condition" } } }, - "required": [ - "type", - "content" - ] + "required": ["type", "content"] }, "JsonSchema": { "type": "object", @@ -3475,14 +1862,10 @@ "required": { "description": "This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".", "type": "array", - "items": { - "type": "string" - } + "items": { "type": "string" } } }, - "required": [ - "type" - ] + "required": ["type"] }, "OpenAIFunctionParameters": { "type": "object", @@ -3490,9 +1873,7 @@ "type": { "type": "string", "description": "This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.", - "enum": [ - "object" - ] + "enum": ["object"] }, "properties": { "type": "object", @@ -3504,15 +1885,10 @@ "required": { "description": "This specifies the properties that are required by the function.", "type": "array", - "items": { - "type": "string" - } + "items": { "type": "string" } } }, - "required": [ - "type", - "properties" - ] + "required": ["type", "properties"] }, "OpenAIFunction": { "type": "object", @@ -3531,15 +1907,11 @@ "parameters": { "description": "These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.", "allOf": [ - { - "$ref": "#/components/schemas/OpenAIFunctionParameters" - } + { "$ref": "#/components/schemas/OpenAIFunctionParameters" } ] } }, - "required": [ - "name" - ] + "required": ["name"] }, "Server": { "type": "object", @@ -3560,9 +1932,7 @@ "description": "This is the secret you can set that Vapi will send with every request to your server. Will be sent as a header called x-vapi-secret.\n\nSame precedence logic as server." } }, - "required": [ - "url" - ] + "required": ["url"] }, "CreateDtmfToolDTO": { "type": "object", @@ -3598,31 +1968,19 @@ }, "type": { "type": "string", - "enum": [ - "dtmf" - ], + "enum": ["dtmf"], "description": "The type of tool. \"dtmf\" for DTMF tool." }, "function": { "description": "This is the function definition of the tool.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, this is a custom function definition.", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAIFunction" - } - ] + "allOf": [{ "$ref": "#/components/schemas/OpenAIFunction" }] }, "server": { "description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.", - "allOf": [ - { - "$ref": "#/components/schemas/Server" - } - ] + "allOf": [{ "$ref": "#/components/schemas/Server" }] } }, - "required": [ - "type" - ] + "required": ["type"] }, "CreateEndCallToolDTO": { "type": "object", @@ -3658,31 +2016,19 @@ }, "type": { "type": "string", - "enum": [ - "endCall" - ], + "enum": ["endCall"], "description": "The type of tool. \"endCall\" for End Call tool." }, "function": { "description": "This is the function definition of the tool.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, this is a custom function definition.", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAIFunction" - } - ] + "allOf": [{ "$ref": "#/components/schemas/OpenAIFunction" }] }, "server": { "description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.", - "allOf": [ - { - "$ref": "#/components/schemas/Server" - } - ] + "allOf": [{ "$ref": "#/components/schemas/Server" }] } }, - "required": [ - "type" - ] + "required": ["type"] }, "CreateFunctionToolDTO": { "type": "object", @@ -3718,41 +2064,25 @@ }, "type": { "type": "string", - "enum": [ - "function" - ], + "enum": ["function"], "description": "The type of tool. \"function\" for Function tool." }, "function": { "description": "This is the function definition of the tool.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, this is a custom function definition.", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAIFunction" - } - ] + "allOf": [{ "$ref": "#/components/schemas/OpenAIFunction" }] }, "server": { "description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.", - "allOf": [ - { - "$ref": "#/components/schemas/Server" - } - ] + "allOf": [{ "$ref": "#/components/schemas/Server" }] } }, - "required": [ - "type" - ] + "required": ["type"] }, "GhlToolMetadata": { "type": "object", "properties": { - "workflowId": { - "type": "string" - }, - "locationId": { - "type": "string" - } + "workflowId": { "type": "string" }, + "locationId": { "type": "string" } } }, "CreateGhlToolDTO": { @@ -3789,45 +2119,26 @@ }, "type": { "type": "string", - "enum": [ - "ghl" - ], + "enum": ["ghl"], "description": "The type of tool. \"ghl\" for GHL tool." }, - "metadata": { - "$ref": "#/components/schemas/GhlToolMetadata" - }, + "metadata": { "$ref": "#/components/schemas/GhlToolMetadata" }, "function": { "description": "This is the function definition of the tool.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, this is a custom function definition.", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAIFunction" - } - ] + "allOf": [{ "$ref": "#/components/schemas/OpenAIFunction" }] }, "server": { "description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.", - "allOf": [ - { - "$ref": "#/components/schemas/Server" - } - ] + "allOf": [{ "$ref": "#/components/schemas/Server" }] } }, - "required": [ - "type", - "metadata" - ] + "required": ["type", "metadata"] }, "MakeToolMetadata": { "type": "object", "properties": { - "scenarioId": { - "type": "number" - }, - "triggerHookId": { - "type": "number" - } + "scenarioId": { "type": "number" }, + "triggerHookId": { "type": "number" } } }, "CreateMakeToolDTO": { @@ -3864,45 +2175,25 @@ }, "type": { "type": "string", - "enum": [ - "make" - ], + "enum": ["make"], "description": "The type of tool. \"make\" for Make tool." }, - "metadata": { - "$ref": "#/components/schemas/MakeToolMetadata" - }, + "metadata": { "$ref": "#/components/schemas/MakeToolMetadata" }, "function": { "description": "This is the function definition of the tool.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, this is a custom function definition.", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAIFunction" - } - ] + "allOf": [{ "$ref": "#/components/schemas/OpenAIFunction" }] }, "server": { "description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.", - "allOf": [ - { - "$ref": "#/components/schemas/Server" - } - ] + "allOf": [{ "$ref": "#/components/schemas/Server" }] } }, - "required": [ - "type", - "metadata" - ] + "required": ["type", "metadata"] }, "AssistantTransferDestination": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "assistant" - ] - }, + "type": { "type": "string", "enum": ["assistant"] }, "assistantName": { "type": "string", "description": "This is the assistant to transfer the call to." @@ -3916,20 +2207,12 @@ "description": "This is the description of the destination, used by the AI to choose when and how to transfer the call." } }, - "required": [ - "type", - "assistantName" - ] + "required": ["type", "assistantName"] }, "PhoneNumberTransferDestination": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "phoneNumber" - ] - }, + "type": { "type": "string", "enum": ["phoneNumber"] }, "number": { "type": "string", "description": "This is the phone number to transfer the call to." @@ -3943,20 +2226,12 @@ "description": "This is the description of the destination, used by the AI to choose when and how to transfer the call." } }, - "required": [ - "type", - "number" - ] + "required": ["type", "number"] }, "SipTransferDestination": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "sip" - ] - }, + "type": { "type": "string", "enum": ["sip"] }, "sipUri": { "type": "string", "description": "This is the SIP URI to transfer the call to." @@ -3970,10 +2245,7 @@ "description": "This is the description of the destination, used by the AI to choose when and how to transfer the call." } }, - "required": [ - "type", - "sipUri" - ] + "required": ["type", "sipUri"] }, "CreateTransferCallToolDTO": { "type": "object", @@ -4007,12 +2279,7 @@ ] } }, - "type": { - "type": "string", - "enum": [ - "transferCall" - ] - }, + "type": { "type": "string", "enum": ["transferCall"] }, "destinations": { "type": "array", "description": "These are the destinations that the call can be transferred to. If no destinations are provided, server.url will be used to get the transfer destination once the tool is called.", @@ -4035,73 +2302,34 @@ }, "function": { "description": "This is the function definition of the tool.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, this is a custom function definition.", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAIFunction" - } - ] + "allOf": [{ "$ref": "#/components/schemas/OpenAIFunction" }] }, "server": { "description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.", - "allOf": [ - { - "$ref": "#/components/schemas/Server" - } - ] + "allOf": [{ "$ref": "#/components/schemas/Server" }] } }, - "required": [ - "type" - ] + "required": ["type"] }, "OpenAIMessage": { "type": "object", "properties": { - "content": { - "type": "string", - "nullable": true - }, + "content": { "type": "string", "nullable": true }, "role": { "type": "string", - "enum": [ - "assistant", - "function", - "user", - "system", - "tool" - ] + "enum": ["assistant", "function", "user", "system", "tool"] } }, - "required": [ - "content", - "role" - ] + "required": ["content", "role"] }, "KnowledgeBase": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "canonical" - ] - }, - "topK": { - "type": "number", - "minimum": 1, - "maximum": 10 - }, - "fileIds": { - "type": "array", - "items": { - "type": "string" - } - } + "provider": { "type": "string", "enum": ["canonical"] }, + "topK": { "type": "number", "minimum": 1, "maximum": 10 }, + "fileIds": { "type": "array", "items": { "type": "string" } } }, - "required": [ - "provider", - "fileIds" - ] + "required": ["provider", "fileIds"] }, "AnyscaleModel": { "type": "object", @@ -4109,9 +2337,7 @@ "messages": { "description": "This is the starting state for the conversation.", "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAIMessage" - } + "items": { "$ref": "#/components/schemas/OpenAIMessage" } }, "tools": { "type": "array", @@ -4148,16 +2374,9 @@ "toolIds": { "description": "These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.", "type": "array", - "items": { - "type": "string" - } - }, - "provider": { - "type": "string", - "enum": [ - "anyscale" - ] + "items": { "type": "string" } }, + "provider": { "type": "string", "enum": ["anyscale"] }, "model": { "type": "string", "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b" @@ -4170,11 +2389,7 @@ }, "knowledgeBase": { "description": "These are the options for the knowledge base.", - "allOf": [ - { - "$ref": "#/components/schemas/KnowledgeBase" - } - ] + "allOf": [{ "$ref": "#/components/schemas/KnowledgeBase" }] }, "maxTokens": { "type": "number", @@ -4187,10 +2402,7 @@ "description": "This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text." } }, - "required": [ - "provider", - "model" - ] + "required": ["provider", "model"] }, "AnthropicModel": { "type": "object", @@ -4198,9 +2410,7 @@ "messages": { "description": "This is the starting state for the conversation.", "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAIMessage" - } + "items": { "$ref": "#/components/schemas/OpenAIMessage" } }, "tools": { "type": "array", @@ -4237,9 +2447,7 @@ "toolIds": { "description": "These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.", "type": "array", - "items": { - "type": "string" - } + "items": { "type": "string" } }, "model": { "type": "string", @@ -4250,12 +2458,7 @@ "claude-3-haiku-20240307" ] }, - "provider": { - "type": "string", - "enum": [ - "anthropic" - ] - }, + "provider": { "type": "string", "enum": ["anthropic"] }, "temperature": { "type": "number", "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.", @@ -4264,11 +2467,7 @@ }, "knowledgeBase": { "description": "These are the options for the knowledge base.", - "allOf": [ - { - "$ref": "#/components/schemas/KnowledgeBase" - } - ] + "allOf": [{ "$ref": "#/components/schemas/KnowledgeBase" }] }, "maxTokens": { "type": "number", @@ -4281,10 +2480,7 @@ "description": "This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text." } }, - "required": [ - "model", - "provider" - ] + "required": ["model", "provider"] }, "CustomLLMModel": { "type": "object", @@ -4292,9 +2488,7 @@ "messages": { "description": "This is the starting state for the conversation.", "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAIMessage" - } + "items": { "$ref": "#/components/schemas/OpenAIMessage" } }, "tools": { "type": "array", @@ -4331,16 +2525,12 @@ "toolIds": { "description": "These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.", "type": "array", - "items": { - "type": "string" - } + "items": { "type": "string" } }, "provider": { "type": "string", "description": "This is the provider that will be used for the model. Any service, including your own server, that is compatible with the OpenAI API can be used.", - "enum": [ - "custom-llm" - ] + "enum": ["custom-llm"] }, "url": { "type": "string", @@ -4362,11 +2552,7 @@ }, "knowledgeBase": { "description": "These are the options for the knowledge base.", - "allOf": [ - { - "$ref": "#/components/schemas/KnowledgeBase" - } - ] + "allOf": [{ "$ref": "#/components/schemas/KnowledgeBase" }] }, "maxTokens": { "type": "number", @@ -4379,12 +2565,7 @@ "description": "This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text." } }, - "required": [ - "provider", - "url", - "urlRequestMetadataEnabled", - "model" - ] + "required": ["provider", "url", "urlRequestMetadataEnabled", "model"] }, "DeepInfraModel": { "type": "object", @@ -4392,9 +2573,7 @@ "messages": { "description": "This is the starting state for the conversation.", "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAIMessage" - } + "items": { "$ref": "#/components/schemas/OpenAIMessage" } }, "tools": { "type": "array", @@ -4431,16 +2610,9 @@ "toolIds": { "description": "These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.", "type": "array", - "items": { - "type": "string" - } - }, - "provider": { - "type": "string", - "enum": [ - "deepinfra" - ] + "items": { "type": "string" } }, + "provider": { "type": "string", "enum": ["deepinfra"] }, "model": { "type": "string", "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b" @@ -4453,11 +2625,7 @@ }, "knowledgeBase": { "description": "These are the options for the knowledge base.", - "allOf": [ - { - "$ref": "#/components/schemas/KnowledgeBase" - } - ] + "allOf": [{ "$ref": "#/components/schemas/KnowledgeBase" }] }, "maxTokens": { "type": "number", @@ -4470,10 +2638,7 @@ "description": "This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text." } }, - "required": [ - "provider", - "model" - ] + "required": ["provider", "model"] }, "GroqModel": { "type": "object", @@ -4481,9 +2646,7 @@ "messages": { "description": "This is the starting state for the conversation.", "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAIMessage" - } + "items": { "$ref": "#/components/schemas/OpenAIMessage" } }, "tools": { "type": "array", @@ -4520,25 +2683,14 @@ "toolIds": { "description": "These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.", "type": "array", - "items": { - "type": "string" - } + "items": { "type": "string" } }, "model": { "type": "string", "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b", - "enum": [ - "mixtral-8x7b-32768", - "llama3-8b-8192", - "llama3-70b-8192" - ] - }, - "provider": { - "type": "string", - "enum": [ - "groq" - ] + "enum": ["mixtral-8x7b-32768", "llama3-8b-8192", "llama3-70b-8192"] }, + "provider": { "type": "string", "enum": ["groq"] }, "temperature": { "type": "number", "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.", @@ -4547,11 +2699,7 @@ }, "knowledgeBase": { "description": "These are the options for the knowledge base.", - "allOf": [ - { - "$ref": "#/components/schemas/KnowledgeBase" - } - ] + "allOf": [{ "$ref": "#/components/schemas/KnowledgeBase" }] }, "maxTokens": { "type": "number", @@ -4564,10 +2712,7 @@ "description": "This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text." } }, - "required": [ - "model", - "provider" - ] + "required": ["model", "provider"] }, "OpenAIModel": { "type": "object", @@ -4575,9 +2720,7 @@ "messages": { "description": "This is the starting state for the conversation.", "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAIMessage" - } + "items": { "$ref": "#/components/schemas/OpenAIMessage" } }, "tools": { "type": "array", @@ -4614,16 +2757,12 @@ "toolIds": { "description": "These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.", "type": "array", - "items": { - "type": "string" - } + "items": { "type": "string" } }, "provider": { "type": "string", "description": "This is the provider that will be used for the model.", - "enum": [ - "openai" - ] + "enum": ["openai"] }, "model": { "type": "string", @@ -4664,10 +2803,7 @@ "gpt-3.5-turbo-16k", "gpt-3.5-turbo-0613" ], - "example": [ - "gpt-4-0125-preview", - "gpt-4-0613" - ], + "example": ["gpt-4-0125-preview", "gpt-4-0613"], "items": { "type": "string", "enum": [ @@ -4688,10 +2824,7 @@ ] } }, - "semanticCachingEnabled": { - "type": "boolean", - "example": true - }, + "semanticCachingEnabled": { "type": "boolean", "example": true }, "numFastTurns": { "type": "number", "description": "This sets how many turns at the start of the conversation to use gpt-3.5-turbo before switching to the primary model. Default is 0.", @@ -4705,11 +2838,7 @@ }, "knowledgeBase": { "description": "These are the options for the knowledge base.", - "allOf": [ - { - "$ref": "#/components/schemas/KnowledgeBase" - } - ] + "allOf": [{ "$ref": "#/components/schemas/KnowledgeBase" }] }, "maxTokens": { "type": "number", @@ -4722,10 +2851,7 @@ "description": "This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text." } }, - "required": [ - "provider", - "model" - ] + "required": ["provider", "model"] }, "OpenRouterModel": { "type": "object", @@ -4733,9 +2859,7 @@ "messages": { "description": "This is the starting state for the conversation.", "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAIMessage" - } + "items": { "$ref": "#/components/schemas/OpenAIMessage" } }, "tools": { "type": "array", @@ -4772,16 +2896,9 @@ "toolIds": { "description": "These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.", "type": "array", - "items": { - "type": "string" - } - }, - "provider": { - "type": "string", - "enum": [ - "openrouter" - ] + "items": { "type": "string" } }, + "provider": { "type": "string", "enum": ["openrouter"] }, "model": { "type": "string", "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b" @@ -4794,11 +2911,7 @@ }, "knowledgeBase": { "description": "These are the options for the knowledge base.", - "allOf": [ - { - "$ref": "#/components/schemas/KnowledgeBase" - } - ] + "allOf": [{ "$ref": "#/components/schemas/KnowledgeBase" }] }, "maxTokens": { "type": "number", @@ -4811,10 +2924,7 @@ "description": "This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text." } }, - "required": [ - "provider", - "model" - ] + "required": ["provider", "model"] }, "PerplexityAIModel": { "type": "object", @@ -4822,9 +2932,7 @@ "messages": { "description": "This is the starting state for the conversation.", "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAIMessage" - } + "items": { "$ref": "#/components/schemas/OpenAIMessage" } }, "tools": { "type": "array", @@ -4861,16 +2969,9 @@ "toolIds": { "description": "These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.", "type": "array", - "items": { - "type": "string" - } - }, - "provider": { - "type": "string", - "enum": [ - "perplexity-ai" - ] + "items": { "type": "string" } }, + "provider": { "type": "string", "enum": ["perplexity-ai"] }, "model": { "type": "string", "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b" @@ -4883,11 +2984,7 @@ }, "knowledgeBase": { "description": "These are the options for the knowledge base.", - "allOf": [ - { - "$ref": "#/components/schemas/KnowledgeBase" - } - ] + "allOf": [{ "$ref": "#/components/schemas/KnowledgeBase" }] }, "maxTokens": { "type": "number", @@ -4900,10 +2997,7 @@ "description": "This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text." } }, - "required": [ - "provider", - "model" - ] + "required": ["provider", "model"] }, "TogetherAIModel": { "type": "object", @@ -4911,9 +3005,7 @@ "messages": { "description": "This is the starting state for the conversation.", "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAIMessage" - } + "items": { "$ref": "#/components/schemas/OpenAIMessage" } }, "tools": { "type": "array", @@ -4950,16 +3042,9 @@ "toolIds": { "description": "These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.", "type": "array", - "items": { - "type": "string" - } - }, - "provider": { - "type": "string", - "enum": [ - "together-ai" - ] + "items": { "type": "string" } }, + "provider": { "type": "string", "enum": ["together-ai"] }, "model": { "type": "string", "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b" @@ -4972,11 +3057,7 @@ }, "knowledgeBase": { "description": "These are the options for the knowledge base.", - "allOf": [ - { - "$ref": "#/components/schemas/KnowledgeBase" - } - ] + "allOf": [{ "$ref": "#/components/schemas/KnowledgeBase" }] }, "maxTokens": { "type": "number", @@ -4989,17 +3070,14 @@ "description": "This determines whether we detect user's emotion while they speak and send it as an additional info to model.\n\nDefault `false` because the model is usually are good at understanding the user's emotion from text." } }, - "required": [ - "provider", - "model" - ] + "required": ["provider", "model"] }, "AzureVoice": { "type": "object", "properties": { "inputPreprocessingEnabled": { "type": "boolean", - "description": "This determines whether the model output is preprocessed into chunks before being sent to the voice provider.\n\nDefault `true` because voice generation sounds better with chunking (and reformatting them).\n\nTo send every token from the model output directly to the voice provider and rely on the voice provider's audio generation logic, set this to `false`.\n\nIf disabled, vapi-provided audio control tokens like \u003Cflush /\u003E will not work.", + "description": "This determines whether the model output is preprocessed into chunks before being sent to the voice provider.\n\nDefault `true` because voice generation sounds better with chunking (and reformatting them).\n\nTo send every token from the model output directly to the voice provider and rely on the voice provider's audio generation logic, set this to `false`.\n\nIf disabled, vapi-provided audio control tokens like will not work.", "example": true }, "inputReformattingEnabled": { @@ -5080,26 +3158,17 @@ "provider": { "type": "string", "description": "This is the voice provider that will be used.", - "enum": [ - "azure" - ] + "enum": ["azure"] }, "voiceId": { "description": "This is the provider-specific ID that will be used.", "oneOf": [ { "type": "string", - "enum": [ - "andrew", - "brian", - "emma" - ], + "enum": ["andrew", "brian", "emma"], "title": "Preset Voice Options" }, - { - "type": "string", - "title": "Azure Voice ID" - } + { "type": "string", "title": "Azure Voice ID" } ] }, "speed": { @@ -5109,17 +3178,14 @@ "maximum": 2 } }, - "required": [ - "provider", - "voiceId" - ] + "required": ["provider", "voiceId"] }, "CartesiaVoice": { "type": "object", "properties": { "inputPreprocessingEnabled": { "type": "boolean", - "description": "This determines whether the model output is preprocessed into chunks before being sent to the voice provider.\n\nDefault `true` because voice generation sounds better with chunking (and reformatting them).\n\nTo send every token from the model output directly to the voice provider and rely on the voice provider's audio generation logic, set this to `false`.\n\nIf disabled, vapi-provided audio control tokens like \u003Cflush /\u003E will not work.", + "description": "This determines whether the model output is preprocessed into chunks before being sent to the voice provider.\n\nDefault `true` because voice generation sounds better with chunking (and reformatting them).\n\nTo send every token from the model output directly to the voice provider and rely on the voice provider's audio generation logic, set this to `false`.\n\nIf disabled, vapi-provided audio control tokens like will not work.", "example": true }, "inputReformattingEnabled": { @@ -5200,26 +3266,21 @@ "provider": { "type": "string", "description": "This is the voice provider that will be used.", - "enum": [ - "cartesia" - ] + "enum": ["cartesia"] }, "voiceId": { "type": "string", "description": "This is the provider-specific ID that will be used." } }, - "required": [ - "provider", - "voiceId" - ] + "required": ["provider", "voiceId"] }, "DeepgramVoice": { "type": "object", "properties": { "inputPreprocessingEnabled": { "type": "boolean", - "description": "This determines whether the model output is preprocessed into chunks before being sent to the voice provider.\n\nDefault `true` because voice generation sounds better with chunking (and reformatting them).\n\nTo send every token from the model output directly to the voice provider and rely on the voice provider's audio generation logic, set this to `false`.\n\nIf disabled, vapi-provided audio control tokens like \u003Cflush /\u003E will not work.", + "description": "This determines whether the model output is preprocessed into chunks before being sent to the voice provider.\n\nDefault `true` because voice generation sounds better with chunking (and reformatting them).\n\nTo send every token from the model output directly to the voice provider and rely on the voice provider's audio generation logic, set this to `false`.\n\nIf disabled, vapi-provided audio control tokens like will not work.", "example": true }, "inputReformattingEnabled": { @@ -5300,9 +3361,7 @@ "provider": { "type": "string", "description": "This is the voice provider that will be used.", - "enum": [ - "deepgram" - ] + "enum": ["deepgram"] }, "voiceId": { "description": "This is the provider-specific ID that will be used.", @@ -5325,24 +3384,18 @@ ], "title": "Preset Voice Options" }, - { - "type": "string", - "title": "Deepgram Voice ID" - } + { "type": "string", "title": "Deepgram Voice ID" } ] } }, - "required": [ - "provider", - "voiceId" - ] + "required": ["provider", "voiceId"] }, "ElevenLabsVoice": { "type": "object", "properties": { "inputPreprocessingEnabled": { "type": "boolean", - "description": "This determines whether the model output is preprocessed into chunks before being sent to the voice provider.\n\nDefault `true` because voice generation sounds better with chunking (and reformatting them).\n\nTo send every token from the model output directly to the voice provider and rely on the voice provider's audio generation logic, set this to `false`.\n\nIf disabled, vapi-provided audio control tokens like \u003Cflush /\u003E will not work.", + "description": "This determines whether the model output is preprocessed into chunks before being sent to the voice provider.\n\nDefault `true` because voice generation sounds better with chunking (and reformatting them).\n\nTo send every token from the model output directly to the voice provider and rely on the voice provider's audio generation logic, set this to `false`.\n\nIf disabled, vapi-provided audio control tokens like will not work.", "example": true }, "inputReformattingEnabled": { @@ -5423,9 +3476,7 @@ "provider": { "type": "string", "description": "This is the voice provider that will be used.", - "enum": [ - "11labs" - ] + "enum": ["11labs"] }, "voiceId": { "description": "This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.", @@ -5451,10 +3502,7 @@ ], "title": "Preset Voice Options" }, - { - "type": "string", - "title": "11Labs Voice ID" - } + { "type": "string", "title": "11Labs Voice ID" } ] }, "stability": { @@ -5507,17 +3555,14 @@ "example": "eleven_turbo_v2_5" } }, - "required": [ - "provider", - "voiceId" - ] + "required": ["provider", "voiceId"] }, "LMNTVoice": { "type": "object", "properties": { "inputPreprocessingEnabled": { "type": "boolean", - "description": "This determines whether the model output is preprocessed into chunks before being sent to the voice provider.\n\nDefault `true` because voice generation sounds better with chunking (and reformatting them).\n\nTo send every token from the model output directly to the voice provider and rely on the voice provider's audio generation logic, set this to `false`.\n\nIf disabled, vapi-provided audio control tokens like \u003Cflush /\u003E will not work.", + "description": "This determines whether the model output is preprocessed into chunks before being sent to the voice provider.\n\nDefault `true` because voice generation sounds better with chunking (and reformatting them).\n\nTo send every token from the model output directly to the voice provider and rely on the voice provider's audio generation logic, set this to `false`.\n\nIf disabled, vapi-provided audio control tokens like will not work.", "example": true }, "inputReformattingEnabled": { @@ -5598,25 +3643,17 @@ "provider": { "type": "string", "description": "This is the voice provider that will be used.", - "enum": [ - "lmnt" - ] + "enum": ["lmnt"] }, "voiceId": { "description": "This is the provider-specific ID that will be used.", "oneOf": [ { "type": "string", - "enum": [ - "lily", - "daniel" - ], + "enum": ["lily", "daniel"], "title": "Preset Voice Options" }, - { - "type": "string", - "title": "LMNT Voice ID" - } + { "type": "string", "title": "LMNT Voice ID" } ] }, "speed": { @@ -5627,17 +3664,14 @@ "example": null } }, - "required": [ - "provider", - "voiceId" - ] + "required": ["provider", "voiceId"] }, "NeetsVoice": { "type": "object", "properties": { "inputPreprocessingEnabled": { "type": "boolean", - "description": "This determines whether the model output is preprocessed into chunks before being sent to the voice provider.\n\nDefault `true` because voice generation sounds better with chunking (and reformatting them).\n\nTo send every token from the model output directly to the voice provider and rely on the voice provider's audio generation logic, set this to `false`.\n\nIf disabled, vapi-provided audio control tokens like \u003Cflush /\u003E will not work.", + "description": "This determines whether the model output is preprocessed into chunks before being sent to the voice provider.\n\nDefault `true` because voice generation sounds better with chunking (and reformatting them).\n\nTo send every token from the model output directly to the voice provider and rely on the voice provider's audio generation logic, set this to `false`.\n\nIf disabled, vapi-provided audio control tokens like will not work.", "example": true }, "inputReformattingEnabled": { @@ -5718,39 +3752,28 @@ "provider": { "type": "string", "description": "This is the voice provider that will be used.", - "enum": [ - "neets" - ] + "enum": ["neets"] }, "voiceId": { "description": "This is the provider-specific ID that will be used.", "oneOf": [ { "type": "string", - "enum": [ - "vits", - "vits" - ], + "enum": ["vits", "vits"], "title": "Preset Voice Options" }, - { - "type": "string", - "title": "Neets Voice ID" - } + { "type": "string", "title": "Neets Voice ID" } ] } }, - "required": [ - "provider", - "voiceId" - ] + "required": ["provider", "voiceId"] }, "OpenAIVoice": { "type": "object", "properties": { "inputPreprocessingEnabled": { "type": "boolean", - "description": "This determines whether the model output is preprocessed into chunks before being sent to the voice provider.\n\nDefault `true` because voice generation sounds better with chunking (and reformatting them).\n\nTo send every token from the model output directly to the voice provider and rely on the voice provider's audio generation logic, set this to `false`.\n\nIf disabled, vapi-provided audio control tokens like \u003Cflush /\u003E will not work.", + "description": "This determines whether the model output is preprocessed into chunks before being sent to the voice provider.\n\nDefault `true` because voice generation sounds better with chunking (and reformatting them).\n\nTo send every token from the model output directly to the voice provider and rely on the voice provider's audio generation logic, set this to `false`.\n\nIf disabled, vapi-provided audio control tokens like will not work.", "example": true }, "inputReformattingEnabled": { @@ -5831,37 +3854,18 @@ "provider": { "type": "string", "description": "This is the voice provider that will be used.", - "enum": [ - "openai" - ] + "enum": ["openai"] }, "voiceId": { "description": "This is the provider-specific ID that will be used.", - "enum": [ - "alloy", - "echo", - "fable", - "onyx", - "nova", - "shimmer" - ], - "oneOf": [ - { - "type": "string", - "enum": [ - "alloy", - "echo", - "fable", - "onyx", - "nova", - "shimmer" - ], - "title": "Preset Voice Options" - }, + "enum": ["alloy", "echo", "fable", "onyx", "nova", "shimmer"], + "oneOf": [ { "type": "string", - "title": "OpenAI Voice ID" - } + "enum": ["alloy", "echo", "fable", "onyx", "nova", "shimmer"], + "title": "Preset Voice Options" + }, + { "type": "string", "title": "OpenAI Voice ID" } ] }, "speed": { @@ -5872,17 +3876,14 @@ "example": null } }, - "required": [ - "provider", - "voiceId" - ] + "required": ["provider", "voiceId"] }, "PlayHTVoice": { "type": "object", "properties": { "inputPreprocessingEnabled": { "type": "boolean", - "description": "This determines whether the model output is preprocessed into chunks before being sent to the voice provider.\n\nDefault `true` because voice generation sounds better with chunking (and reformatting them).\n\nTo send every token from the model output directly to the voice provider and rely on the voice provider's audio generation logic, set this to `false`.\n\nIf disabled, vapi-provided audio control tokens like \u003Cflush /\u003E will not work.", + "description": "This determines whether the model output is preprocessed into chunks before being sent to the voice provider.\n\nDefault `true` because voice generation sounds better with chunking (and reformatting them).\n\nTo send every token from the model output directly to the voice provider and rely on the voice provider's audio generation logic, set this to `false`.\n\nIf disabled, vapi-provided audio control tokens like will not work.", "example": true }, "inputReformattingEnabled": { @@ -5963,9 +3964,7 @@ "provider": { "type": "string", "description": "This is the voice provider that will be used.", - "enum": [ - "playht" - ] + "enum": ["playht"] }, "voiceId": { "description": "This is the provider-specific ID that will be used.", @@ -5986,10 +3985,7 @@ ], "title": "Preset Voice Options" }, - { - "type": "string", - "title": "PlayHT Voice ID" - } + { "type": "string", "title": "PlayHT Voice ID" } ] }, "speed": { @@ -6047,17 +4043,14 @@ "example": null } }, - "required": [ - "provider", - "voiceId" - ] + "required": ["provider", "voiceId"] }, "RimeAIVoice": { "type": "object", "properties": { "inputPreprocessingEnabled": { "type": "boolean", - "description": "This determines whether the model output is preprocessed into chunks before being sent to the voice provider.\n\nDefault `true` because voice generation sounds better with chunking (and reformatting them).\n\nTo send every token from the model output directly to the voice provider and rely on the voice provider's audio generation logic, set this to `false`.\n\nIf disabled, vapi-provided audio control tokens like \u003Cflush /\u003E will not work.", + "description": "This determines whether the model output is preprocessed into chunks before being sent to the voice provider.\n\nDefault `true` because voice generation sounds better with chunking (and reformatting them).\n\nTo send every token from the model output directly to the voice provider and rely on the voice provider's audio generation logic, set this to `false`.\n\nIf disabled, vapi-provided audio control tokens like will not work.", "example": true }, "inputReformattingEnabled": { @@ -6138,9 +4131,7 @@ "provider": { "type": "string", "description": "This is the voice provider that will be used.", - "enum": [ - "rime-ai" - ] + "enum": ["rime-ai"] }, "voiceId": { "description": "This is the provider-specific ID that will be used.", @@ -6232,19 +4223,13 @@ ], "title": "Preset Voice Options" }, - { - "type": "string", - "title": "RimeAI Voice ID" - } + { "type": "string", "title": "RimeAI Voice ID" } ] }, "model": { "type": "string", "description": "This is the model that will be used. Defaults to 'v1' when not specified.", - "enum": [ - "v1", - "mist" - ], + "enum": ["v1", "mist"], "example": "v1" }, "speed": { @@ -6254,20 +4239,12 @@ "example": null } }, - "required": [ - "provider", - "voiceId" - ] + "required": ["provider", "voiceId"] }, "TwilioVoicemailDetection": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "twilio" - ] - }, + "provider": { "type": "string", "enum": ["twilio"] }, "voicemailDetectionTypes": { "type": "array", "description": "These are the AMD messages from Twilio that are considered as voicemail. Default is ['machine_end_beep', 'machine_end_silence'].", @@ -6280,10 +4257,7 @@ "machine_end_silence", "machine_end_other" ], - "example": [ - "machine_end_beep", - "machine_end_silence" - ], + "example": ["machine_end_beep", "machine_end_silence"], "items": { "type": "string", "enum": [ @@ -6297,9 +4271,7 @@ ] } }, - "enabled": { - "type": "boolean" - }, + "enabled": { "type": "boolean" }, "machineDetectionTimeout": { "type": "number", "minimum": 3, @@ -6321,9 +4293,7 @@ "maximum": 10000 } }, - "required": [ - "provider" - ] + "required": ["provider"] }, "AnalysisPlan": { "type": "object", @@ -6377,11 +4347,7 @@ }, "structuredDataSchema": { "description": "This enforces the schema of the structured data. This output is stored in `call.analysis.structuredData`.\n\nComplete guide on JSON Schema can be found [here](https://ajv.js.org/json-schema.html#json-data-type).\n\nDisabled by default.\n\nYou can use this standalone or in combination with `structuredDataPrompt`. If both are provided, they are concatenated into appropriate instructions.", - "allOf": [ - { - "$ref": "#/components/schemas/JsonSchema" - } - ] + "allOf": [{ "$ref": "#/components/schemas/JsonSchema" }] } } }, @@ -6491,18 +4457,12 @@ "title": "RimeAIVoice" } ], - "default": { - "provider": "playht", - "voiceId": "jennifer" - } + "default": { "provider": "playht", "voiceId": "jennifer" } }, "firstMessageMode": { "type": "string", "description": "This is the mode for the first message. Default is 'assistant-speaks-first'.\n\nSpecify 'assistant-waits-for-user' to have the assistant wait for the user to speak first.", - "enum": [ - "assistant-speaks-first", - "assistant-waits-for-user" - ], + "enum": ["assistant-speaks-first", "assistant-waits-for-user"], "example": "assistant-speaks-first" }, "recordingEnabled": { @@ -6650,10 +4610,7 @@ "backgroundSound": { "type": "string", "description": "This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.", - "enum": [ - "off", - "office" - ], + "enum": ["off", "office"], "example": "office" }, "backchannelingEnabled": { @@ -6679,9 +4636,7 @@ "voicemailDetection": { "description": "These are the settings to configure or disable voicemail detection.", "allOf": [ - { - "$ref": "#/components/schemas/TwilioVoicemailDetection" - } + { "$ref": "#/components/schemas/TwilioVoicemailDetection" } ] }, "voicemailMessage": { @@ -6697,11 +4652,7 @@ "endCallPhrases": { "description": "This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.", "type": "array", - "items": { - "type": "string", - "maxLength": 35, - "minLength": 2 - } + "items": { "type": "string", "maxLength": 35, "minLength": 2 } }, "metadata": { "type": "object", @@ -6709,7 +4660,7 @@ }, "serverUrl": { "type": "string", - "description": "This is the URL Vapi will communicate with via HTTP GET and POST Requests. This is used for retrieving context, function calling, and end-of-call reports.\n\nAll requests will be sent with the call object among other things relevant to that message. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: function.serverUrl \u003E assistant.serverUrl \u003E phoneNumber.serverUrl \u003E org.serverUrl" + "description": "This is the URL Vapi will communicate with via HTTP GET and POST Requests. This is used for retrieving context, function calling, and end-of-call reports.\n\nAll requests will be sent with the call object among other things relevant to that message. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: function.serverUrl > assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl" }, "serverUrlSecret": { "type": "string", @@ -6717,19 +4668,11 @@ }, "analysisPlan": { "description": "This is the plan for analysis of assistant's calls. Stored in `call.analysis`.", - "allOf": [ - { - "$ref": "#/components/schemas/AnalysisPlan" - } - ] + "allOf": [{ "$ref": "#/components/schemas/AnalysisPlan" }] }, "artifactPlan": { "description": "This is the plan for artifacts generated during assistant's calls. Stored in `call.artifact`.", - "allOf": [ - { - "$ref": "#/components/schemas/ArtifactPlan" - } - ] + "allOf": [{ "$ref": "#/components/schemas/ArtifactPlan" }] } } }, @@ -6830,18 +4773,12 @@ "title": "RimeAIVoice" } ], - "default": { - "provider": "playht", - "voiceId": "jennifer" - } + "default": { "provider": "playht", "voiceId": "jennifer" } }, "firstMessageMode": { "type": "string", "description": "This is the mode for the first message. Default is 'assistant-speaks-first'.\n\nSpecify 'assistant-waits-for-user' to have the assistant wait for the user to speak first.", - "enum": [ - "assistant-speaks-first", - "assistant-waits-for-user" - ], + "enum": ["assistant-speaks-first", "assistant-waits-for-user"], "example": "assistant-speaks-first" }, "recordingEnabled": { @@ -6989,10 +4926,7 @@ "backgroundSound": { "type": "string", "description": "This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.", - "enum": [ - "off", - "office" - ], + "enum": ["off", "office"], "example": "office" }, "backchannelingEnabled": { @@ -7005,9 +4939,7 @@ "description": "This enables filtering of noise and background speech while the user is talking.\n\nDefault `false` while in beta.", "example": false }, - "isServerUrlSecretSet": { - "type": "object" - }, + "isServerUrlSecretSet": { "type": "object" }, "name": { "type": "string", "description": "This is the name of the assistant.\n\nThis is required when you want to transfer between assistants in a call.", @@ -7021,9 +4953,7 @@ "voicemailDetection": { "description": "These are the settings to configure or disable voicemail detection.", "allOf": [ - { - "$ref": "#/components/schemas/TwilioVoicemailDetection" - } + { "$ref": "#/components/schemas/TwilioVoicemailDetection" } ] }, "voicemailMessage": { @@ -7039,11 +4969,7 @@ "endCallPhrases": { "description": "This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.", "type": "array", - "items": { - "type": "string", - "maxLength": 35, - "minLength": 2 - } + "items": { "type": "string", "maxLength": 35, "minLength": 2 } }, "metadata": { "type": "object", @@ -7051,7 +4977,7 @@ }, "serverUrl": { "type": "string", - "description": "This is the URL Vapi will communicate with via HTTP GET and POST Requests. This is used for retrieving context, function calling, and end-of-call reports.\n\nAll requests will be sent with the call object among other things relevant to that message. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: function.serverUrl \u003E assistant.serverUrl \u003E phoneNumber.serverUrl \u003E org.serverUrl" + "description": "This is the URL Vapi will communicate with via HTTP GET and POST Requests. This is used for retrieving context, function calling, and end-of-call reports.\n\nAll requests will be sent with the call object among other things relevant to that message. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: function.serverUrl > assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl" }, "serverUrlSecret": { "type": "string", @@ -7059,19 +4985,11 @@ }, "analysisPlan": { "description": "This is the plan for analysis of assistant's calls. Stored in `call.analysis`.", - "allOf": [ - { - "$ref": "#/components/schemas/AnalysisPlan" - } - ] + "allOf": [{ "$ref": "#/components/schemas/AnalysisPlan" }] }, "artifactPlan": { "description": "This is the plan for artifacts generated during assistant's calls. Stored in `call.artifact`.", - "allOf": [ - { - "$ref": "#/components/schemas/ArtifactPlan" - } - ] + "allOf": [{ "$ref": "#/components/schemas/ArtifactPlan" }] }, "id": { "type": "string", @@ -7197,18 +5115,12 @@ "title": "RimeAIVoice" } ], - "default": { - "provider": "playht", - "voiceId": "jennifer" - } + "default": { "provider": "playht", "voiceId": "jennifer" } }, "firstMessageMode": { "type": "string", "description": "This is the mode for the first message. Default is 'assistant-speaks-first'.\n\nSpecify 'assistant-waits-for-user' to have the assistant wait for the user to speak first.", - "enum": [ - "assistant-speaks-first", - "assistant-waits-for-user" - ], + "enum": ["assistant-speaks-first", "assistant-waits-for-user"], "example": "assistant-speaks-first" }, "recordingEnabled": { @@ -7356,10 +5268,7 @@ "backgroundSound": { "type": "string", "description": "This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.", - "enum": [ - "off", - "office" - ], + "enum": ["off", "office"], "example": "office" }, "backchannelingEnabled": { @@ -7385,9 +5294,7 @@ "voicemailDetection": { "description": "These are the settings to configure or disable voicemail detection.", "allOf": [ - { - "$ref": "#/components/schemas/TwilioVoicemailDetection" - } + { "$ref": "#/components/schemas/TwilioVoicemailDetection" } ] }, "voicemailMessage": { @@ -7403,11 +5310,7 @@ "endCallPhrases": { "description": "This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.", "type": "array", - "items": { - "type": "string", - "maxLength": 35, - "minLength": 2 - } + "items": { "type": "string", "maxLength": 35, "minLength": 2 } }, "metadata": { "type": "object", @@ -7415,7 +5318,7 @@ }, "serverUrl": { "type": "string", - "description": "This is the URL Vapi will communicate with via HTTP GET and POST Requests. This is used for retrieving context, function calling, and end-of-call reports.\n\nAll requests will be sent with the call object among other things relevant to that message. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: function.serverUrl \u003E assistant.serverUrl \u003E phoneNumber.serverUrl \u003E org.serverUrl" + "description": "This is the URL Vapi will communicate with via HTTP GET and POST Requests. This is used for retrieving context, function calling, and end-of-call reports.\n\nAll requests will be sent with the call object among other things relevant to that message. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: function.serverUrl > assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl" }, "serverUrlSecret": { "type": "string", @@ -7423,19 +5326,11 @@ }, "analysisPlan": { "description": "This is the plan for analysis of assistant's calls. Stored in `call.analysis`.", - "allOf": [ - { - "$ref": "#/components/schemas/AnalysisPlan" - } - ] + "allOf": [{ "$ref": "#/components/schemas/AnalysisPlan" }] }, "artifactPlan": { "description": "This is the plan for artifacts generated during assistant's calls. Stored in `call.artifact`.", - "allOf": [ - { - "$ref": "#/components/schemas/ArtifactPlan" - } - ] + "allOf": [{ "$ref": "#/components/schemas/ArtifactPlan" }] } } }, @@ -7521,11 +5416,7 @@ }, "analysisCostBreakdown": { "description": "This is the cost of the analysis.", - "allOf": [ - { - "$ref": "#/components/schemas/AnalysisCostBreakdown" - } - ] + "allOf": [{ "$ref": "#/components/schemas/AnalysisCostBreakdown" }] } } }, @@ -7656,18 +5547,12 @@ "title": "RimeAIVoice" } ], - "default": { - "provider": "playht", - "voiceId": "jennifer" - } + "default": { "provider": "playht", "voiceId": "jennifer" } }, "firstMessageMode": { "type": "string", "description": "This is the mode for the first message. Default is 'assistant-speaks-first'.\n\nSpecify 'assistant-waits-for-user' to have the assistant wait for the user to speak first.", - "enum": [ - "assistant-speaks-first", - "assistant-waits-for-user" - ], + "enum": ["assistant-speaks-first", "assistant-waits-for-user"], "example": "assistant-speaks-first" }, "recordingEnabled": { @@ -7815,10 +5700,7 @@ "backgroundSound": { "type": "string", "description": "This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.", - "enum": [ - "off", - "office" - ], + "enum": ["off", "office"], "example": "office" }, "backchannelingEnabled": { @@ -7848,9 +5730,7 @@ "voicemailDetection": { "description": "These are the settings to configure or disable voicemail detection.", "allOf": [ - { - "$ref": "#/components/schemas/TwilioVoicemailDetection" - } + { "$ref": "#/components/schemas/TwilioVoicemailDetection" } ] }, "voicemailMessage": { @@ -7866,11 +5746,7 @@ "endCallPhrases": { "description": "This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.", "type": "array", - "items": { - "type": "string", - "maxLength": 35, - "minLength": 2 - } + "items": { "type": "string", "maxLength": 35, "minLength": 2 } }, "metadata": { "type": "object", @@ -7878,7 +5754,7 @@ }, "serverUrl": { "type": "string", - "description": "This is the URL Vapi will communicate with via HTTP GET and POST Requests. This is used for retrieving context, function calling, and end-of-call reports.\n\nAll requests will be sent with the call object among other things relevant to that message. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: function.serverUrl \u003E assistant.serverUrl \u003E phoneNumber.serverUrl \u003E org.serverUrl" + "description": "This is the URL Vapi will communicate with via HTTP GET and POST Requests. This is used for retrieving context, function calling, and end-of-call reports.\n\nAll requests will be sent with the call object among other things relevant to that message. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: function.serverUrl > assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl" }, "serverUrlSecret": { "type": "string", @@ -7886,19 +5762,11 @@ }, "analysisPlan": { "description": "This is the plan for analysis of assistant's calls. Stored in `call.analysis`.", - "allOf": [ - { - "$ref": "#/components/schemas/AnalysisPlan" - } - ] + "allOf": [{ "$ref": "#/components/schemas/AnalysisPlan" }] }, "artifactPlan": { "description": "This is the plan for artifacts generated during assistant's calls. Stored in `call.artifact`.", - "allOf": [ - { - "$ref": "#/components/schemas/ArtifactPlan" - } - ] + "allOf": [{ "$ref": "#/components/schemas/ArtifactPlan" }] } } }, @@ -7912,19 +5780,11 @@ }, "assistant": { "description": "This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead.", - "allOf": [ - { - "$ref": "#/components/schemas/CreateAssistantDTO" - } - ] + "allOf": [{ "$ref": "#/components/schemas/CreateAssistantDTO" }] }, "assistantOverrides": { "description": "Overrides for a single assistant's settings and template variables.", - "allOf": [ - { - "$ref": "#/components/schemas/AssistantOverrides" - } - ] + "allOf": [{ "$ref": "#/components/schemas/AssistantOverrides" }] }, "assistantDestinations": { "description": "These are the others assistants that this assistant can transfer to.\nThese destinations are in addition to destinations that already exist in the assistant's TransferCall tool.", @@ -7941,14 +5801,10 @@ "members": { "description": "The list of assistant members in the squad. By default, the call will start\nwith the first assistant supplied in the list.", "type": "array", - "items": { - "$ref": "#/components/schemas/SquadMemberDTO" - } + "items": { "$ref": "#/components/schemas/SquadMemberDTO" } } }, - "required": [ - "members" - ] + "required": ["members"] }, "ImportTwilioPhoneNumberDTO": { "type": "object", @@ -7977,18 +5833,14 @@ }, "serverUrl": { "type": "string", - "description": "This is the server URL where messages will be sent for calls on this number. This includes the `assistant-request` message.\n\nYou can see the shape of the messages sent in `ServerMessage`.\n\nThis overrides the `org.serverUrl`. Order of precedence: function.serverUrl \u003E assistant.serverUrl \u003E phoneNumber.serverUrl \u003E org.serverUrl." + "description": "This is the server URL where messages will be sent for calls on this number. This includes the `assistant-request` message.\n\nYou can see the shape of the messages sent in `ServerMessage`.\n\nThis overrides the `org.serverUrl`. Order of precedence: function.serverUrl > assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl." }, "serverUrlSecret": { "type": "string", "description": "This is the secret Vapi will send with every message to your server. It's sent as a header called x-vapi-secret.\n\nSame precedence logic as serverUrl." } }, - "required": [ - "twilioPhoneNumber", - "twilioAccountSid", - "twilioAuthToken" - ] + "required": ["twilioPhoneNumber", "twilioAccountSid", "twilioAuthToken"] }, "CreateCustomerDTO": { "type": "object", @@ -8019,11 +5871,7 @@ "type": { "type": "string", "description": "This is the type of call.", - "enum": [ - "inboundPhoneCall", - "outboundPhoneCall", - "webCall" - ] + "enum": ["inboundPhoneCall", "outboundPhoneCall", "webCall"] }, "messages": { "type": "array", @@ -8064,30 +5912,17 @@ "phoneCallProvider": { "type": "string", "description": "This is the provider of the call.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type.", - "enum": [ - "twilio", - "vonage", - "vapi" - ] + "enum": ["twilio", "vonage", "vapi"] }, "phoneCallTransport": { "type": "string", "description": "This is the transport of the phone call.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type.", - "enum": [ - "sip", - "pstn" - ] + "enum": ["sip", "pstn"] }, "status": { "type": "string", "description": "This is the status of the call.", - "enum": [ - "queued", - "ringing", - "in-progress", - "forwarding", - "ended" - ] + "enum": ["queued", "ringing", "in-progress", "forwarding", "ended"] }, "endedReason": { "type": "string", @@ -8209,11 +6044,7 @@ }, "costBreakdown": { "description": "This is the cost of the call in USD.", - "allOf": [ - { - "$ref": "#/components/schemas/CostBreakdown" - } - ] + "allOf": [{ "$ref": "#/components/schemas/CostBreakdown" }] }, "transcript": { "type": "string", @@ -8229,27 +6060,15 @@ }, "artifact": { "description": "This stores artifacts of the call. Customize what artifacts are created by configuring `assistant.artifactPlan`.", - "allOf": [ - { - "$ref": "#/components/schemas/Artifact" - } - ] + "allOf": [{ "$ref": "#/components/schemas/Artifact" }] }, "artifactPlan": { "description": "This is a copy of assistant artifact plan. This isn't actually stored on the call but rather just returned in POST /call/web to enable artifact creation client side.", - "allOf": [ - { - "$ref": "#/components/schemas/ArtifactPlan" - } - ] + "allOf": [{ "$ref": "#/components/schemas/ArtifactPlan" }] }, "analysis": { "description": "This is the analysis of the call. Customize the analysis by configuring `assistant.analysisPlan`.", - "allOf": [ - { - "$ref": "#/components/schemas/Analysis" - } - ] + "allOf": [{ "$ref": "#/components/schemas/Analysis" }] }, "phoneCallProviderId": { "type": "string", @@ -8266,19 +6085,11 @@ }, "assistant": { "description": "This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead.", - "allOf": [ - { - "$ref": "#/components/schemas/CreateAssistantDTO" - } - ] + "allOf": [{ "$ref": "#/components/schemas/CreateAssistantDTO" }] }, "assistantOverrides": { "description": "These are the overrides for the `assistant` or `assistantId`'s settings and template variables.", - "allOf": [ - { - "$ref": "#/components/schemas/AssistantOverrides" - } - ] + "allOf": [{ "$ref": "#/components/schemas/AssistantOverrides" }] }, "squadId": { "type": "string", @@ -8286,11 +6097,7 @@ }, "squad": { "description": "This is a squad that will be used for the call. To use an existing squad, use `squadId` instead.", - "allOf": [ - { - "$ref": "#/components/schemas/CreateSquadDTO" - } - ] + "allOf": [{ "$ref": "#/components/schemas/CreateSquadDTO" }] }, "phoneNumberId": { "type": "string", @@ -8299,9 +6106,7 @@ "phoneNumber": { "description": "This is the phone number that will be used for the call. To use an existing number, use `phoneNumberId` instead.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type.", "allOf": [ - { - "$ref": "#/components/schemas/ImportTwilioPhoneNumberDTO" - } + { "$ref": "#/components/schemas/ImportTwilioPhoneNumberDTO" } ] }, "customerId": { @@ -8310,11 +6115,7 @@ }, "customer": { "description": "This is the customer that will be called. To call an existing customer, use `customerId` instead.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type.", - "allOf": [ - { - "$ref": "#/components/schemas/CreateCustomerDTO" - } - ] + "allOf": [{ "$ref": "#/components/schemas/CreateCustomerDTO" }] }, "name": { "type": "string", @@ -8322,49 +6123,27 @@ "maxLength": 40 } }, - "required": [ - "id", - "orgId", - "createdAt", - "updatedAt" - ] + "required": ["id", "orgId", "createdAt", "updatedAt"] }, "PaginationMeta": { "type": "object", "properties": { - "itemsPerPage": { - "type": "number" - }, - "totalItems": { - "type": "number" - }, - "currentPage": { - "type": "number" - } + "itemsPerPage": { "type": "number" }, + "totalItems": { "type": "number" }, + "currentPage": { "type": "number" } }, - "required": [ - "itemsPerPage", - "totalItems", - "currentPage" - ] + "required": ["itemsPerPage", "totalItems", "currentPage"] }, "CallPaginatedResponse": { "type": "object", "properties": { "results": { "type": "array", - "items": { - "$ref": "#/components/schemas/Call" - } + "items": { "$ref": "#/components/schemas/Call" } }, - "metadata": { - "$ref": "#/components/schemas/PaginationMeta" - } + "metadata": { "$ref": "#/components/schemas/PaginationMeta" } }, - "required": [ - "results", - "metadata" - ] + "required": ["results", "metadata"] }, "CreateOutboundCallDTO": { "type": "object", @@ -8381,19 +6160,11 @@ }, "assistant": { "description": "This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead.", - "allOf": [ - { - "$ref": "#/components/schemas/CreateAssistantDTO" - } - ] + "allOf": [{ "$ref": "#/components/schemas/CreateAssistantDTO" }] }, "assistantOverrides": { "description": "These are the overrides for the `assistant` or `assistantId`'s settings and template variables.", - "allOf": [ - { - "$ref": "#/components/schemas/AssistantOverrides" - } - ] + "allOf": [{ "$ref": "#/components/schemas/AssistantOverrides" }] }, "squadId": { "type": "string", @@ -8401,11 +6172,7 @@ }, "squad": { "description": "This is a squad that will be used for the call. To use an existing squad, use `squadId` instead.", - "allOf": [ - { - "$ref": "#/components/schemas/CreateSquadDTO" - } - ] + "allOf": [{ "$ref": "#/components/schemas/CreateSquadDTO" }] }, "phoneNumberId": { "type": "string", @@ -8414,9 +6181,7 @@ "phoneNumber": { "description": "This is the phone number that will be used for the call. To use an existing number, use `phoneNumberId` instead.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type.", "allOf": [ - { - "$ref": "#/components/schemas/ImportTwilioPhoneNumberDTO" - } + { "$ref": "#/components/schemas/ImportTwilioPhoneNumberDTO" } ] }, "customerId": { @@ -8425,11 +6190,7 @@ }, "customer": { "description": "This is the customer that will be called. To call an existing customer, use `customerId` instead.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type.", - "allOf": [ - { - "$ref": "#/components/schemas/CreateCustomerDTO" - } - ] + "allOf": [{ "$ref": "#/components/schemas/CreateCustomerDTO" }] } } }, @@ -8443,19 +6204,11 @@ }, "assistant": { "description": "This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead.", - "allOf": [ - { - "$ref": "#/components/schemas/CreateAssistantDTO" - } - ] + "allOf": [{ "$ref": "#/components/schemas/CreateAssistantDTO" }] }, "assistantOverrides": { "description": "These are the overrides for the `assistant` or `assistantId`'s settings and template variables.", - "allOf": [ - { - "$ref": "#/components/schemas/AssistantOverrides" - } - ] + "allOf": [{ "$ref": "#/components/schemas/AssistantOverrides" }] }, "squadId": { "type": "string", @@ -8463,11 +6216,7 @@ }, "squad": { "description": "This is a squad that will be used for the call. To use an existing squad, use `squadId` instead.", - "allOf": [ - { - "$ref": "#/components/schemas/CreateSquadDTO" - } - ] + "allOf": [{ "$ref": "#/components/schemas/CreateSquadDTO" }] } } }, @@ -8487,9 +6236,7 @@ "members": { "description": "The list of assistant members in the squad. By default, the call will start\nwith the first assistant supplied in the list.", "type": "array", - "items": { - "$ref": "#/components/schemas/SquadMemberDTO" - } + "items": { "$ref": "#/components/schemas/SquadMemberDTO" } }, "id": { "type": "string", @@ -8510,13 +6257,7 @@ "description": "This is the ISO 8601 date-time string of when the squad was last updated." } }, - "required": [ - "members", - "id", - "orgId", - "createdAt", - "updatedAt" - ] + "required": ["members", "id", "orgId", "createdAt", "updatedAt"] }, "UpdateSquadDTO": { "type": "object", @@ -8524,24 +6265,15 @@ "members": { "description": "The list of assistant members in the squad. By default, the call will start\nwith the first assistant supplied in the list.", "type": "array", - "items": { - "$ref": "#/components/schemas/SquadMemberDTO" - } + "items": { "$ref": "#/components/schemas/SquadMemberDTO" } } }, - "required": [ - "members" - ] + "required": ["members"] }, "AnyscaleCredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "anyscale" - ] - }, + "provider": { "type": "string", "enum": ["anyscale"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." @@ -8577,12 +6309,7 @@ "AnthropicCredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "anthropic" - ] - }, + "provider": { "type": "string", "enum": ["anthropic"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." @@ -8618,12 +6345,7 @@ "AzureOpenAICredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "azure-openai" - ] - }, + "provider": { "type": "string", "enum": ["azure-openai"] }, "region": { "type": "string", "enum": [ @@ -8652,13 +6374,10 @@ "gpt-4-0125-preview", "gpt-4-1106-preview", "gpt-4-0613", - "gpt-35-turbo-0125", - "gpt-35-turbo-1106" - ], - "example": [ - "gpt-4-0125-preview", - "gpt-4-0613" + "gpt-35-turbo-0125", + "gpt-35-turbo-1106" ], + "example": ["gpt-4-0125-preview", "gpt-4-0613"], "items": { "type": "string", "enum": [ @@ -8694,9 +6413,7 @@ "type": "string", "description": "This is the ISO 8601 date-time string of when the assistant was last updated." }, - "openAIEndpoint": { - "type": "string" - } + "openAIEndpoint": { "type": "string" } }, "required": [ "provider", @@ -8713,12 +6430,7 @@ "CartesiaCredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "cartesia" - ] - }, + "provider": { "type": "string", "enum": ["cartesia"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." @@ -8754,12 +6466,7 @@ "CustomLLMCredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "custom-llm" - ] - }, + "provider": { "type": "string", "enum": ["custom-llm"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." @@ -8795,12 +6502,7 @@ "DeepgramCredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "deepgram" - ] - }, + "provider": { "type": "string", "enum": ["deepgram"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." @@ -8836,12 +6538,7 @@ "DeepInfraCredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "deepinfra" - ] - }, + "provider": { "type": "string", "enum": ["deepinfra"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." @@ -8877,12 +6574,7 @@ "ElevenLabsCredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "11labs" - ] - }, + "provider": { "type": "string", "enum": ["11labs"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." @@ -8918,12 +6610,7 @@ "GoHighLevelCredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "gohighlevel" - ] - }, + "provider": { "type": "string", "enum": ["gohighlevel"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." @@ -8959,12 +6646,7 @@ "GroqCredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "groq" - ] - }, + "provider": { "type": "string", "enum": ["groq"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." @@ -9000,12 +6682,7 @@ "LmntCredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "lmnt" - ] - }, + "provider": { "type": "string", "enum": ["lmnt"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." @@ -9041,16 +6718,8 @@ "MakeCredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "make" - ] - }, - "teamId": { - "type": "string", - "description": "Team ID" - }, + "provider": { "type": "string", "enum": ["make"] }, + "teamId": { "type": "string", "description": "Team ID" }, "region": { "type": "string", "description": "Region of your application. For example: eu1, eu2, us1, us2" @@ -9092,12 +6761,7 @@ "OpenAICredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "openai" - ] - }, + "provider": { "type": "string", "enum": ["openai"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." @@ -9133,12 +6797,7 @@ "OpenRouterCredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "openrouter" - ] - }, + "provider": { "type": "string", "enum": ["openrouter"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." @@ -9174,12 +6833,7 @@ "PerplexityAICredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "perplexity-ai" - ] - }, + "provider": { "type": "string", "enum": ["perplexity-ai"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." @@ -9215,12 +6869,7 @@ "PlayHTCredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "playht" - ] - }, + "provider": { "type": "string", "enum": ["playht"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." @@ -9243,9 +6892,7 @@ "type": "string", "description": "This is the ISO 8601 date-time string of when the assistant was last updated." }, - "userId": { - "type": "string" - } + "userId": { "type": "string" } }, "required": [ "provider", @@ -9260,12 +6907,7 @@ "RimeAICredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "rime-ai" - ] - }, + "provider": { "type": "string", "enum": ["rime-ai"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." @@ -9301,12 +6943,7 @@ "RunpodCredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "runpod" - ] - }, + "provider": { "type": "string", "enum": ["runpod"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." @@ -9344,9 +6981,7 @@ "properties": { "provider": { "type": "string", - "enum": [ - "s3" - ], + "enum": ["s3"], "description": "Credential provider. Only allowed value is s3" }, "awsAccessKeyId": { @@ -9399,12 +7034,7 @@ "TogetherAICredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "together-ai" - ] - }, + "provider": { "type": "string", "enum": ["together-ai"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." @@ -9440,12 +7070,7 @@ "TwilioCredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "twilio" - ] - }, + "provider": { "type": "string", "enum": ["twilio"] }, "authToken": { "type": "string", "description": "This is not returned in the API." @@ -9468,9 +7093,7 @@ "type": "string", "description": "This is the ISO 8601 date-time string of when the assistant was last updated." }, - "accountSid": { - "type": "string" - } + "accountSid": { "type": "string" } }, "required": [ "provider", @@ -9485,12 +7108,7 @@ "VonageCredential": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "vonage" - ] - }, + "provider": { "type": "string", "enum": ["vonage"] }, "apiSecret": { "type": "string", "description": "This is not returned in the API." @@ -9521,9 +7139,7 @@ "type": "string", "description": "This is the Vonage Application Private Key for the credential.\n\nOnly relevant for Vonage credentials." }, - "apiKey": { - "type": "string" - } + "apiKey": { "type": "string" } }, "required": [ "provider", @@ -9540,50 +7156,29 @@ "CreateAnyscaleCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "anyscale" - ] - }, + "provider": { "type": "string", "enum": ["anyscale"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "CreateAnthropicCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "anthropic" - ] - }, + "provider": { "type": "string", "enum": ["anthropic"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "CreateAzureOpenAICredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "azure-openai" - ] - }, + "provider": { "type": "string", "enum": ["azure-openai"] }, "region": { "type": "string", "enum": [ @@ -9615,10 +7210,7 @@ "gpt-35-turbo-0125", "gpt-35-turbo-1106" ], - "example": [ - "gpt-4-0125-preview", - "gpt-4-0613" - ], + "example": ["gpt-4-0125-preview", "gpt-4-0613"], "items": { "type": "string", "enum": [ @@ -9636,9 +7228,7 @@ "type": "string", "description": "This is not returned in the API." }, - "openAIEndpoint": { - "type": "string" - } + "openAIEndpoint": { "type": "string" } }, "required": [ "provider", @@ -9651,168 +7241,96 @@ "CreateCartesiaCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "cartesia" - ] - }, + "provider": { "type": "string", "enum": ["cartesia"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "CreateCustomLLMCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "custom-llm" - ] - }, + "provider": { "type": "string", "enum": ["custom-llm"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "CreateDeepgramCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "deepgram" - ] - }, + "provider": { "type": "string", "enum": ["deepgram"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "CreateDeepInfraCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "deepinfra" - ] - }, + "provider": { "type": "string", "enum": ["deepinfra"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "CreateElevenLabsCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "11labs" - ] - }, + "provider": { "type": "string", "enum": ["11labs"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "CreateGoHighLevelCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "gohighlevel" - ] - }, + "provider": { "type": "string", "enum": ["gohighlevel"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "CreateGroqCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "groq" - ] - }, + "provider": { "type": "string", "enum": ["groq"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "CreateLmntCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "lmnt" - ] - }, + "provider": { "type": "string", "enum": ["lmnt"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "CreateMakeCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "make" - ] - }, - "teamId": { - "type": "string", - "description": "Team ID" - }, + "provider": { "type": "string", "enum": ["make"] }, + "teamId": { "type": "string", "description": "Team ID" }, "region": { "type": "string", "description": "Region of your application. For example: eu1, eu2, us1, us2" @@ -9822,139 +7340,81 @@ "description": "This is not returned in the API." } }, - "required": [ - "provider", - "teamId", - "region", - "apiKey" - ] + "required": ["provider", "teamId", "region", "apiKey"] }, "CreateOpenAICredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "openai" - ] - }, + "provider": { "type": "string", "enum": ["openai"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "CreateOpenRouterCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "openrouter" - ] - }, + "provider": { "type": "string", "enum": ["openrouter"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "CreatePerplexityAICredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "perplexity-ai" - ] - }, + "provider": { "type": "string", "enum": ["perplexity-ai"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "CreatePlayHTCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "playht" - ] - }, + "provider": { "type": "string", "enum": ["playht"] }, "apiKey": { - "type": "string", - "description": "This is not returned in the API." - }, - "userId": { - "type": "string" - } - }, - "required": [ - "provider", - "apiKey", - "userId" - ] + "type": "string", + "description": "This is not returned in the API." + }, + "userId": { "type": "string" } + }, + "required": ["provider", "apiKey", "userId"] }, "CreateRimeAICredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "rime-ai" - ] - }, + "provider": { "type": "string", "enum": ["rime-ai"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "CreateRunpodCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "runpod" - ] - }, + "provider": { "type": "string", "enum": ["runpod"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "CreateS3CredentialDTO": { "type": "object", "properties": { "provider": { "type": "string", - "enum": [ - "s3" - ], + "enum": ["s3"], "description": "Credential provider. Only allowed value is s3" }, "awsAccessKeyId": { @@ -9985,115 +7445,64 @@ "CreateTogetherAICredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "together-ai" - ] - }, + "provider": { "type": "string", "enum": ["together-ai"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "CreateTwilioCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "twilio" - ] - }, + "provider": { "type": "string", "enum": ["twilio"] }, "authToken": { "type": "string", "description": "This is not returned in the API." }, - "accountSid": { - "type": "string" - } + "accountSid": { "type": "string" } }, - "required": [ - "provider", - "authToken", - "accountSid" - ] + "required": ["provider", "authToken", "accountSid"] }, "CreateVonageCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "vonage" - ] - }, + "provider": { "type": "string", "enum": ["vonage"] }, "apiSecret": { "type": "string", "description": "This is not returned in the API." }, - "apiKey": { - "type": "string" - } + "apiKey": { "type": "string" } }, - "required": [ - "provider", - "apiSecret", - "apiKey" - ] + "required": ["provider", "apiSecret", "apiKey"] }, "UpdateAnyscaleCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "anyscale" - ] - }, + "provider": { "type": "string", "enum": ["anyscale"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "UpdateAnthropicCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "anthropic" - ] - }, + "provider": { "type": "string", "enum": ["anthropic"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "UpdateAzureOpenAICredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "azure-openai" - ] - }, + "provider": { "type": "string", "enum": ["azure-openai"] }, "region": { "type": "string", "enum": [ @@ -10125,10 +7534,7 @@ "gpt-35-turbo-0125", "gpt-35-turbo-1106" ], - "example": [ - "gpt-4-0125-preview", - "gpt-4-0613" - ], + "example": ["gpt-4-0125-preview", "gpt-4-0613"], "items": { "type": "string", "enum": [ @@ -10146,9 +7552,7 @@ "type": "string", "description": "This is not returned in the API." }, - "openAIEndpoint": { - "type": "string" - } + "openAIEndpoint": { "type": "string" } }, "required": [ "provider", @@ -10161,168 +7565,96 @@ "UpdateCartesiaCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "cartesia" - ] - }, + "provider": { "type": "string", "enum": ["cartesia"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "UpdateCustomLLMCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "custom-llm" - ] - }, + "provider": { "type": "string", "enum": ["custom-llm"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "UpdateDeepInfraCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "deepinfra" - ] - }, + "provider": { "type": "string", "enum": ["deepinfra"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "UpdateDeepgramCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "deepgram" - ] - }, + "provider": { "type": "string", "enum": ["deepgram"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "UpdateElevenLabsCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "11labs" - ] - }, + "provider": { "type": "string", "enum": ["11labs"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "UpdateGoHighLevelCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "gohighlevel" - ] - }, + "provider": { "type": "string", "enum": ["gohighlevel"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "UpdateGroqCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "groq" - ] - }, + "provider": { "type": "string", "enum": ["groq"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "UpdateLmntCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "lmnt" - ] - }, + "provider": { "type": "string", "enum": ["lmnt"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "UpdateMakeCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "make" - ] - }, - "teamId": { - "type": "string", - "description": "Team ID" - }, + "provider": { "type": "string", "enum": ["make"] }, + "teamId": { "type": "string", "description": "Team ID" }, "region": { "type": "string", "description": "Region of your application. For example: eu1, eu2, us1, us2" @@ -10332,139 +7664,81 @@ "description": "This is not returned in the API." } }, - "required": [ - "provider", - "teamId", - "region", - "apiKey" - ] + "required": ["provider", "teamId", "region", "apiKey"] }, "UpdateOpenAICredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "openai" - ] - }, + "provider": { "type": "string", "enum": ["openai"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "UpdateOpenRouterCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "openrouter" - ] - }, + "provider": { "type": "string", "enum": ["openrouter"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "UpdatePerplexityAICredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "perplexity-ai" - ] - }, + "provider": { "type": "string", "enum": ["perplexity-ai"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "UpdatePlayHTCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "playht" - ] - }, + "provider": { "type": "string", "enum": ["playht"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." }, - "userId": { - "type": "string" - } + "userId": { "type": "string" } }, - "required": [ - "provider", - "apiKey", - "userId" - ] + "required": ["provider", "apiKey", "userId"] }, "UpdateRimeAICredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "rime-ai" - ] - }, + "provider": { "type": "string", "enum": ["rime-ai"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "UpdateRunpodCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "runpod" - ] - }, + "provider": { "type": "string", "enum": ["runpod"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "UpdateS3CredentialDTO": { "type": "object", "properties": { "provider": { "type": "string", - "enum": [ - "s3" - ], + "enum": ["s3"], "description": "Credential provider. Only allowed value is s3" }, "awsAccessKeyId": { @@ -10495,67 +7769,37 @@ "UpdateTogetherAICredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "together-ai" - ] - }, + "provider": { "type": "string", "enum": ["together-ai"] }, "apiKey": { "type": "string", "description": "This is not returned in the API." } }, - "required": [ - "provider", - "apiKey" - ] + "required": ["provider", "apiKey"] }, "UpdateTwilioCredentialDTO": { "type": "object", "properties": { - "provider": { - "type": "string", - "enum": [ - "twilio" - ] - }, + "provider": { "type": "string", "enum": ["twilio"] }, "authToken": { "type": "string", "description": "This is not returned in the API." }, - "accountSid": { - "type": "string" - } + "accountSid": { "type": "string" } }, - "required": [ - "provider", - "authToken", - "accountSid" - ] + "required": ["provider", "authToken", "accountSid"] }, - "UpdateVonageCredentialDTO": { - "type": "object", - "properties": { - "provider": { - "type": "string", - "enum": [ - "vonage" - ] - }, + "UpdateVonageCredentialDTO": { + "type": "object", + "properties": { + "provider": { "type": "string", "enum": ["vonage"] }, "apiSecret": { "type": "string", "description": "This is not returned in the API." }, - "apiKey": { - "type": "string" - } + "apiKey": { "type": "string" } }, - "required": [ - "provider", - "apiSecret", - "apiKey" - ] + "required": ["provider", "apiSecret", "apiKey"] }, "CreateOrgDTO": { "type": "object", @@ -10661,11 +7905,7 @@ "maximum": 10 } }, - "required": [ - "id", - "createdAt", - "updatedAt" - ] + "required": ["id", "createdAt", "updatedAt"] }, "UpdateOrgDTO": { "type": "object", @@ -10728,23 +7968,12 @@ "description": "This is the full name of the user that is associated with the profile." } }, - "required": [ - "id", - "createdAt", - "updatedAt", - "email" - ] + "required": ["id", "createdAt", "updatedAt", "email"] }, "InviteUserDTO": { "type": "object", - "properties": { - "email": { - "type": "string" - } - }, - "required": [ - "email" - ] + "properties": { "email": { "type": "string" } }, + "required": ["email"] }, "BuyPhoneNumberDTO": { "type": "object", @@ -10767,16 +7996,14 @@ }, "serverUrl": { "type": "string", - "description": "This is the server URL where messages will be sent for calls on this number. This includes the `assistant-request` message.\n\nYou can see the shape of the messages sent in `ServerMessage`.\n\nThis overrides the `org.serverUrl`. Order of precedence: function.serverUrl \u003E assistant.serverUrl \u003E phoneNumber.serverUrl \u003E org.serverUrl." + "description": "This is the server URL where messages will be sent for calls on this number. This includes the `assistant-request` message.\n\nYou can see the shape of the messages sent in `ServerMessage`.\n\nThis overrides the `org.serverUrl`. Order of precedence: function.serverUrl > assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl." }, "serverUrlSecret": { "type": "string", "description": "This is the secret Vapi will send with every message to your server. It's sent as a header called x-vapi-secret.\n\nSame precedence logic as serverUrl." } }, - "required": [ - "areaCode" - ] + "required": ["areaCode"] }, "PhoneNumber": { "type": "object", @@ -10784,11 +8011,7 @@ "provider": { "type": "string", "description": "This is the provider of the phone number.", - "enum": [ - "twilio", - "vonage", - "vapi" - ] + "enum": ["twilio", "vonage", "vapi"] }, "id": { "type": "string", @@ -10832,19 +8055,14 @@ }, "serverUrl": { "type": "string", - "description": "This is the server URL where messages will be sent for calls on this number. This includes the `assistant-request` message.\n\nYou can see the shape of the messages sent in `ServerMessage`.\n\nThis overrides the `org.serverUrl`. Order of precedence: function.serverUrl \u003E assistant.serverUrl \u003E phoneNumber.serverUrl \u003E org.serverUrl." + "description": "This is the server URL where messages will be sent for calls on this number. This includes the `assistant-request` message.\n\nYou can see the shape of the messages sent in `ServerMessage`.\n\nThis overrides the `org.serverUrl`. Order of precedence: function.serverUrl > assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl." }, "serverUrlSecret": { "type": "string", "description": "This is the secret Vapi will send with every message to your server. It's sent as a header called x-vapi-secret.\n\nSame precedence logic as serverUrl." } }, - "required": [ - "id", - "orgId", - "createdAt", - "updatedAt" - ] + "required": ["id", "orgId", "createdAt", "updatedAt"] }, "ImportVonagePhoneNumberDTO": { "type": "object", @@ -10869,17 +8087,14 @@ }, "serverUrl": { "type": "string", - "description": "This is the server URL where messages will be sent for calls on this number. This includes the `assistant-request` message.\n\nYou can see the shape of the messages sent in `ServerMessage`.\n\nThis overrides the `org.serverUrl`. Order of precedence: function.serverUrl \u003E assistant.serverUrl \u003E phoneNumber.serverUrl \u003E org.serverUrl." + "description": "This is the server URL where messages will be sent for calls on this number. This includes the `assistant-request` message.\n\nYou can see the shape of the messages sent in `ServerMessage`.\n\nThis overrides the `org.serverUrl`. Order of precedence: function.serverUrl > assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl." }, "serverUrlSecret": { "type": "string", "description": "This is the secret Vapi will send with every message to your server. It's sent as a header called x-vapi-secret.\n\nSame precedence logic as serverUrl." } }, - "required": [ - "vonagePhoneNumber", - "credentialId" - ] + "required": ["vonagePhoneNumber", "credentialId"] }, "CreatePhoneNumberDTO": { "type": "object", @@ -10887,9 +8102,7 @@ "provider": { "type": "string", "description": "This is the provider of the phone number.", - "enum": [ - "vapi" - ] + "enum": ["vapi"] }, "sipUri": { "type": "string", @@ -10907,17 +8120,14 @@ }, "serverUrl": { "type": "string", - "description": "This is the server URL where messages will be sent for calls on this number. This includes the `assistant-request` message.\n\nYou can see the shape of the messages sent in `ServerMessage`.\n\nThis overrides the `org.serverUrl`. Order of precedence: function.serverUrl \u003E assistant.serverUrl \u003E phoneNumber.serverUrl \u003E org.serverUrl." + "description": "This is the server URL where messages will be sent for calls on this number. This includes the `assistant-request` message.\n\nYou can see the shape of the messages sent in `ServerMessage`.\n\nThis overrides the `org.serverUrl`. Order of precedence: function.serverUrl > assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl." }, "serverUrlSecret": { "type": "string", "description": "This is the secret Vapi will send with every message to your server. It's sent as a header called x-vapi-secret.\n\nSame precedence logic as serverUrl." } }, - "required": [ - "provider", - "sipUri" - ] + "required": ["provider", "sipUri"] }, "UpdatePhoneNumberDTO": { "type": "object", @@ -10934,7 +8144,7 @@ }, "serverUrl": { "type": "string", - "description": "This is the server URL where messages will be sent for calls on this number. This includes the `assistant-request` message.\n\nYou can see the shape of the messages sent in `ServerMessage`.\n\nThis overrides the `org.serverUrl`. Order of precedence: function.serverUrl \u003E assistant.serverUrl \u003E phoneNumber.serverUrl \u003E org.serverUrl." + "description": "This is the server URL where messages will be sent for calls on this number. This includes the `assistant-request` message.\n\nYou can see the shape of the messages sent in `ServerMessage`.\n\nThis overrides the `org.serverUrl`. Order of precedence: function.serverUrl > assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl." }, "serverUrlSecret": { "type": "string", @@ -10945,48 +8155,20 @@ "Metrics": { "type": "object", "properties": { - "orgId": { - "type": "string" - }, - "rangeStart": { - "type": "string" - }, - "rangeEnd": { - "type": "string" - }, - "bill": { - "type": "number" - }, - "billWithinBillingLimit": { - "type": "boolean" - }, - "billDailyBreakdown": { - "type": "object" - }, - "callActive": { - "type": "string" - }, - "callActiveWithinConcurrencyLimit": { - "type": "boolean" - }, - "callMinutes": { - "type": "string" - }, - "callMinutesDailyBreakdown": { - "type": "object" - }, - "callMinutesAverage": { - "type": "string" - }, - "callMinutesAverageDailyBreakdown": { - "type": "object" - }, - "callCount": { - "type": "string" - }, - "callCountDailyBreakdown": { - "type": "object" - } + "orgId": { "type": "string" }, + "rangeStart": { "type": "string" }, + "rangeEnd": { "type": "string" }, + "bill": { "type": "number" }, + "billWithinBillingLimit": { "type": "boolean" }, + "billDailyBreakdown": { "type": "object" }, + "callActive": { "type": "string" }, + "callActiveWithinConcurrencyLimit": { "type": "boolean" }, + "callMinutes": { "type": "string" }, + "callMinutesDailyBreakdown": { "type": "object" }, + "callMinutesAverage": { "type": "string" }, + "callMinutesAverageDailyBreakdown": { "type": "object" }, + "callCount": { "type": "string" }, + "callCountDailyBreakdown": { "type": "object" } }, "required": [ "orgId", @@ -11031,10 +8213,7 @@ "type": "string", "description": "The unique slug of the voice." }, - "name": { - "type": "string", - "description": "The name of the voice." - }, + "name": { "type": "string", "description": "The name of the voice." }, "language": { "type": "string", "description": "The language of the voice." @@ -11054,10 +8233,7 @@ "gender": { "type": "string", "description": "The gender of the voice.", - "enum": [ - "male", - "female" - ] + "enum": ["male", "female"] }, "accent": { "type": "string", @@ -11163,13 +8339,7 @@ "level": { "type": "string", "description": "This is the level of the log message.", - "enum": [ - "INFO", - "LOG", - "WARN", - "ERROR", - "CHECKPOINT" - ] + "enum": ["INFO", "LOG", "WARN", "ERROR", "CHECKPOINT"] }, "time": { "format": "date-time", @@ -11177,31 +8347,18 @@ "description": "This is the ISO 8601 date-time string of when the log was created." } }, - "required": [ - "callId", - "orgId", - "log", - "level", - "time" - ] + "required": ["callId", "orgId", "log", "level", "time"] }, "CallLogsPaginatedResponse": { "type": "object", "properties": { "results": { "type": "array", - "items": { - "$ref": "#/components/schemas/CallLogPrivileged" - } + "items": { "$ref": "#/components/schemas/CallLogPrivileged" } }, - "metadata": { - "$ref": "#/components/schemas/PaginationMeta" - } + "metadata": { "$ref": "#/components/schemas/PaginationMeta" } }, - "required": [ - "results", - "metadata" - ] + "required": ["results", "metadata"] }, "MakeTool": { "type": "object", @@ -11237,9 +8394,7 @@ }, "type": { "type": "string", - "enum": [ - "make" - ], + "enum": ["make"], "description": "The type of tool. \"make\" for Make tool." }, "id": { @@ -11262,23 +8417,13 @@ }, "function": { "description": "This is the function definition of the tool.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, this is a custom function definition.", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAIFunction" - } - ] + "allOf": [{ "$ref": "#/components/schemas/OpenAIFunction" }] }, "server": { "description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.", - "allOf": [ - { - "$ref": "#/components/schemas/Server" - } - ] + "allOf": [{ "$ref": "#/components/schemas/Server" }] }, - "metadata": { - "$ref": "#/components/schemas/MakeToolMetadata" - } + "metadata": { "$ref": "#/components/schemas/MakeToolMetadata" } }, "required": [ "type", @@ -11323,9 +8468,7 @@ }, "type": { "type": "string", - "enum": [ - "ghl" - ], + "enum": ["ghl"], "description": "The type of tool. \"ghl\" for GHL tool." }, "id": { @@ -11348,23 +8491,13 @@ }, "function": { "description": "This is the function definition of the tool.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, this is a custom function definition.", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAIFunction" - } - ] + "allOf": [{ "$ref": "#/components/schemas/OpenAIFunction" }] }, "server": { "description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.", - "allOf": [ - { - "$ref": "#/components/schemas/Server" - } - ] + "allOf": [{ "$ref": "#/components/schemas/Server" }] }, - "metadata": { - "$ref": "#/components/schemas/GhlToolMetadata" - } + "metadata": { "$ref": "#/components/schemas/GhlToolMetadata" } }, "required": [ "type", @@ -11409,9 +8542,7 @@ }, "type": { "type": "string", - "enum": [ - "function" - ], + "enum": ["function"], "description": "The type of tool. \"function\" for Function tool." }, "id": { @@ -11434,28 +8565,14 @@ }, "function": { "description": "This is the function definition of the tool.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, this is a custom function definition.", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAIFunction" - } - ] + "allOf": [{ "$ref": "#/components/schemas/OpenAIFunction" }] }, "server": { "description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.", - "allOf": [ - { - "$ref": "#/components/schemas/Server" - } - ] + "allOf": [{ "$ref": "#/components/schemas/Server" }] } }, - "required": [ - "type", - "id", - "orgId", - "createdAt", - "updatedAt" - ] + "required": ["type", "id", "orgId", "createdAt", "updatedAt"] }, "UpdateMakeToolDTO": { "type": "object", @@ -11491,35 +8608,20 @@ }, "type": { "type": "string", - "enum": [ - "make" - ], + "enum": ["make"], "description": "The type of tool. \"make\" for Make tool." }, - "metadata": { - "$ref": "#/components/schemas/MakeToolMetadata" - }, + "metadata": { "$ref": "#/components/schemas/MakeToolMetadata" }, "function": { "description": "This is the function definition of the tool.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, this is a custom function definition.", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAIFunction" - } - ] + "allOf": [{ "$ref": "#/components/schemas/OpenAIFunction" }] }, "server": { "description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.", - "allOf": [ - { - "$ref": "#/components/schemas/Server" - } - ] + "allOf": [{ "$ref": "#/components/schemas/Server" }] } }, - "required": [ - "type", - "metadata" - ] + "required": ["type", "metadata"] }, "UpdateGhlToolDTO": { "type": "object", @@ -11555,35 +8657,20 @@ }, "type": { "type": "string", - "enum": [ - "ghl" - ], + "enum": ["ghl"], "description": "The type of tool. \"ghl\" for GHL tool." }, - "metadata": { - "$ref": "#/components/schemas/GhlToolMetadata" - }, + "metadata": { "$ref": "#/components/schemas/GhlToolMetadata" }, "function": { "description": "This is the function definition of the tool.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, this is a custom function definition.", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAIFunction" - } - ] + "allOf": [{ "$ref": "#/components/schemas/OpenAIFunction" }] }, "server": { "description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.", - "allOf": [ - { - "$ref": "#/components/schemas/Server" - } - ] + "allOf": [{ "$ref": "#/components/schemas/Server" }] } }, - "required": [ - "type", - "metadata" - ] + "required": ["type", "metadata"] }, "UpdateFunctionToolDTO": { "type": "object", @@ -11619,61 +8706,32 @@ }, "type": { "type": "string", - "enum": [ - "function" - ], + "enum": ["function"], "description": "The type of tool. \"function\" for Function tool." }, "function": { "description": "This is the function definition of the tool.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, this is a custom function definition.", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAIFunction" - } - ] + "allOf": [{ "$ref": "#/components/schemas/OpenAIFunction" }] }, "server": { "description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.", - "allOf": [ - { - "$ref": "#/components/schemas/Server" - } - ] + "allOf": [{ "$ref": "#/components/schemas/Server" }] } }, - "required": [ - "type" - ] + "required": ["type"] }, "VoiceLibraryVoiceResponse": { "type": "object", "properties": { - "voiceId": { - "type": "string" - }, - "name": { - "type": "string" - }, - "publicOwnerId": { - "type": "string" - }, - "description": { - "type": "string" - }, - "gender": { - "type": "string" - }, - "age": { - "type": "object" - }, - "accent": { - "type": "string" - } + "voiceId": { "type": "string" }, + "name": { "type": "string" }, + "publicOwnerId": { "type": "string" }, + "description": { "type": "string" }, + "gender": { "type": "string" }, + "age": { "type": "object" }, + "accent": { "type": "string" } }, - "required": [ - "voiceId", - "name" - ] + "required": ["voiceId", "name"] }, "AddVoiceToProviderDTO": { "type": "object", @@ -11691,72 +8749,32 @@ "description": "This is the new name of the voice which you want to have once you have added voice to your provider Account from Provider Voice Library" } }, - "required": [ - "ownerId", - "voiceId", - "name" - ] + "required": ["ownerId", "voiceId", "name"] }, "CreateFileDTO": { "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary" - } - }, - "required": [ - "file" - ] + "properties": { "file": { "type": "string", "format": "binary" } }, + "required": ["file"] }, "File": { "type": "object", "properties": { - "object": { - "type": "string", - "enum": [ - "file" - ] - }, - "status": { - "enum": [ - "indexed", - "not_indexed" - ], - "type": "string" - }, + "object": { "type": "string", "enum": ["file"] }, + "status": { "enum": ["indexed", "not_indexed"], "type": "string" }, "name": { "type": "string", "description": "This is the name of the file. This is just for your own reference.", "maxLength": 40 }, - "originalName": { - "type": "string" - }, - "bytes": { - "type": "number" - }, - "purpose": { - "type": "string" - }, - "mimetype": { - "type": "string" - }, - "key": { - "type": "string" - }, - "path": { - "type": "string" - }, - "bucket": { - "type": "string" - }, - "url": { - "type": "string" - }, - "metadata": { - "type": "object" - }, + "originalName": { "type": "string" }, + "bytes": { "type": "number" }, + "purpose": { "type": "string" }, + "mimetype": { "type": "string" }, + "key": { "type": "string" }, + "path": { "type": "string" }, + "bucket": { "type": "string" }, + "url": { "type": "string" }, + "metadata": { "type": "object" }, "id": { "type": "string", "description": "This is the unique identifier for the file." @@ -11776,12 +8794,7 @@ "description": "This is the ISO 8601 date-time string of when the file was last updated." } }, - "required": [ - "id", - "orgId", - "createdAt", - "updatedAt" - ] + "required": ["id", "orgId", "createdAt", "updatedAt"] }, "ConversationUpdateMessage": { "type": "object", @@ -11789,22 +8802,15 @@ "type": { "type": "string", "description": "This is the type of the message. \"conversation-update\" is sent when an update is committed to the conversation history.", - "enum": [ - "conversation-update" - ] + "enum": ["conversation-update"] }, "messagesOpenAIFormatted": { "description": "This is the most up-to-date conversation history at the time the message is sent.", "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAIMessage" - } + "items": { "$ref": "#/components/schemas/OpenAIMessage" } } }, - "required": [ - "type", - "messagesOpenAIFormatted" - ] + "required": ["type", "messagesOpenAIFormatted"] }, "FunctionCallMessage": { "type": "object", @@ -11850,19 +8856,14 @@ "type": "string", "description": "This is the type of the message. \"function-call-result\" is sent to forward the result of a function call to the client.", "deprecated": true, - "enum": [ - "function-call-result" - ] + "enum": ["function-call-result"] }, "functionCallResult": { "type": "object", "description": "This is the result of the function call." } }, - "required": [ - "type", - "functionCallResult" - ] + "required": ["type", "functionCallResult"] }, "HangMessage": { "type": "object", @@ -11870,14 +8871,10 @@ "type": { "type": "string", "description": "This is the type of the message. \"hang\" is sent when the assistant is hanging due to a delay. The delay can be caused by many factors, such as:\n- the model is too slow to respond\n- the voice is too slow to respond\n- the tool call is still waiting for a response from your server\n- etc.", - "enum": [ - "hang" - ] + "enum": ["hang"] } }, - "required": [ - "type" - ] + "required": ["type"] }, "MetadataMessage": { "type": "object", @@ -11885,19 +8882,14 @@ "type": { "type": "string", "description": "This is the type of the message. \"metadata\" is sent to forward metadata to the client.", - "enum": [ - "metadata" - ] + "enum": ["metadata"] }, "metadata": { "type": "string", "description": "This is the metadata content" } }, - "required": [ - "type", - "metadata" - ] + "required": ["type", "metadata"] }, "ModelOutputMessage": { "type": "object", @@ -11905,19 +8897,14 @@ "type": { "type": "string", "description": "This is the type of the message. \"model-output\" is sent as the model outputs tokens.", - "enum": [ - "model-output" - ] + "enum": ["model-output"] }, "output": { "type": "string", "description": "This is the output of the model." } }, - "required": [ - "type", - "output" - ] + "required": ["type", "output"] }, "SpeechUpdateMessage": { "type": "object", @@ -11925,32 +8912,20 @@ "type": { "type": "string", "description": "This is the type of the message. \"speech-update\" is sent whenever assistant or user start or stop speaking.", - "enum": [ - "speech-update" - ] + "enum": ["speech-update"] }, "status": { "type": "string", "description": "This is the status of the speech update.", - "enum": [ - "started", - "stopped" - ] + "enum": ["started", "stopped"] }, "role": { "type": "string", "description": "This is the role which the speech update is for.", - "enum": [ - "assistant", - "user" - ] + "enum": ["assistant", "user"] } }, - "required": [ - "type", - "status", - "role" - ] + "required": ["type", "status", "role"] }, "UserMessage": { "type": "object", @@ -11980,13 +8955,7 @@ "description": "The duration of the message in seconds." } }, - "required": [ - "role", - "message", - "time", - "endTime", - "secondsFromStart" - ] + "required": ["role", "message", "time", "endTime", "secondsFromStart"] }, "SystemMessage": { "type": "object", @@ -12007,13 +8976,8 @@ "type": "number", "description": "The number of seconds from the start of the conversation." } - }, - "required": [ - "role", - "message", - "time", - "secondsFromStart" - ] + }, + "required": ["role", "message", "time", "secondsFromStart"] }, "BotMessage": { "type": "object", @@ -12043,13 +9007,7 @@ "description": "The source of the message." } }, - "required": [ - "role", - "message", - "time", - "endTime", - "secondsFromStart" - ] + "required": ["role", "message", "time", "endTime", "secondsFromStart"] }, "ToolCallMessage": { "type": "object", @@ -12061,9 +9019,7 @@ "toolCalls": { "description": "The list of tool calls made during the conversation.", "type": "array", - "items": { - "type": "object" - } + "items": { "type": "object" } }, "message": { "type": "string", @@ -12078,13 +9034,7 @@ "description": "The number of seconds from the start of the conversation." } }, - "required": [ - "role", - "toolCalls", - "message", - "time", - "secondsFromStart" - ] + "required": ["role", "toolCalls", "message", "time", "secondsFromStart"] }, "ToolCallResultMessage": { "type": "object", @@ -12147,13 +9097,7 @@ "description": "The number of seconds from the start of the conversation." } }, - "required": [ - "role", - "name", - "result", - "time", - "secondsFromStart" - ] + "required": ["role", "name", "result", "time", "secondsFromStart"] }, "StatusUpdateMessage": { "type": "object", @@ -12161,20 +9105,12 @@ "type": { "type": "string", "description": "This is the type of the message. \"status-update\" is sent whenever the `call.status` changes.", - "enum": [ - "status-update" - ] + "enum": ["status-update"] }, "status": { "type": "string", "description": "This is the status of the call.", - "enum": [ - "queued", - "ringing", - "in-progress", - "forwarding", - "ended" - ] + "enum": ["queued", "ringing", "in-progress", "forwarding", "ended"] }, "endedReason": { "type": "string", @@ -12301,9 +9237,7 @@ "messagesOpenAIFormatted": { "description": "These are the conversation messages of the call. This is only sent if the status is \"forwarding\".", "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAIMessage" - } + "items": { "$ref": "#/components/schemas/OpenAIMessage" } }, "transcript": { "type": "string", @@ -12318,10 +9252,7 @@ "description": "This is the inbound phone call debugging artifacts. This is only sent if the status is \"ended\" and there was an error accepting the inbound phone call.\n\nThis will include any errors related to the \"assistant-request\" if one was made." } }, - "required": [ - "type", - "status" - ] + "required": ["type", "status"] }, "TranscriptMessage": { "type": "object", @@ -12329,37 +9260,24 @@ "type": { "type": "string", "description": "This is the type of the message. \"transcript\" is sent as transcriber outputs partial or final transcript.", - "enum": [ - "transcript" - ] + "enum": ["transcript"] }, "role": { "type": "string", "description": "This is the role for which the transcript is for.", - "enum": [ - "assistant", - "user" - ] + "enum": ["assistant", "user"] }, "transcriptType": { "type": "string", "description": "This is the type of the transcript.", - "enum": [ - "partial", - "final" - ] + "enum": ["partial", "final"] }, "transcript": { "type": "string", "description": "This is the transcript content." } }, - "required": [ - "type", - "role", - "transcriptType", - "transcript" - ] + "required": ["type", "role", "transcriptType", "transcript"] }, "ToolCallFunction": { "type": "object", @@ -12373,10 +9291,7 @@ "description": "These are the arguments that the function was called with." } }, - "required": [ - "name", - "arguments" - ] + "required": ["name", "arguments"] }, "ToolCall": { "type": "object", @@ -12384,28 +9299,18 @@ "type": { "type": "string", "description": "This is the type of tool the model called.", - "enum": [ - "function" - ] + "enum": ["function"] }, "function": { "description": "This is the function the model called.", - "allOf": [ - { - "$ref": "#/components/schemas/ToolCallFunction" - } - ] + "allOf": [{ "$ref": "#/components/schemas/ToolCallFunction" }] }, "id": { "type": "string", "description": "This is the unique identifier for the tool call." } }, - "required": [ - "type", - "function", - "id" - ] + "required": ["type", "function", "id"] }, "FunctionToolWithToolCall": { "type": "object", @@ -12441,35 +9346,20 @@ }, "type": { "type": "string", - "enum": [ - "function" - ], + "enum": ["function"], "description": "The type of tool. \"function\" for Function tool." }, - "toolCall": { - "$ref": "#/components/schemas/ToolCall" - }, + "toolCall": { "$ref": "#/components/schemas/ToolCall" }, "function": { "description": "This is the function definition of the tool.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, this is a custom function definition.", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAIFunction" - } - ] + "allOf": [{ "$ref": "#/components/schemas/OpenAIFunction" }] }, "server": { "description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.", - "allOf": [ - { - "$ref": "#/components/schemas/Server" - } - ] + "allOf": [{ "$ref": "#/components/schemas/Server" }] } }, - "required": [ - "type", - "toolCall" - ] + "required": ["type", "toolCall"] }, "GhlToolWithToolCall": { "type": "object", @@ -12505,39 +9395,21 @@ }, "type": { "type": "string", - "enum": [ - "ghl" - ], + "enum": ["ghl"], "description": "The type of tool. \"ghl\" for GHL tool." }, - "toolCall": { - "$ref": "#/components/schemas/ToolCall" - }, - "metadata": { - "$ref": "#/components/schemas/GhlToolMetadata" - }, + "toolCall": { "$ref": "#/components/schemas/ToolCall" }, + "metadata": { "$ref": "#/components/schemas/GhlToolMetadata" }, "function": { "description": "This is the function definition of the tool.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, this is a custom function definition.", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAIFunction" - } - ] + "allOf": [{ "$ref": "#/components/schemas/OpenAIFunction" }] }, "server": { "description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.", - "allOf": [ - { - "$ref": "#/components/schemas/Server" - } - ] + "allOf": [{ "$ref": "#/components/schemas/Server" }] } }, - "required": [ - "type", - "toolCall", - "metadata" - ] + "required": ["type", "toolCall", "metadata"] }, "MakeToolWithToolCall": { "type": "object", @@ -12573,39 +9445,21 @@ }, "type": { "type": "string", - "enum": [ - "make" - ], + "enum": ["make"], "description": "The type of tool. \"make\" for Make tool." }, - "toolCall": { - "$ref": "#/components/schemas/ToolCall" - }, - "metadata": { - "$ref": "#/components/schemas/MakeToolMetadata" - }, + "toolCall": { "$ref": "#/components/schemas/ToolCall" }, + "metadata": { "$ref": "#/components/schemas/MakeToolMetadata" }, "function": { "description": "This is the function definition of the tool.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, this is a custom function definition.", - "allOf": [ - { - "$ref": "#/components/schemas/OpenAIFunction" - } - ] + "allOf": [{ "$ref": "#/components/schemas/OpenAIFunction" }] }, "server": { "description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.", - "allOf": [ - { - "$ref": "#/components/schemas/Server" - } - ] + "allOf": [{ "$ref": "#/components/schemas/Server" }] } }, - "required": [ - "type", - "toolCall", - "metadata" - ] + "required": ["type", "toolCall", "metadata"] }, "ToolCallsMessage": { "type": "object", @@ -12613,9 +9467,7 @@ "type": { "type": "string", "description": "This is the type of the message. \"tool-calls\" is sent to call a tool.", - "enum": [ - "tool-calls" - ] + "enum": ["tool-calls"] }, "toolWithToolCallList": { "type": "array", @@ -12640,15 +9492,10 @@ "toolCallList": { "description": "This is the list of tool calls that the model is requesting.", "type": "array", - "items": { - "$ref": "#/components/schemas/ToolCall" - } + "items": { "$ref": "#/components/schemas/ToolCall" } } }, - "required": [ - "toolWithToolCallList", - "toolCallList" - ] + "required": ["toolWithToolCallList", "toolCallList"] }, "ToolCallsResultMessage": { "type": "object", @@ -12656,19 +9503,14 @@ "type": { "type": "string", "description": "This is the type of the message. \"tool-calls-result\" is sent to forward the result of a tool call to the client.", - "enum": [ - "tool-calls-result" - ] + "enum": ["tool-calls-result"] }, "toolCallResult": { "type": "object", "description": "This is the result of the tool call." } }, - "required": [ - "type", - "toolCallResult" - ] + "required": ["type", "toolCallResult"] }, "UserInterruptedMessage": { "type": "object", @@ -12676,14 +9518,10 @@ "type": { "type": "string", "description": "This is the type of the message. \"user-interrupted\" is sent when the user interrupts the assistant.", - "enum": [ - "user-interrupted" - ] + "enum": ["user-interrupted"] } }, - "required": [ - "type" - ] + "required": ["type"] }, "VoiceInputMessage": { "type": "object", @@ -12691,19 +9529,14 @@ "type": { "type": "string", "description": "This is the type of the message. \"voice-input\" is sent when a generation is requested from voice provider.", - "enum": [ - "voice-input" - ] + "enum": ["voice-input"] }, "input": { "type": "string", "description": "This is the voice input content" } }, - "required": [ - "type", - "input" - ] + "required": ["type", "input"] }, "ClientMessage": { "type": "object", @@ -12712,50 +9545,61 @@ "description": "These are all the messages that can be sent to the client-side SDKs during the call. Configure the messages you'd like to receive in `assistant.clientMessages`.", "oneOf": [ { - "$ref": "#/components/schemas/ConversationUpdateMessage" + "$ref": "#/components/schemas/ConversationUpdateMessage", + "title": "ConversationUpdateMessage" }, { - "$ref": "#/components/schemas/FunctionCallMessage" + "$ref": "#/components/schemas/FunctionCallMessage", + "title": "FunctionCallMessage" }, { - "$ref": "#/components/schemas/FunctionCallResultMessage" + "$ref": "#/components/schemas/FunctionCallResultMessage", + "title": "FunctionCallResultMessage" }, { - "$ref": "#/components/schemas/HangMessage" + "$ref": "#/components/schemas/HangMessage", + "title": "HangMessage" }, { - "$ref": "#/components/schemas/MetadataMessage" + "$ref": "#/components/schemas/MetadataMessage", + "title": "MetadataMessage" }, { - "$ref": "#/components/schemas/ModelOutputMessage" + "$ref": "#/components/schemas/ModelOutputMessage", + "title": "ModelOutputMessage" }, { - "$ref": "#/components/schemas/SpeechUpdateMessage" + "$ref": "#/components/schemas/SpeechUpdateMessage", + "title": "SpeechUpdateMessage" }, { - "$ref": "#/components/schemas/StatusUpdateMessage" + "$ref": "#/components/schemas/StatusUpdateMessage", + "title": "StatusUpdateMessage" }, { - "$ref": "#/components/schemas/TranscriptMessage" + "$ref": "#/components/schemas/TranscriptMessage", + "title": "TranscriptMessage" }, { - "$ref": "#/components/schemas/ToolCallsMessage" + "$ref": "#/components/schemas/ToolCallsMessage", + "title": "ToolCallsMessage" }, { - "$ref": "#/components/schemas/ToolCallsResultMessage" + "$ref": "#/components/schemas/ToolCallsResultMessage", + "title": "ToolCallsResultMessage" }, { - "$ref": "#/components/schemas/UserInterruptedMessage" + "$ref": "#/components/schemas/UserInterruptedMessage", + "title": "UserInterruptedMessage" }, { - "$ref": "#/components/schemas/VoiceInputMessage" + "$ref": "#/components/schemas/VoiceInputMessage", + "title": "VoiceInputMessage" } ] } }, - "required": [ - "message" - ] + "required": ["message"] }, "AssistantRequestServerMessage": { "type": "object", @@ -12763,9 +9607,7 @@ "type": { "type": "string", "description": "This is the type of the message. \"assistant-request\" is sent to fetch assistant configuration for an incoming call.", - "enum": [ - "assistant-request" - ] + "enum": ["assistant-request"] }, "phoneNumber": { "type": "object", @@ -12788,11 +9630,7 @@ "description": "This is the timestamp of the message." } }, - "required": [ - "type", - "customer", - "call" - ] + "required": ["type", "customer", "call"] }, "ConversationUpdateServerMessage": { "type": "object", @@ -12800,16 +9638,12 @@ "type": { "type": "string", "description": "This is the type of the message. \"conversation-update\" is sent when an update is committed to the conversation history.", - "enum": [ - "conversation-update" - ] + "enum": ["conversation-update"] }, "messagesOpenAIFormatted": { "description": "This is the most up-to-date conversation history at the time the message is sent.", "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAIMessage" - } + "items": { "$ref": "#/components/schemas/OpenAIMessage" } }, "phoneNumber": { "type": "object", @@ -12832,12 +9666,7 @@ "description": "This is the timestamp of the message." } }, - "required": [ - "type", - "messagesOpenAIFormatted", - "customer", - "call" - ] + "required": ["type", "messagesOpenAIFormatted", "customer", "call"] }, "EndOfCallReportServerMessage": { "type": "object", @@ -12845,9 +9674,7 @@ "type": { "type": "string", "description": "This is the type of the message. \"end-of-call-report\" is sent when the call ends and post-processing is complete.", - "enum": [ - "end-of-call-report" - ] + "enum": ["end-of-call-report"] }, "endedReason": { "type": "string", @@ -12993,11 +9820,7 @@ }, "artifact": { "description": "These are the artifacts from the call.", - "allOf": [ - { - "$ref": "#/components/schemas/Artifact" - } - ] + "allOf": [{ "$ref": "#/components/schemas/Artifact" }] }, "timestamp": { "type": "string", @@ -13013,11 +9836,7 @@ }, "analysis": { "description": "This is the analysis of the call.", - "allOf": [ - { - "$ref": "#/components/schemas/Analysis" - } - ] + "allOf": [{ "$ref": "#/components/schemas/Analysis" }] } }, "required": [ @@ -13037,9 +9856,7 @@ "type": "string", "description": "This is the type of the message. \"function-call\" is sent to call a function.", "deprecated": true, - "enum": [ - "function-call" - ] + "enum": ["function-call"] }, "phoneNumber": { "type": "object", @@ -13067,12 +9884,7 @@ "deprecated": true } }, - "required": [ - "type", - "customer", - "call", - "functionCall" - ] + "required": ["type", "customer", "call", "functionCall"] }, "HangServerMessage": { "type": "object", @@ -13080,9 +9892,7 @@ "type": { "type": "string", "description": "This is the type of the message. \"hang\" is sent when the assistant is hanging due to a delay. The delay can be caused by many factors, such as:\n- the model is too slow to respond\n- the voice is too slow to respond\n- the tool call is still waiting for a response from your server\n- etc.", - "enum": [ - "hang" - ] + "enum": ["hang"] }, "phoneNumber": { "type": "object", @@ -13105,11 +9915,7 @@ "description": "This is the timestamp of the message." } }, - "required": [ - "type", - "customer", - "call" - ] + "required": ["type", "customer", "call"] }, "ModelOutputServerMessage": { "type": "object", @@ -13117,9 +9923,7 @@ "type": { "type": "string", "description": "This is the type of the message. \"model-output\" is sent as the model outputs tokens.", - "enum": [ - "model-output" - ] + "enum": ["model-output"] }, "phoneNumber": { "type": "object", @@ -13146,12 +9950,7 @@ "description": "This is the output of the model." } }, - "required": [ - "type", - "customer", - "call", - "output" - ] + "required": ["type", "customer", "call", "output"] }, "PhoneCallControlServerMessage": { "type": "object", @@ -13159,17 +9958,12 @@ "type": { "type": "string", "description": "This is the type of the message. \"phone-call-control\" is a special type of message. When it is requested in `assistant.serverMessages`, the hangup and forwarding responsibilities are delegated to your server.", - "enum": [ - "phone-call-control" - ] + "enum": ["phone-call-control"] }, "request": { "type": "string", "description": "This is the request to control the phone call.", - "enum": [ - "forward", - "hang-up" - ] + "enum": ["forward", "hang-up"] }, "phoneNumber": { "type": "object", @@ -13196,12 +9990,7 @@ "description": "This is the phone number to forward to if the request is \"forward\"." } }, - "required": [ - "type", - "request", - "customer", - "call" - ] + "required": ["type", "request", "customer", "call"] }, "SpeechUpdateServerMessage": { "type": "object", @@ -13209,25 +9998,17 @@ "type": { "type": "string", "description": "This is the type of the message. \"speech-update\" is sent whenever assistant or user start or stop speaking.", - "enum": [ - "speech-update" - ] + "enum": ["speech-update"] }, "status": { "type": "string", "description": "This is the status of the speech update.", - "enum": [ - "started", - "stopped" - ] + "enum": ["started", "stopped"] }, "role": { "type": "string", "description": "This is the role which the speech update is for.", - "enum": [ - "assistant", - "user" - ] + "enum": ["assistant", "user"] }, "phoneNumber": { "type": "object", @@ -13250,13 +10031,7 @@ "description": "This is the timestamp of the message." } }, - "required": [ - "type", - "status", - "role", - "customer", - "call" - ] + "required": ["type", "status", "role", "customer", "call"] }, "StatusUpdateServerMessage": { "type": "object", @@ -13264,20 +10039,12 @@ "type": { "type": "string", "description": "This is the type of the message. \"status-update\" is sent whenever the `call.status` changes.", - "enum": [ - "status-update" - ] + "enum": ["status-update"] }, "status": { "type": "string", "description": "This is the status of the call.", - "enum": [ - "queued", - "ringing", - "in-progress", - "forwarding", - "ended" - ] + "enum": ["queued", "ringing", "in-progress", "forwarding", "ended"] }, "endedReason": { "type": "string", @@ -13404,9 +10171,7 @@ "messagesOpenAIFormatted": { "description": "These are the conversation messages of the call. This is only sent if the status is \"forwarding\".", "type": "array", - "items": { - "$ref": "#/components/schemas/OpenAIMessage" - } + "items": { "$ref": "#/components/schemas/OpenAIMessage" } }, "phoneNumber": { "type": "object", @@ -13441,12 +10206,7 @@ "description": "This is the inbound phone call debugging artifacts. This is only sent if the status is \"ended\" and there was an error accepting the inbound phone call.\n\nThis will include any errors related to the \"assistant-request\" if one was made." } }, - "required": [ - "type", - "status", - "customer", - "call" - ] + "required": ["type", "status", "customer", "call"] }, "ToolCallsServerMessage": { "type": "object", @@ -13454,9 +10214,7 @@ "type": { "type": "string", "description": "This is the type of the message. \"tool-calls\" is sent to call a tool.", - "enum": [ - "tool-calls" - ] + "enum": ["tool-calls"] }, "toolWithToolCallList": { "type": "array", @@ -13501,17 +10259,10 @@ "toolCallList": { "description": "This is the list of tool calls that the model is requesting.", "type": "array", - "items": { - "$ref": "#/components/schemas/ToolCall" - } + "items": { "$ref": "#/components/schemas/ToolCall" } } }, - "required": [ - "toolWithToolCallList", - "customer", - "call", - "toolCallList" - ] + "required": ["toolWithToolCallList", "customer", "call", "toolCallList"] }, "TransferDestinationRequestServerMessage": { "type": "object", @@ -13519,9 +10270,7 @@ "type": { "type": "string", "description": "This is the type of the message. \"transfer-destination-request\" is sent when the model is requesting transfer but destination is unknown.", - "enum": [ - "transfer-destination-request" - ] + "enum": ["transfer-destination-request"] }, "phoneNumber": { "type": "object", @@ -13544,11 +10293,7 @@ "description": "This is the timestamp of the message." } }, - "required": [ - "type", - "customer", - "call" - ] + "required": ["type", "customer", "call"] }, "TranscriptServerMessage": { "type": "object", @@ -13556,9 +10301,7 @@ "type": { "type": "string", "description": "This is the type of the message. \"transcript\" is sent as transcriber outputs partial or final transcript.", - "enum": [ - "transcript" - ] + "enum": ["transcript"] }, "phoneNumber": { "type": "object", @@ -13583,18 +10326,12 @@ "role": { "type": "string", "description": "This is the role for which the transcript is for.", - "enum": [ - "assistant", - "user" - ] + "enum": ["assistant", "user"] }, "transcriptType": { "type": "string", "description": "This is the type of the transcript.", - "enum": [ - "partial", - "final" - ] + "enum": ["partial", "final"] }, "transcript": { "type": "string", @@ -13616,9 +10353,7 @@ "type": { "type": "string", "description": "This is the type of the message. \"user-interrupted\" is sent when the user interrupts the assistant.", - "enum": [ - "user-interrupted" - ] + "enum": ["user-interrupted"] }, "phoneNumber": { "type": "object", @@ -13641,11 +10376,7 @@ "description": "This is the timestamp of the message." } }, - "required": [ - "type", - "customer", - "call" - ] + "required": ["type", "customer", "call"] }, "VoiceInputServerMessage": { "type": "object", @@ -13653,9 +10384,7 @@ "type": { "type": "string", "description": "This is the type of the message. \"voice-input\" is sent when a generation is requested from voice provider.", - "enum": [ - "voice-input" - ] + "enum": ["voice-input"] }, "phoneNumber": { "type": "object", @@ -13682,12 +10411,7 @@ "description": "This is the voice input content" } }, - "required": [ - "type", - "customer", - "call", - "input" - ] + "required": ["type", "customer", "call", "input"] }, "ServerMessage": { "type": "object", @@ -13696,53 +10420,65 @@ "description": "These are all the messages that can be sent to your server before, after and during the call. Configure the messages you'd like to receive in `assistant.serverMessages`.\n\nThe server where the message is sent is determined by the following precedence order:\n\n1. `tool.server.url` (if configured, and only for \"tool-calls\" message)\n2. `assistant.serverUrl` (if configure)\n3. `phoneNumber.serverUrl` (if configured)\n4. `org.serverUrl` (if configured)", "oneOf": [ { - "$ref": "#/components/schemas/AssistantRequestServerMessage" + "$ref": "#/components/schemas/AssistantRequestServerMessage", + "title": "AssistantRequestServerMessage" }, { - "$ref": "#/components/schemas/ConversationUpdateServerMessage" + "$ref": "#/components/schemas/ConversationUpdateServerMessage", + "title": "ConversationUpdateServerMessage" }, { - "$ref": "#/components/schemas/EndOfCallReportServerMessage" + "$ref": "#/components/schemas/EndOfCallReportServerMessage", + "title": "EndOfCallReportServerMessage" }, { - "$ref": "#/components/schemas/FunctionCallServerMessage" + "$ref": "#/components/schemas/FunctionCallServerMessage", + "title": "FunctionCallServerMessage" }, { - "$ref": "#/components/schemas/HangServerMessage" + "$ref": "#/components/schemas/HangServerMessage", + "title": "HangServerMessage" }, { - "$ref": "#/components/schemas/ModelOutputServerMessage" + "$ref": "#/components/schemas/ModelOutputServerMessage", + "title": "ModelOutputServerMessage" }, { - "$ref": "#/components/schemas/PhoneCallControlServerMessage" + "$ref": "#/components/schemas/PhoneCallControlServerMessage", + "title": "PhoneCallControlServerMessage" }, { - "$ref": "#/components/schemas/SpeechUpdateServerMessage" + "$ref": "#/components/schemas/SpeechUpdateServerMessage", + "title": "SpeechUpdateServerMessage" }, { - "$ref": "#/components/schemas/StatusUpdateServerMessage" + "$ref": "#/components/schemas/StatusUpdateServerMessage", + "title": "StatusUpdateServerMessage" }, { - "$ref": "#/components/schemas/ToolCallsServerMessage" + "$ref": "#/components/schemas/ToolCallsServerMessage", + "title": "ToolCallsServerMessage" }, { - "$ref": "#/components/schemas/TransferDestinationRequestServerMessage" + "$ref": "#/components/schemas/TransferDestinationRequestServerMessage", + "title": "TransferDestinationRequestServerMessage" }, { - "$ref": "#/components/schemas/TranscriptServerMessage" + "$ref": "#/components/schemas/TranscriptServerMessage", + "title": "TranscriptServerMessage" }, { - "$ref": "#/components/schemas/UserInterruptedServerMessage" + "$ref": "#/components/schemas/UserInterruptedServerMessage", + "title": "UserInterruptedServerMessage" }, { - "$ref": "#/components/schemas/VoiceInputServerMessage" + "$ref": "#/components/schemas/VoiceInputServerMessage", + "title": "VoiceInputServerMessage" } ] } }, - "required": [ - "message" - ] + "required": ["message"] }, "AssistantRequestMessageResponse": { "type": "object", @@ -13754,19 +10490,11 @@ }, "assistant": { "description": "This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead.\n\nIf you're unsure why you're getting an invalid assistant, try logging your response and send the JSON blob to POST /assistant which will return the validation errors.", - "allOf": [ - { - "$ref": "#/components/schemas/CreateAssistantDTO" - } - ] + "allOf": [{ "$ref": "#/components/schemas/CreateAssistantDTO" }] }, "assistantOverrides": { "description": "These are the overrides for the `assistant` or `assistantId`'s settings and template variables.", - "allOf": [ - { - "$ref": "#/components/schemas/AssistantOverrides" - } - ] + "allOf": [{ "$ref": "#/components/schemas/AssistantOverrides" }] }, "squadId": { "type": "string", @@ -13774,11 +10502,7 @@ }, "squad": { "description": "This is a squad that will be used for the call. To use an existing squad, use `squadId` instead.", - "allOf": [ - { - "$ref": "#/components/schemas/CreateSquadDTO" - } - ] + "allOf": [{ "$ref": "#/components/schemas/CreateSquadDTO" }] }, "forwardingPhoneNumber": { "type": "string", @@ -13825,10 +10549,7 @@ "description": "This is the error message if the tool call was not successful." } }, - "required": [ - "name", - "toolCallId" - ] + "required": ["name", "toolCallId"] }, "ToolCallsMessageResponse": { "type": "object", @@ -13836,9 +10557,7 @@ "results": { "description": "These are the results of the \"tool-calls\" message.", "type": "array", - "items": { - "$ref": "#/components/schemas/ToolCallResult" - } + "items": { "$ref": "#/components/schemas/ToolCallResult" } }, "error": { "type": "string", @@ -13879,24 +10598,26 @@ "description": "This is the response that is expected from the server to the message.\n\nFYI, most messages don't expect a response. Only \"assistant-request\", \"tool-calls\" and \"transfer-destination-request\" do.", "oneOf": [ { - "$ref": "#/components/schemas/AssistantRequestMessageResponse" + "$ref": "#/components/schemas/AssistantRequestMessageResponse", + "title": "AssistantRequestMessageResponse" }, { - "$ref": "#/components/schemas/FunctionCallMessageResponse" + "$ref": "#/components/schemas/FunctionCallMessageResponse", + "title": "FunctionCallMessageResponse" }, { - "$ref": "#/components/schemas/ToolCallsMessageResponse" + "$ref": "#/components/schemas/ToolCallsMessageResponse", + "title": "ToolCallsMessageResponse" }, { - "$ref": "#/components/schemas/TransferDestinationRequestMessageResponse" + "$ref": "#/components/schemas/TransferDestinationRequestMessageResponse", + "title": "TransferDestinationRequestMessageResponse" } ] } }, - "required": [ - "messageResponse" - ] + "required": ["messageResponse"] } } } -} \ No newline at end of file +}