diff --git a/fern/apis/api/openapi.json b/fern/apis/api/openapi.json
index a270759b..1fe9cfbc 100644
--- a/fern/apis/api/openapi.json
+++ b/fern/apis/api/openapi.json
@@ -306,46 +306,61 @@
]
}
},
- "/assistant": {
- "post": {
- "operationId": "AssistantController_create",
- "summary": "Create Assistant",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CreateAssistantDTO"
- }
+ "/chat": {
+ "get": {
+ "operationId": "ChatController_listChats",
+ "summary": "List Chats",
+ "parameters": [
+ {
+ "name": "assistantId",
+ "required": false,
+ "in": "query",
+ "description": "This is the unique identifier for the assistant that will be used for the chat.",
+ "schema": {
+ "type": "string"
}
- }
- },
- "responses": {
- "201": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Assistant"
- }
- }
+ },
+ {
+ "name": "workflowId",
+ "required": false,
+ "in": "query",
+ "description": "This is the unique identifier for the workflow that will be used for the chat.",
+ "schema": {
+ "type": "string"
}
- }
- },
- "tags": [
- "Assistants"
- ],
- "security": [
+ },
{
- "bearer": []
- }
- ]
- },
- "get": {
- "operationId": "AssistantController_findAll",
- "summary": "List Assistants",
- "parameters": [
+ "name": "sessionId",
+ "required": false,
+ "in": "query",
+ "description": "This is the unique identifier for the session that will be used for the chat.",
+ "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"
+ }
+ },
+ {
+ "name": "sortOrder",
+ "required": false,
+ "in": "query",
+ "description": "This is the sort order for pagination. Defaults to 'DESC'.",
+ "schema": {
+ "enum": [
+ "ASC",
+ "DESC"
+ ],
+ "type": "string"
+ }
+ },
{
"name": "limit",
"required": false,
@@ -444,63 +459,79 @@
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Assistant"
- }
+ "$ref": "#/components/schemas/ChatPaginatedResponse"
}
}
}
}
},
"tags": [
- "Assistants"
+ "Chats"
],
"security": [
{
"bearer": []
}
]
- }
- },
- "/assistant/{id}": {
- "get": {
- "operationId": "AssistantController_findOne",
- "summary": "Get Assistant",
- "parameters": [
- {
- "name": "id",
- "required": true,
- "in": "path",
- "schema": {
- "type": "string"
+ },
+ "post": {
+ "operationId": "ChatController_createChat",
+ "summary": "Create Chat",
+ "description": "Creates a new chat. Requires at least one of: assistantId/assistant, sessionId, or previousChatId. Note: sessionId and previousChatId are mutually exclusive.",
+ "parameters": [],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateChatDTO"
+ }
}
}
- ],
+ },
"responses": {
"200": {
+ "description": "Chat response - either non-streaming chat or streaming",
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/Chat"
+ },
+ {
+ "$ref": "#/components/schemas/CreateChatStreamResponse"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "201": {
"description": "",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Assistant"
+ "type": "object"
}
}
}
}
},
"tags": [
- "Assistants"
+ "Chats"
],
"security": [
{
"bearer": []
}
]
- },
- "patch": {
- "operationId": "AssistantController_update",
- "summary": "Update Assistant",
+ }
+ },
+ "/chat/{id}": {
+ "get": {
+ "operationId": "ChatController_getChat",
+ "summary": "Get Chat",
"parameters": [
{
"name": "id",
@@ -511,30 +542,20 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/UpdateAssistantDTO"
- }
- }
- }
- },
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Assistant"
+ "$ref": "#/components/schemas/Chat"
}
}
}
}
},
"tags": [
- "Assistants"
+ "Chats"
],
"security": [
{
@@ -543,8 +564,8 @@
]
},
"delete": {
- "operationId": "AssistantController_remove",
- "summary": "Delete Assistant",
+ "operationId": "ChatController_deleteChat",
+ "summary": "Delete Chat",
"parameters": [
{
"name": "id",
@@ -561,14 +582,14 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Assistant"
+ "$ref": "#/components/schemas/Chat"
}
}
}
}
},
"tags": [
- "Assistants"
+ "Chats"
],
"security": [
{
@@ -577,98 +598,98 @@
]
}
},
- "/phone-number": {
+ "/chat/responses": {
"post": {
- "operationId": "PhoneNumberController_create",
- "summary": "Create Phone Number",
+ "operationId": "ChatController_createOpenAIChat",
+ "summary": "Create Chat (OpenAI Compatible)",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
- "title": "ByoPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/CreateTwilioPhoneNumberDTO",
- "title": "TwilioPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/CreateVonagePhoneNumberDTO",
- "title": "VonagePhoneNumber"
- },
- {
- "$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
- "title": "VapiPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
- "title": "TelnyxPhoneNumber"
- }
- ],
- "discriminator": {
- "propertyName": "provider",
- "mapping": {
- "byo-phone-number": "#/components/schemas/CreateByoPhoneNumberDTO",
- "twilio": "#/components/schemas/CreateTwilioPhoneNumberDTO",
- "vonage": "#/components/schemas/CreateVonagePhoneNumberDTO",
- "vapi": "#/components/schemas/CreateVapiPhoneNumberDTO",
- "telnyx": "#/components/schemas/CreateTelnyxPhoneNumberDTO"
- }
- }
+ "$ref": "#/components/schemas/OpenAIResponsesRequest"
}
}
}
},
"responses": {
- "201": {
- "description": "",
+ "200": {
+ "description": "OpenAI Responses API format - either non-streaming or streaming",
"content": {
"application/json": {
"schema": {
- "title": "PhoneNumber",
"oneOf": [
{
- "$ref": "#/components/schemas/ByoPhoneNumber",
- "title": "ByoPhoneNumber"
+ "$ref": "#/components/schemas/ResponseObject"
},
{
- "$ref": "#/components/schemas/TwilioPhoneNumber",
- "title": "TwilioPhoneNumber"
+ "$ref": "#/components/schemas/ResponseTextDeltaEvent"
},
{
- "$ref": "#/components/schemas/VonagePhoneNumber",
- "title": "VonagePhoneNumber"
+ "$ref": "#/components/schemas/ResponseTextDoneEvent"
},
{
- "$ref": "#/components/schemas/VapiPhoneNumber",
- "title": "VapiPhoneNumber"
+ "$ref": "#/components/schemas/ResponseCompletedEvent"
},
{
- "$ref": "#/components/schemas/TelnyxPhoneNumber",
- "title": "TelnyxPhoneNumber"
- }
- ],
- "discriminator": {
- "propertyName": "provider",
- "mapping": {
- "byo-phone-number": "#/components/schemas/ByoPhoneNumber",
- "twilio": "#/components/schemas/TwilioPhoneNumber",
- "vonage": "#/components/schemas/VonagePhoneNumber",
- "vapi": "#/components/schemas/VapiPhoneNumber",
- "telnyx": "#/components/schemas/TelnyxPhoneNumber"
+ "$ref": "#/components/schemas/ResponseErrorEvent"
}
- }
+ ]
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
}
}
}
}
},
"tags": [
- "Phone Numbers"
+ "Chats"
+ ],
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ }
+ },
+ "/campaign": {
+ "post": {
+ "operationId": "CampaignController_create",
+ "summary": "Create Campaign",
+ "parameters": [],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateCampaignDTO"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Campaign"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ "Campaigns"
],
"security": [
{
@@ -677,8 +698,8 @@
]
},
"get": {
- "operationId": "PhoneNumberController_findAll",
- "summary": "List Phone Numbers",
+ "operationId": "CampaignController_findAll",
+ "summary": "List Campaigns",
"parameters": [
{
"name": "limit",
@@ -780,39 +801,7 @@
"schema": {
"type": "array",
"items": {
- "title": "PhoneNumber",
- "oneOf": [
- {
- "$ref": "#/components/schemas/ByoPhoneNumber",
- "title": "ByoPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/TwilioPhoneNumber",
- "title": "TwilioPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/VonagePhoneNumber",
- "title": "VonagePhoneNumber"
- },
- {
- "$ref": "#/components/schemas/VapiPhoneNumber",
- "title": "VapiPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/TelnyxPhoneNumber",
- "title": "TelnyxPhoneNumber"
- }
- ],
- "discriminator": {
- "propertyName": "provider",
- "mapping": {
- "byo-phone-number": "#/components/schemas/ByoPhoneNumber",
- "twilio": "#/components/schemas/TwilioPhoneNumber",
- "vonage": "#/components/schemas/VonagePhoneNumber",
- "vapi": "#/components/schemas/VapiPhoneNumber",
- "telnyx": "#/components/schemas/TelnyxPhoneNumber"
- }
- }
+ "$ref": "#/components/schemas/Campaign"
}
}
}
@@ -820,7 +809,7 @@
}
},
"tags": [
- "Phone Numbers"
+ "Campaigns"
],
"security": [
{
@@ -829,10 +818,173 @@
]
}
},
- "/phone-number/{id}": {
+ "/campaign/paginated": {
"get": {
- "operationId": "PhoneNumberController_findOne",
- "summary": "Get Phone Number",
+ "operationId": "CampaignController_findAllPaginated",
+ "summary": "List Campaigns with pagination",
+ "parameters": [
+ {
+ "name": "id",
+ "required": false,
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "status",
+ "required": false,
+ "in": "query",
+ "schema": {
+ "enum": [
+ "scheduled",
+ "in-progress",
+ "ended"
+ ],
+ "type": "string"
+ }
+ },
+ {
+ "name": "page",
+ "required": false,
+ "in": "query",
+ "description": "This is the page number to return. Defaults to 1.",
+ "schema": {
+ "minimum": 1,
+ "type": "number"
+ }
+ },
+ {
+ "name": "sortOrder",
+ "required": false,
+ "in": "query",
+ "description": "This is the sort order for pagination. Defaults to 'DESC'.",
+ "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"
+ }
+ },
+ {
+ "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": {
+ "$ref": "#/components/schemas/Campaign"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ "Campaigns"
+ ],
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ }
+ },
+ "/campaign/{id}": {
+ "get": {
+ "operationId": "CampaignController_findOne",
+ "summary": "Get Campaign",
"parameters": [
{
"name": "id",
@@ -849,46 +1001,14 @@
"content": {
"application/json": {
"schema": {
- "title": "PhoneNumber",
- "oneOf": [
- {
- "$ref": "#/components/schemas/ByoPhoneNumber",
- "title": "ByoPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/TwilioPhoneNumber",
- "title": "TwilioPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/VonagePhoneNumber",
- "title": "VonagePhoneNumber"
- },
- {
- "$ref": "#/components/schemas/VapiPhoneNumber",
- "title": "VapiPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/TelnyxPhoneNumber",
- "title": "TelnyxPhoneNumber"
- }
- ],
- "discriminator": {
- "propertyName": "provider",
- "mapping": {
- "byo-phone-number": "#/components/schemas/ByoPhoneNumber",
- "twilio": "#/components/schemas/TwilioPhoneNumber",
- "vonage": "#/components/schemas/VonagePhoneNumber",
- "vapi": "#/components/schemas/VapiPhoneNumber",
- "telnyx": "#/components/schemas/TelnyxPhoneNumber"
- }
- }
+ "$ref": "#/components/schemas/Campaign"
}
}
}
}
},
"tags": [
- "Phone Numbers"
+ "Campaigns"
],
"security": [
{
@@ -897,8 +1017,8 @@
]
},
"patch": {
- "operationId": "PhoneNumberController_update",
- "summary": "Update Phone Number",
+ "operationId": "CampaignController_update",
+ "summary": "Update Campaign",
"parameters": [
{
"name": "id",
@@ -914,38 +1034,7 @@
"content": {
"application/json": {
"schema": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/UpdateByoPhoneNumberDTO",
- "title": "ByoPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/UpdateTwilioPhoneNumberDTO",
- "title": "TwilioPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/UpdateVonagePhoneNumberDTO",
- "title": "VonagePhoneNumber"
- },
- {
- "$ref": "#/components/schemas/UpdateVapiPhoneNumberDTO",
- "title": "VapiPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/UpdateTelnyxPhoneNumberDTO",
- "title": "TelnyxPhoneNumber"
- }
- ],
- "discriminator": {
- "propertyName": "provider",
- "mapping": {
- "byo-phone-number": "#/components/schemas/UpdateByoPhoneNumberDTO",
- "twilio": "#/components/schemas/UpdateTwilioPhoneNumberDTO",
- "vonage": "#/components/schemas/UpdateVonagePhoneNumberDTO",
- "vapi": "#/components/schemas/UpdateVapiPhoneNumberDTO",
- "telnyx": "#/components/schemas/UpdateTelnyxPhoneNumberDTO"
- }
- }
+ "$ref": "#/components/schemas/UpdateCampaignDTO"
}
}
}
@@ -956,46 +1045,14 @@
"content": {
"application/json": {
"schema": {
- "title": "PhoneNumber",
- "oneOf": [
- {
- "$ref": "#/components/schemas/ByoPhoneNumber",
- "title": "ByoPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/TwilioPhoneNumber",
- "title": "TwilioPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/VonagePhoneNumber",
- "title": "VonagePhoneNumber"
- },
- {
- "$ref": "#/components/schemas/VapiPhoneNumber",
- "title": "VapiPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/TelnyxPhoneNumber",
- "title": "TelnyxPhoneNumber"
- }
- ],
- "discriminator": {
- "propertyName": "provider",
- "mapping": {
- "byo-phone-number": "#/components/schemas/ByoPhoneNumber",
- "twilio": "#/components/schemas/TwilioPhoneNumber",
- "vonage": "#/components/schemas/VonagePhoneNumber",
- "vapi": "#/components/schemas/VapiPhoneNumber",
- "telnyx": "#/components/schemas/TelnyxPhoneNumber"
- }
- }
+ "$ref": "#/components/schemas/Campaign"
}
}
}
}
},
"tags": [
- "Phone Numbers"
+ "Campaigns"
],
"security": [
{
@@ -1004,8 +1061,8 @@
]
},
"delete": {
- "operationId": "PhoneNumberController_remove",
- "summary": "Delete Phone Number",
+ "operationId": "CampaignController_remove",
+ "summary": "Delete Campaign",
"parameters": [
{
"name": "id",
@@ -1022,46 +1079,14 @@
"content": {
"application/json": {
"schema": {
- "title": "PhoneNumber",
- "oneOf": [
- {
- "$ref": "#/components/schemas/ByoPhoneNumber",
- "title": "ByoPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/TwilioPhoneNumber",
- "title": "TwilioPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/VonagePhoneNumber",
- "title": "VonagePhoneNumber"
- },
- {
- "$ref": "#/components/schemas/VapiPhoneNumber",
- "title": "VapiPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/TelnyxPhoneNumber",
- "title": "TelnyxPhoneNumber"
- }
- ],
- "discriminator": {
- "propertyName": "provider",
- "mapping": {
- "byo-phone-number": "#/components/schemas/ByoPhoneNumber",
- "twilio": "#/components/schemas/TwilioPhoneNumber",
- "vonage": "#/components/schemas/VonagePhoneNumber",
- "vapi": "#/components/schemas/VapiPhoneNumber",
- "telnyx": "#/components/schemas/TelnyxPhoneNumber"
- }
- }
+ "$ref": "#/components/schemas/Campaign"
}
}
}
}
},
"tags": [
- "Phone Numbers"
+ "Campaigns"
],
"security": [
{
@@ -1070,108 +1095,17 @@
]
}
},
- "/tool": {
+ "/session": {
"post": {
- "operationId": "ToolController_create",
- "summary": "Create Tool",
+ "operationId": "SessionController_create",
+ "summary": "Create Session",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/CreateDtmfToolDTO",
- "title": "DtmfTool"
- },
- {
- "$ref": "#/components/schemas/CreateEndCallToolDTO",
- "title": "EndCallTool"
- },
- {
- "$ref": "#/components/schemas/CreateFunctionToolDTO",
- "title": "FunctionTool"
- },
- {
- "$ref": "#/components/schemas/CreateGhlToolDTO",
- "title": "GhlTool"
- },
- {
- "$ref": "#/components/schemas/CreateMakeToolDTO",
- "title": "MakeTool"
- },
- {
- "$ref": "#/components/schemas/CreateTransferCallToolDTO",
- "title": "TransferCallTool"
- },
- {
- "$ref": "#/components/schemas/CreateOutputToolDTO",
- "title": "OutputTool"
- },
- {
- "$ref": "#/components/schemas/CreateBashToolDTO",
- "title": "BashTool"
- },
- {
- "$ref": "#/components/schemas/CreateComputerToolDTO",
- "title": "ComputerTool"
- },
- {
- "$ref": "#/components/schemas/CreateTextEditorToolDTO",
- "title": "TextEditorTool"
- },
- {
- "$ref": "#/components/schemas/CreateQueryToolDTO",
- "title": "QueryTool"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
- "title": "GoogleCalendarCreateEventTool"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
- "title": "GoogleSheetsRowAppendTool"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
- "title": "GoogleCalendarCheckAvailabilityTool"
- },
- {
- "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
- "title": "SlackSendMessageTool"
- },
- {
- "$ref": "#/components/schemas/CreateSmsSendToolDTO",
- "title": "SmsSendTool"
- },
- {
- "$ref": "#/components/schemas/CreateMcpToolDTO",
- "title": "McpTool"
- }
- ],
- "discriminator": {
- "propertyName": "type",
- "mapping": {
- "dtmf": "#/components/schemas/CreateDtmfToolDTO",
- "endCall": "#/components/schemas/CreateEndCallToolDTO",
- "function": "#/components/schemas/CreateFunctionToolDTO",
- "ghl": "#/components/schemas/CreateGhlToolDTO",
- "make": "#/components/schemas/CreateMakeToolDTO",
- "transferCall": "#/components/schemas/CreateTransferCallToolDTO",
- "output": "#/components/schemas/CreateOutputToolDTO",
- "bash": "#/components/schemas/CreateBashToolDTO",
- "computer": "#/components/schemas/CreateComputerToolDTO",
- "textEditor": "#/components/schemas/CreateTextEditorToolDTO",
- "query": "#/components/schemas/CreateQueryToolDTO",
- "google.calendar.event.create": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
- "google.sheets.row.append": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
- "google.calendar.availability.check": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
- "slack.message.send": "#/components/schemas/CreateSlackSendMessageToolDTO",
- "sms": "#/components/schemas/CreateSmsSendToolDTO",
- "mcp": "#/components/schemas/CreateMcpToolDTO"
- }
- }
+ "$ref": "#/components/schemas/CreateSessionDTO"
}
}
}
@@ -1182,105 +1116,14 @@
"content": {
"application/json": {
"schema": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/DtmfTool",
- "title": "DtmfTool"
- },
- {
- "$ref": "#/components/schemas/EndCallTool",
- "title": "EndCallTool"
- },
- {
- "$ref": "#/components/schemas/FunctionTool",
- "title": "FunctionTool"
- },
- {
- "$ref": "#/components/schemas/GhlTool",
- "title": "GhlTool"
- },
- {
- "$ref": "#/components/schemas/MakeTool",
- "title": "MakeTool"
- },
- {
- "$ref": "#/components/schemas/TransferCallTool",
- "title": "TransferCallTool"
- },
- {
- "$ref": "#/components/schemas/OutputTool",
- "title": "OutputTool"
- },
- {
- "$ref": "#/components/schemas/BashTool",
- "title": "BashTool"
- },
- {
- "$ref": "#/components/schemas/ComputerTool",
- "title": "ComputerTool"
- },
- {
- "$ref": "#/components/schemas/TextEditorTool",
- "title": "TextEditorTool"
- },
- {
- "$ref": "#/components/schemas/QueryTool",
- "title": "QueryTool"
- },
- {
- "$ref": "#/components/schemas/GoogleCalendarCreateEventTool",
- "title": "GoogleCalendarCreateEventTool"
- },
- {
- "$ref": "#/components/schemas/GoogleSheetsRowAppendTool",
- "title": "GoogleSheetsRowAppendTool"
- },
- {
- "$ref": "#/components/schemas/GoogleCalendarCheckAvailabilityTool",
- "title": "GoogleCalendarCheckAvailabilityTool"
- },
- {
- "$ref": "#/components/schemas/SlackSendMessageTool",
- "title": "SlackSendMessageTool"
- },
- {
- "$ref": "#/components/schemas/SmsSendTool",
- "title": "SmsSendTool"
- },
- {
- "$ref": "#/components/schemas/McpTool",
- "title": "McpTool"
- }
- ],
- "discriminator": {
- "propertyName": "type",
- "mapping": {
- "dtmf": "#/components/schemas/DtmfTool",
- "endCall": "#/components/schemas/EndCallTool",
- "function": "#/components/schemas/FunctionTool",
- "ghl": "#/components/schemas/GhlTool",
- "make": "#/components/schemas/MakeTool",
- "transferCall": "#/components/schemas/TransferCallTool",
- "output": "#/components/schemas/OutputTool",
- "bash": "#/components/schemas/BashTool",
- "computer": "#/components/schemas/ComputerTool",
- "textEditor": "#/components/schemas/TextEditorTool",
- "query": "#/components/schemas/QueryTool",
- "google.calendar.event.create": "#/components/schemas/GoogleCalendarCreateEventTool",
- "google.sheets.row.append": "#/components/schemas/GoogleSheetsRowAppendTool",
- "google.calendar.availability.check": "#/components/schemas/GoogleCalendarCheckAvailabilityTool",
- "slack.message.send": "#/components/schemas/SlackSendMessageTool",
- "sms": "#/components/schemas/SmsSendTool",
- "mcp": "#/components/schemas/McpTool"
- }
- }
+ "$ref": "#/components/schemas/Session"
}
}
}
}
},
"tags": [
- "Tools"
+ "Sessions"
],
"security": [
{
@@ -1289,9 +1132,59 @@
]
},
"get": {
- "operationId": "ToolController_findAll",
- "summary": "List Tools",
+ "operationId": "SessionController_findAllPaginated",
+ "summary": "List Sessions",
"parameters": [
+ {
+ "name": "name",
+ "required": false,
+ "in": "query",
+ "description": "This is the name of the session to filter by.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "assistantId",
+ "required": false,
+ "in": "query",
+ "description": "This is the ID of the assistant to filter sessions by.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workflowId",
+ "required": false,
+ "in": "query",
+ "description": "This is the ID of the workflow to filter sessions by.",
+ "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"
+ }
+ },
+ {
+ "name": "sortOrder",
+ "required": false,
+ "in": "query",
+ "description": "This is the sort order for pagination. Defaults to 'DESC'.",
+ "schema": {
+ "enum": [
+ "ASC",
+ "DESC"
+ ],
+ "type": "string"
+ }
+ },
{
"name": "limit",
"required": false,
@@ -1390,108 +1283,14 @@
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/DtmfTool",
- "title": "DtmfTool"
- },
- {
- "$ref": "#/components/schemas/EndCallTool",
- "title": "EndCallTool"
- },
- {
- "$ref": "#/components/schemas/FunctionTool",
- "title": "FunctionTool"
- },
- {
- "$ref": "#/components/schemas/GhlTool",
- "title": "GhlTool"
- },
- {
- "$ref": "#/components/schemas/MakeTool",
- "title": "MakeTool"
- },
- {
- "$ref": "#/components/schemas/TransferCallTool",
- "title": "TransferCallTool"
- },
- {
- "$ref": "#/components/schemas/OutputTool",
- "title": "OutputTool"
- },
- {
- "$ref": "#/components/schemas/BashTool",
- "title": "BashTool"
- },
- {
- "$ref": "#/components/schemas/ComputerTool",
- "title": "ComputerTool"
- },
- {
- "$ref": "#/components/schemas/TextEditorTool",
- "title": "TextEditorTool"
- },
- {
- "$ref": "#/components/schemas/QueryTool",
- "title": "QueryTool"
- },
- {
- "$ref": "#/components/schemas/GoogleCalendarCreateEventTool",
- "title": "GoogleCalendarCreateEventTool"
- },
- {
- "$ref": "#/components/schemas/GoogleSheetsRowAppendTool",
- "title": "GoogleSheetsRowAppendTool"
- },
- {
- "$ref": "#/components/schemas/GoogleCalendarCheckAvailabilityTool",
- "title": "GoogleCalendarCheckAvailabilityTool"
- },
- {
- "$ref": "#/components/schemas/SlackSendMessageTool",
- "title": "SlackSendMessageTool"
- },
- {
- "$ref": "#/components/schemas/SmsSendTool",
- "title": "SmsSendTool"
- },
- {
- "$ref": "#/components/schemas/McpTool",
- "title": "McpTool"
- }
- ],
- "discriminator": {
- "propertyName": "type",
- "mapping": {
- "dtmf": "#/components/schemas/DtmfTool",
- "endCall": "#/components/schemas/EndCallTool",
- "function": "#/components/schemas/FunctionTool",
- "ghl": "#/components/schemas/GhlTool",
- "make": "#/components/schemas/MakeTool",
- "transferCall": "#/components/schemas/TransferCallTool",
- "output": "#/components/schemas/OutputTool",
- "bash": "#/components/schemas/BashTool",
- "computer": "#/components/schemas/ComputerTool",
- "textEditor": "#/components/schemas/TextEditorTool",
- "query": "#/components/schemas/QueryTool",
- "google.calendar.event.create": "#/components/schemas/GoogleCalendarCreateEventTool",
- "google.sheets.row.append": "#/components/schemas/GoogleSheetsRowAppendTool",
- "google.calendar.availability.check": "#/components/schemas/GoogleCalendarCheckAvailabilityTool",
- "slack.message.send": "#/components/schemas/SlackSendMessageTool",
- "sms": "#/components/schemas/SmsSendTool",
- "mcp": "#/components/schemas/McpTool"
- }
- }
- }
+ "$ref": "#/components/schemas/SessionPaginatedResponse"
}
}
}
}
},
"tags": [
- "Tools"
+ "Sessions"
],
"security": [
{
@@ -1500,10 +1299,10 @@
]
}
},
- "/tool/{id}": {
+ "/session/{id}": {
"get": {
- "operationId": "ToolController_findOne",
- "summary": "Get Tool",
+ "operationId": "SessionController_findOne",
+ "summary": "Get Session",
"parameters": [
{
"name": "id",
@@ -1520,105 +1319,14 @@
"content": {
"application/json": {
"schema": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/DtmfTool",
- "title": "DtmfTool"
- },
- {
- "$ref": "#/components/schemas/EndCallTool",
- "title": "EndCallTool"
- },
- {
- "$ref": "#/components/schemas/FunctionTool",
- "title": "FunctionTool"
- },
- {
- "$ref": "#/components/schemas/GhlTool",
- "title": "GhlTool"
- },
- {
- "$ref": "#/components/schemas/MakeTool",
- "title": "MakeTool"
- },
- {
- "$ref": "#/components/schemas/TransferCallTool",
- "title": "TransferCallTool"
- },
- {
- "$ref": "#/components/schemas/OutputTool",
- "title": "OutputTool"
- },
- {
- "$ref": "#/components/schemas/BashTool",
- "title": "BashTool"
- },
- {
- "$ref": "#/components/schemas/ComputerTool",
- "title": "ComputerTool"
- },
- {
- "$ref": "#/components/schemas/TextEditorTool",
- "title": "TextEditorTool"
- },
- {
- "$ref": "#/components/schemas/QueryTool",
- "title": "QueryTool"
- },
- {
- "$ref": "#/components/schemas/GoogleCalendarCreateEventTool",
- "title": "GoogleCalendarCreateEventTool"
- },
- {
- "$ref": "#/components/schemas/GoogleSheetsRowAppendTool",
- "title": "GoogleSheetsRowAppendTool"
- },
- {
- "$ref": "#/components/schemas/GoogleCalendarCheckAvailabilityTool",
- "title": "GoogleCalendarCheckAvailabilityTool"
- },
- {
- "$ref": "#/components/schemas/SlackSendMessageTool",
- "title": "SlackSendMessageTool"
- },
- {
- "$ref": "#/components/schemas/SmsSendTool",
- "title": "SmsSendTool"
- },
- {
- "$ref": "#/components/schemas/McpTool",
- "title": "McpTool"
- }
- ],
- "discriminator": {
- "propertyName": "type",
- "mapping": {
- "dtmf": "#/components/schemas/DtmfTool",
- "endCall": "#/components/schemas/EndCallTool",
- "function": "#/components/schemas/FunctionTool",
- "ghl": "#/components/schemas/GhlTool",
- "make": "#/components/schemas/MakeTool",
- "transferCall": "#/components/schemas/TransferCallTool",
- "output": "#/components/schemas/OutputTool",
- "bash": "#/components/schemas/BashTool",
- "computer": "#/components/schemas/ComputerTool",
- "textEditor": "#/components/schemas/TextEditorTool",
- "query": "#/components/schemas/QueryTool",
- "google.calendar.event.create": "#/components/schemas/GoogleCalendarCreateEventTool",
- "google.sheets.row.append": "#/components/schemas/GoogleSheetsRowAppendTool",
- "google.calendar.availability.check": "#/components/schemas/GoogleCalendarCheckAvailabilityTool",
- "slack.message.send": "#/components/schemas/SlackSendMessageTool",
- "sms": "#/components/schemas/SmsSendTool",
- "mcp": "#/components/schemas/McpTool"
- }
- }
+ "$ref": "#/components/schemas/Session"
}
}
}
}
},
"tags": [
- "Tools"
+ "Sessions"
],
"security": [
{
@@ -1627,8 +1335,8 @@
]
},
"patch": {
- "operationId": "ToolController_update",
- "summary": "Update Tool",
+ "operationId": "SessionController_update",
+ "summary": "Update Session",
"parameters": [
{
"name": "id",
@@ -1644,98 +1352,7 @@
"content": {
"application/json": {
"schema": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/UpdateDtmfToolDTO",
- "title": "DtmfTool"
- },
- {
- "$ref": "#/components/schemas/UpdateEndCallToolDTO",
- "title": "EndCallTool"
- },
- {
- "$ref": "#/components/schemas/UpdateFunctionToolDTO",
- "title": "FunctionTool"
- },
- {
- "$ref": "#/components/schemas/UpdateGhlToolDTO",
- "title": "GhlTool"
- },
- {
- "$ref": "#/components/schemas/UpdateMakeToolDTO",
- "title": "MakeTool"
- },
- {
- "$ref": "#/components/schemas/UpdateTransferCallToolDTO",
- "title": "TransferCallTool"
- },
- {
- "$ref": "#/components/schemas/UpdateOutputToolDTO",
- "title": "OutputTool"
- },
- {
- "$ref": "#/components/schemas/UpdateBashToolDTO",
- "title": "BashTool"
- },
- {
- "$ref": "#/components/schemas/UpdateComputerToolDTO",
- "title": "ComputerTool"
- },
- {
- "$ref": "#/components/schemas/UpdateTextEditorToolDTO",
- "title": "TextEditorTool"
- },
- {
- "$ref": "#/components/schemas/UpdateQueryToolDTO",
- "title": "QueryTool"
- },
- {
- "$ref": "#/components/schemas/UpdateGoogleCalendarCreateEventToolDTO",
- "title": "GoogleCalendarCreateEventTool"
- },
- {
- "$ref": "#/components/schemas/UpdateGoogleSheetsRowAppendToolDTO",
- "title": "GoogleSheetsRowAppendTool"
- },
- {
- "$ref": "#/components/schemas/UpdateGoogleCalendarCheckAvailabilityToolDTO",
- "title": "GoogleCalendarCheckAvailabilityTool"
- },
- {
- "$ref": "#/components/schemas/UpdateSlackSendMessageToolDTO",
- "title": "SlackSendMessageTool"
- },
- {
- "$ref": "#/components/schemas/UpdateSmsSendToolDTO",
- "title": "SmsSendTool"
- },
- {
- "$ref": "#/components/schemas/UpdateMcpToolDTO",
- "title": "McpTool"
- }
- ],
- "discriminator": {
- "propertyName": "type",
- "mapping": {
- "dtmf": "#/components/schemas/UpdateDtmfToolDTO",
- "endCall": "#/components/schemas/UpdateEndCallToolDTO",
- "function": "#/components/schemas/UpdateFunctionToolDTO",
- "ghl": "#/components/schemas/UpdateGhlToolDTO",
- "make": "#/components/schemas/UpdateMakeToolDTO",
- "transferCall": "#/components/schemas/UpdateTransferCallToolDTO",
- "output": "#/components/schemas/UpdateOutputToolDTO",
- "bash": "#/components/schemas/UpdateBashToolDTO",
- "computer": "#/components/schemas/UpdateComputerToolDTO",
- "textEditor": "#/components/schemas/UpdateTextEditorToolDTO",
- "query": "#/components/schemas/UpdateQueryToolDTO",
- "google.calendar.event.create": "#/components/schemas/UpdateGoogleCalendarCreateEventToolDTO",
- "google.sheets.row.append": "#/components/schemas/UpdateGoogleSheetsRowAppendToolDTO",
- "google.calendar.availability.check": "#/components/schemas/UpdateGoogleCalendarCheckAvailabilityToolDTO",
- "slack.message.send": "#/components/schemas/UpdateSlackSendMessageToolDTO",
- "sms": "#/components/schemas/UpdateSmsSendToolDTO",
- "mcp": "#/components/schemas/UpdateMcpToolDTO"
- }
- }
+ "$ref": "#/components/schemas/UpdateSessionDTO"
}
}
}
@@ -1746,105 +1363,14 @@
"content": {
"application/json": {
"schema": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/DtmfTool",
- "title": "DtmfTool"
- },
- {
- "$ref": "#/components/schemas/EndCallTool",
- "title": "EndCallTool"
- },
- {
- "$ref": "#/components/schemas/FunctionTool",
- "title": "FunctionTool"
- },
- {
- "$ref": "#/components/schemas/GhlTool",
- "title": "GhlTool"
- },
- {
- "$ref": "#/components/schemas/MakeTool",
- "title": "MakeTool"
- },
- {
- "$ref": "#/components/schemas/TransferCallTool",
- "title": "TransferCallTool"
- },
- {
- "$ref": "#/components/schemas/OutputTool",
- "title": "OutputTool"
- },
- {
- "$ref": "#/components/schemas/BashTool",
- "title": "BashTool"
- },
- {
- "$ref": "#/components/schemas/ComputerTool",
- "title": "ComputerTool"
- },
- {
- "$ref": "#/components/schemas/TextEditorTool",
- "title": "TextEditorTool"
- },
- {
- "$ref": "#/components/schemas/QueryTool",
- "title": "QueryTool"
- },
- {
- "$ref": "#/components/schemas/GoogleCalendarCreateEventTool",
- "title": "GoogleCalendarCreateEventTool"
- },
- {
- "$ref": "#/components/schemas/GoogleSheetsRowAppendTool",
- "title": "GoogleSheetsRowAppendTool"
- },
- {
- "$ref": "#/components/schemas/GoogleCalendarCheckAvailabilityTool",
- "title": "GoogleCalendarCheckAvailabilityTool"
- },
- {
- "$ref": "#/components/schemas/SlackSendMessageTool",
- "title": "SlackSendMessageTool"
- },
- {
- "$ref": "#/components/schemas/SmsSendTool",
- "title": "SmsSendTool"
- },
- {
- "$ref": "#/components/schemas/McpTool",
- "title": "McpTool"
- }
- ],
- "discriminator": {
- "propertyName": "type",
- "mapping": {
- "dtmf": "#/components/schemas/DtmfTool",
- "endCall": "#/components/schemas/EndCallTool",
- "function": "#/components/schemas/FunctionTool",
- "ghl": "#/components/schemas/GhlTool",
- "make": "#/components/schemas/MakeTool",
- "transferCall": "#/components/schemas/TransferCallTool",
- "output": "#/components/schemas/OutputTool",
- "bash": "#/components/schemas/BashTool",
- "computer": "#/components/schemas/ComputerTool",
- "textEditor": "#/components/schemas/TextEditorTool",
- "query": "#/components/schemas/QueryTool",
- "google.calendar.event.create": "#/components/schemas/GoogleCalendarCreateEventTool",
- "google.sheets.row.append": "#/components/schemas/GoogleSheetsRowAppendTool",
- "google.calendar.availability.check": "#/components/schemas/GoogleCalendarCheckAvailabilityTool",
- "slack.message.send": "#/components/schemas/SlackSendMessageTool",
- "sms": "#/components/schemas/SmsSendTool",
- "mcp": "#/components/schemas/McpTool"
- }
- }
+ "$ref": "#/components/schemas/Session"
}
}
}
}
},
"tags": [
- "Tools"
+ "Sessions"
],
"security": [
{
@@ -1853,8 +1379,8 @@
]
},
"delete": {
- "operationId": "ToolController_remove",
- "summary": "Delete Tool",
+ "operationId": "SessionController_remove",
+ "summary": "Delete Session",
"parameters": [
{
"name": "id",
@@ -1871,105 +1397,14 @@
"content": {
"application/json": {
"schema": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/DtmfTool",
- "title": "DtmfTool"
- },
- {
- "$ref": "#/components/schemas/EndCallTool",
- "title": "EndCallTool"
- },
- {
- "$ref": "#/components/schemas/FunctionTool",
- "title": "FunctionTool"
- },
- {
- "$ref": "#/components/schemas/GhlTool",
- "title": "GhlTool"
- },
- {
- "$ref": "#/components/schemas/MakeTool",
- "title": "MakeTool"
- },
- {
- "$ref": "#/components/schemas/TransferCallTool",
- "title": "TransferCallTool"
- },
- {
- "$ref": "#/components/schemas/OutputTool",
- "title": "OutputTool"
- },
- {
- "$ref": "#/components/schemas/BashTool",
- "title": "BashTool"
- },
- {
- "$ref": "#/components/schemas/ComputerTool",
- "title": "ComputerTool"
- },
- {
- "$ref": "#/components/schemas/TextEditorTool",
- "title": "TextEditorTool"
- },
- {
- "$ref": "#/components/schemas/QueryTool",
- "title": "QueryTool"
- },
- {
- "$ref": "#/components/schemas/GoogleCalendarCreateEventTool",
- "title": "GoogleCalendarCreateEventTool"
- },
- {
- "$ref": "#/components/schemas/GoogleSheetsRowAppendTool",
- "title": "GoogleSheetsRowAppendTool"
- },
- {
- "$ref": "#/components/schemas/GoogleCalendarCheckAvailabilityTool",
- "title": "GoogleCalendarCheckAvailabilityTool"
- },
- {
- "$ref": "#/components/schemas/SlackSendMessageTool",
- "title": "SlackSendMessageTool"
- },
- {
- "$ref": "#/components/schemas/SmsSendTool",
- "title": "SmsSendTool"
- },
- {
- "$ref": "#/components/schemas/McpTool",
- "title": "McpTool"
- }
- ],
- "discriminator": {
- "propertyName": "type",
- "mapping": {
- "dtmf": "#/components/schemas/DtmfTool",
- "endCall": "#/components/schemas/EndCallTool",
- "function": "#/components/schemas/FunctionTool",
- "ghl": "#/components/schemas/GhlTool",
- "make": "#/components/schemas/MakeTool",
- "transferCall": "#/components/schemas/TransferCallTool",
- "output": "#/components/schemas/OutputTool",
- "bash": "#/components/schemas/BashTool",
- "computer": "#/components/schemas/ComputerTool",
- "textEditor": "#/components/schemas/TextEditorTool",
- "query": "#/components/schemas/QueryTool",
- "google.calendar.event.create": "#/components/schemas/GoogleCalendarCreateEventTool",
- "google.sheets.row.append": "#/components/schemas/GoogleSheetsRowAppendTool",
- "google.calendar.availability.check": "#/components/schemas/GoogleCalendarCheckAvailabilityTool",
- "slack.message.send": "#/components/schemas/SlackSendMessageTool",
- "sms": "#/components/schemas/SmsSendTool",
- "mcp": "#/components/schemas/McpTool"
- }
- }
+ "$ref": "#/components/schemas/Session"
}
}
}
}
},
"tags": [
- "Tools"
+ "Sessions"
],
"security": [
{
@@ -1978,38 +1413,35 @@
]
}
},
- "/file": {
+ "/assistant": {
"post": {
- "operationId": "FileController_create",
- "summary": "Upload File",
+ "operationId": "AssistantController_create",
+ "summary": "Create Assistant",
"parameters": [],
"requestBody": {
"required": true,
"content": {
- "multipart/form-data": {
+ "application/json": {
"schema": {
- "$ref": "#/components/schemas/CreateFileDTO"
+ "$ref": "#/components/schemas/CreateAssistantDTO"
}
}
}
},
"responses": {
"201": {
- "description": "File uploaded successfully",
+ "description": "",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/File"
+ "$ref": "#/components/schemas/Assistant"
}
}
}
- },
- "400": {
- "description": "Invalid file"
}
},
"tags": [
- "Files"
+ "Assistants"
],
"security": [
{
@@ -2018,9 +1450,101 @@
]
},
"get": {
- "operationId": "FileController_findAll",
- "summary": "List Files",
- "parameters": [],
+ "operationId": "AssistantController_findAll",
+ "summary": "List Assistants",
+ "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": "",
@@ -2029,7 +1553,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/File"
+ "$ref": "#/components/schemas/Assistant"
}
}
}
@@ -2037,7 +1561,7 @@
}
},
"tags": [
- "Files"
+ "Assistants"
],
"security": [
{
@@ -2046,10 +1570,10 @@
]
}
},
- "/file/{id}": {
+ "/assistant/{id}": {
"get": {
- "operationId": "FileController_findOne",
- "summary": "Get File",
+ "operationId": "AssistantController_findOne",
+ "summary": "Get Assistant",
"parameters": [
{
"name": "id",
@@ -2066,14 +1590,14 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/File"
+ "$ref": "#/components/schemas/Assistant"
}
}
}
}
},
"tags": [
- "Files"
+ "Assistants"
],
"security": [
{
@@ -2082,8 +1606,8 @@
]
},
"patch": {
- "operationId": "FileController_update",
- "summary": "Update File",
+ "operationId": "AssistantController_update",
+ "summary": "Update Assistant",
"parameters": [
{
"name": "id",
@@ -2099,7 +1623,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UpdateFileDTO"
+ "$ref": "#/components/schemas/UpdateAssistantDTO"
}
}
}
@@ -2110,14 +1634,14 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/File"
+ "$ref": "#/components/schemas/Assistant"
}
}
}
}
},
"tags": [
- "Files"
+ "Assistants"
],
"security": [
{
@@ -2126,8 +1650,8 @@
]
},
"delete": {
- "operationId": "FileController_remove",
- "summary": "Delete File",
+ "operationId": "AssistantController_remove",
+ "summary": "Delete Assistant",
"parameters": [
{
"name": "id",
@@ -2144,14 +1668,14 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/File"
+ "$ref": "#/components/schemas/Assistant"
}
}
}
}
},
"tags": [
- "Files"
+ "Assistants"
],
"security": [
{
@@ -2160,10 +1684,10 @@
]
}
},
- "/knowledge-base": {
+ "/phone-number": {
"post": {
- "operationId": "KnowledgeBaseController_create",
- "summary": "Create Knowledge Base",
+ "operationId": "PhoneNumberController_create",
+ "summary": "Create Phone Number",
"parameters": [],
"requestBody": {
"required": true,
@@ -2172,19 +1696,34 @@
"schema": {
"oneOf": [
{
- "$ref": "#/components/schemas/CreateTrieveKnowledgeBaseDTO",
- "title": "TrieveKnowledgeBaseDTO"
+ "$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
+ "title": "ByoPhoneNumber"
},
{
- "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
- "title": "CustomKnowledgeBaseDTO"
+ "$ref": "#/components/schemas/CreateTwilioPhoneNumberDTO",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonagePhoneNumberDTO",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
}
],
"discriminator": {
"propertyName": "provider",
"mapping": {
- "trieve": "#/components/schemas/CreateTrieveKnowledgeBaseDTO",
- "custom-knowledge-base": "#/components/schemas/CreateCustomKnowledgeBaseDTO"
+ "byo-phone-number": "#/components/schemas/CreateByoPhoneNumberDTO",
+ "twilio": "#/components/schemas/CreateTwilioPhoneNumberDTO",
+ "vonage": "#/components/schemas/CreateVonagePhoneNumberDTO",
+ "vapi": "#/components/schemas/CreateVapiPhoneNumberDTO",
+ "telnyx": "#/components/schemas/CreateTelnyxPhoneNumberDTO"
}
}
}
@@ -2197,21 +1736,37 @@
"content": {
"application/json": {
"schema": {
+ "title": "PhoneNumber",
"oneOf": [
{
- "$ref": "#/components/schemas/TrieveKnowledgeBase",
- "title": "TrieveKnowledgeBase"
+ "$ref": "#/components/schemas/ByoPhoneNumber",
+ "title": "ByoPhoneNumber"
},
{
- "$ref": "#/components/schemas/CustomKnowledgeBase",
- "title": "CustomKnowledgeBase"
+ "$ref": "#/components/schemas/TwilioPhoneNumber",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/VonagePhoneNumber",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/VapiPhoneNumber",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/TelnyxPhoneNumber",
+ "title": "TelnyxPhoneNumber"
}
],
"discriminator": {
"propertyName": "provider",
"mapping": {
- "trieve": "#/components/schemas/TrieveKnowledgeBase",
- "custom-knowledge-base": "#/components/schemas/CustomKnowledgeBase"
+ "byo-phone-number": "#/components/schemas/ByoPhoneNumber",
+ "twilio": "#/components/schemas/TwilioPhoneNumber",
+ "vonage": "#/components/schemas/VonagePhoneNumber",
+ "vapi": "#/components/schemas/VapiPhoneNumber",
+ "telnyx": "#/components/schemas/TelnyxPhoneNumber"
}
}
}
@@ -2220,7 +1775,7 @@
}
},
"tags": [
- "Knowledge Base"
+ "Phone Numbers"
],
"security": [
{
@@ -2229,8 +1784,8 @@
]
},
"get": {
- "operationId": "KnowledgeBaseController_findAll",
- "summary": "List Knowledge Bases",
+ "operationId": "PhoneNumberController_findAll",
+ "summary": "List Phone Numbers",
"parameters": [
{
"name": "limit",
@@ -2332,21 +1887,37 @@
"schema": {
"type": "array",
"items": {
+ "title": "PhoneNumber",
"oneOf": [
{
- "$ref": "#/components/schemas/TrieveKnowledgeBase",
- "title": "TrieveKnowledgeBase"
+ "$ref": "#/components/schemas/ByoPhoneNumber",
+ "title": "ByoPhoneNumber"
},
{
- "$ref": "#/components/schemas/CustomKnowledgeBase",
- "title": "CustomKnowledgeBase"
+ "$ref": "#/components/schemas/TwilioPhoneNumber",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/VonagePhoneNumber",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/VapiPhoneNumber",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/TelnyxPhoneNumber",
+ "title": "TelnyxPhoneNumber"
}
],
"discriminator": {
"propertyName": "provider",
"mapping": {
- "trieve": "#/components/schemas/TrieveKnowledgeBase",
- "custom-knowledge-base": "#/components/schemas/CustomKnowledgeBase"
+ "byo-phone-number": "#/components/schemas/ByoPhoneNumber",
+ "twilio": "#/components/schemas/TwilioPhoneNumber",
+ "vonage": "#/components/schemas/VonagePhoneNumber",
+ "vapi": "#/components/schemas/VapiPhoneNumber",
+ "telnyx": "#/components/schemas/TelnyxPhoneNumber"
}
}
}
@@ -2356,7 +1927,7 @@
}
},
"tags": [
- "Knowledge Base"
+ "Phone Numbers"
],
"security": [
{
@@ -2365,10 +1936,10 @@
]
}
},
- "/knowledge-base/{id}": {
+ "/phone-number/{id}": {
"get": {
- "operationId": "KnowledgeBaseController_findOne",
- "summary": "Get Knowledge Base",
+ "operationId": "PhoneNumberController_findOne",
+ "summary": "Get Phone Number",
"parameters": [
{
"name": "id",
@@ -2385,21 +1956,37 @@
"content": {
"application/json": {
"schema": {
+ "title": "PhoneNumber",
"oneOf": [
{
- "$ref": "#/components/schemas/TrieveKnowledgeBase",
- "title": "TrieveKnowledgeBase"
+ "$ref": "#/components/schemas/ByoPhoneNumber",
+ "title": "ByoPhoneNumber"
},
{
- "$ref": "#/components/schemas/CustomKnowledgeBase",
- "title": "CustomKnowledgeBase"
- }
- ],
- "discriminator": {
- "propertyName": "provider",
- "mapping": {
- "trieve": "#/components/schemas/TrieveKnowledgeBase",
- "custom-knowledge-base": "#/components/schemas/CustomKnowledgeBase"
+ "$ref": "#/components/schemas/TwilioPhoneNumber",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/VonagePhoneNumber",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/VapiPhoneNumber",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/TelnyxPhoneNumber",
+ "title": "TelnyxPhoneNumber"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "provider",
+ "mapping": {
+ "byo-phone-number": "#/components/schemas/ByoPhoneNumber",
+ "twilio": "#/components/schemas/TwilioPhoneNumber",
+ "vonage": "#/components/schemas/VonagePhoneNumber",
+ "vapi": "#/components/schemas/VapiPhoneNumber",
+ "telnyx": "#/components/schemas/TelnyxPhoneNumber"
}
}
}
@@ -2408,7 +1995,7 @@
}
},
"tags": [
- "Knowledge Base"
+ "Phone Numbers"
],
"security": [
{
@@ -2417,8 +2004,8 @@
]
},
"patch": {
- "operationId": "KnowledgeBaseController_update",
- "summary": "Update Knowledge Base",
+ "operationId": "PhoneNumberController_update",
+ "summary": "Update Phone Number",
"parameters": [
{
"name": "id",
@@ -2436,19 +2023,34 @@
"schema": {
"oneOf": [
{
- "$ref": "#/components/schemas/UpdateTrieveKnowledgeBaseDTO",
- "title": "UpdateTrieveKnowledgeBaseDTO"
+ "$ref": "#/components/schemas/UpdateByoPhoneNumberDTO",
+ "title": "ByoPhoneNumber"
},
{
- "$ref": "#/components/schemas/UpdateCustomKnowledgeBaseDTO",
- "title": "UpdateCustomKnowledgeBaseDTO"
+ "$ref": "#/components/schemas/UpdateTwilioPhoneNumberDTO",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateVonagePhoneNumberDTO",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateVapiPhoneNumberDTO",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
}
],
"discriminator": {
"propertyName": "provider",
"mapping": {
- "trieve": "#/components/schemas/UpdateTrieveKnowledgeBaseDTO",
- "custom-knowledge-base": "#/components/schemas/UpdateCustomKnowledgeBaseDTO"
+ "byo-phone-number": "#/components/schemas/UpdateByoPhoneNumberDTO",
+ "twilio": "#/components/schemas/UpdateTwilioPhoneNumberDTO",
+ "vonage": "#/components/schemas/UpdateVonagePhoneNumberDTO",
+ "vapi": "#/components/schemas/UpdateVapiPhoneNumberDTO",
+ "telnyx": "#/components/schemas/UpdateTelnyxPhoneNumberDTO"
}
}
}
@@ -2461,21 +2063,37 @@
"content": {
"application/json": {
"schema": {
+ "title": "PhoneNumber",
"oneOf": [
{
- "$ref": "#/components/schemas/TrieveKnowledgeBase",
- "title": "TrieveKnowledgeBase"
+ "$ref": "#/components/schemas/ByoPhoneNumber",
+ "title": "ByoPhoneNumber"
},
{
- "$ref": "#/components/schemas/CustomKnowledgeBase",
- "title": "CustomKnowledgeBase"
+ "$ref": "#/components/schemas/TwilioPhoneNumber",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/VonagePhoneNumber",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/VapiPhoneNumber",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/TelnyxPhoneNumber",
+ "title": "TelnyxPhoneNumber"
}
],
"discriminator": {
"propertyName": "provider",
"mapping": {
- "trieve": "#/components/schemas/TrieveKnowledgeBase",
- "custom-knowledge-base": "#/components/schemas/CustomKnowledgeBase"
+ "byo-phone-number": "#/components/schemas/ByoPhoneNumber",
+ "twilio": "#/components/schemas/TwilioPhoneNumber",
+ "vonage": "#/components/schemas/VonagePhoneNumber",
+ "vapi": "#/components/schemas/VapiPhoneNumber",
+ "telnyx": "#/components/schemas/TelnyxPhoneNumber"
}
}
}
@@ -2484,7 +2102,7 @@
}
},
"tags": [
- "Knowledge Base"
+ "Phone Numbers"
],
"security": [
{
@@ -2493,8 +2111,8 @@
]
},
"delete": {
- "operationId": "KnowledgeBaseController_remove",
- "summary": "Delete Knowledge Base",
+ "operationId": "PhoneNumberController_remove",
+ "summary": "Delete Phone Number",
"parameters": [
{
"name": "id",
@@ -2511,21 +2129,37 @@
"content": {
"application/json": {
"schema": {
+ "title": "PhoneNumber",
"oneOf": [
{
- "$ref": "#/components/schemas/TrieveKnowledgeBase",
- "title": "TrieveKnowledgeBase"
+ "$ref": "#/components/schemas/ByoPhoneNumber",
+ "title": "ByoPhoneNumber"
},
{
- "$ref": "#/components/schemas/CustomKnowledgeBase",
- "title": "CustomKnowledgeBase"
+ "$ref": "#/components/schemas/TwilioPhoneNumber",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/VonagePhoneNumber",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/VapiPhoneNumber",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/TelnyxPhoneNumber",
+ "title": "TelnyxPhoneNumber"
}
],
"discriminator": {
"propertyName": "provider",
"mapping": {
- "trieve": "#/components/schemas/TrieveKnowledgeBase",
- "custom-knowledge-base": "#/components/schemas/CustomKnowledgeBase"
+ "byo-phone-number": "#/components/schemas/ByoPhoneNumber",
+ "twilio": "#/components/schemas/TwilioPhoneNumber",
+ "vonage": "#/components/schemas/VonagePhoneNumber",
+ "vapi": "#/components/schemas/VapiPhoneNumber",
+ "telnyx": "#/components/schemas/TelnyxPhoneNumber"
}
}
}
@@ -2534,7 +2168,7 @@
}
},
"tags": [
- "Knowledge Base"
+ "Phone Numbers"
],
"security": [
{
@@ -2543,214 +2177,267 @@
]
}
},
- "/workflow": {
- "get": {
- "operationId": "WorkflowController_findAll",
- "summary": "Get Workflows",
- "parameters": [],
- "responses": {
- "200": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Workflow"
- }
- }
- }
- }
- }
- },
- "tags": [
- "Workflow"
- ],
- "security": [
- {
- "bearer": []
- }
- ]
- },
+ "/tool": {
"post": {
- "operationId": "WorkflowController_create",
- "summary": "Create Workflow",
+ "operationId": "ToolController_create",
+ "summary": "Create Tool",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CreateWorkflowDTO"
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Workflow"
- }
- }
- }
- }
- },
- "tags": [
- "Workflow"
- ],
- "security": [
- {
- "bearer": []
- }
- ]
- }
- },
- "/workflow/{id}": {
- "get": {
- "operationId": "WorkflowController_findOne",
- "summary": "Get Workflow",
- "parameters": [
- {
- "name": "id",
- "required": true,
- "in": "path",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Workflow"
- }
- }
- }
- }
- },
- "tags": [
- "Workflow"
- ],
- "security": [
- {
- "bearer": []
- }
- ]
- },
- "delete": {
- "operationId": "WorkflowController_delete",
- "summary": "Delete Workflow",
- "parameters": [
- {
- "name": "id",
- "required": true,
- "in": "path",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Workflow"
- }
- }
- }
- }
- },
- "tags": [
- "Workflow"
- ],
- "security": [
- {
- "bearer": []
- }
- ]
- },
- "patch": {
- "operationId": "WorkflowController_update",
- "summary": "Update Workflow",
- "parameters": [
- {
- "name": "id",
- "required": true,
- "in": "path",
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/UpdateWorkflowDTO"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Workflow"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateApiRequestToolDTO",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDtmfToolDTO",
+ "title": "DtmfTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateEndCallToolDTO",
+ "title": "EndCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateFunctionToolDTO",
+ "title": "FunctionTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGhlToolDTO",
+ "title": "GhlTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMakeToolDTO",
+ "title": "MakeTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTransferCallToolDTO",
+ "title": "TransferCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateOutputToolDTO",
+ "title": "OutputTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateBashToolDTO",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateComputerToolDTO",
+ "title": "ComputerTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTextEditorToolDTO",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateQueryToolDTO",
+ "title": "QueryTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
+ "title": "GoogleCalendarCreateEventTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
+ "title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
+ "title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmsToolDTO",
+ "title": "SmsSendTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "apiRequest": "#/components/schemas/CreateApiRequestToolDTO",
+ "dtmf": "#/components/schemas/CreateDtmfToolDTO",
+ "endCall": "#/components/schemas/CreateEndCallToolDTO",
+ "function": "#/components/schemas/CreateFunctionToolDTO",
+ "ghl": "#/components/schemas/CreateGhlToolDTO",
+ "make": "#/components/schemas/CreateMakeToolDTO",
+ "transferCall": "#/components/schemas/CreateTransferCallToolDTO",
+ "output": "#/components/schemas/CreateOutputToolDTO",
+ "bash": "#/components/schemas/CreateBashToolDTO",
+ "computer": "#/components/schemas/CreateComputerToolDTO",
+ "textEditor": "#/components/schemas/CreateTextEditorToolDTO",
+ "query": "#/components/schemas/CreateQueryToolDTO",
+ "google.calendar.event.create": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
+ "google.sheets.row.append": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
+ "google.calendar.availability.check": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "slack.message.send": "#/components/schemas/CreateSlackSendMessageToolDTO",
+ "sms": "#/components/schemas/CreateSmsToolDTO",
+ "mcp": "#/components/schemas/CreateMcpToolDTO",
+ "gohighlevel.calendar.availability.check": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "gohighlevel.calendar.event.create": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "gohighlevel.contact.create": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "gohighlevel.contact.get": "#/components/schemas/CreateGoHighLevelContactGetToolDTO"
+ }
}
}
}
}
},
- "tags": [
- "Workflow"
- ],
- "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"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ApiRequestTool",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/DtmfTool",
+ "title": "DtmfTool"
+ },
+ {
+ "$ref": "#/components/schemas/EndCallTool",
+ "title": "EndCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/FunctionTool",
+ "title": "FunctionTool"
+ },
+ {
+ "$ref": "#/components/schemas/GhlTool",
+ "title": "GhlTool"
+ },
+ {
+ "$ref": "#/components/schemas/MakeTool",
+ "title": "MakeTool"
+ },
+ {
+ "$ref": "#/components/schemas/TransferCallTool",
+ "title": "TransferCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/OutputTool",
+ "title": "OutputTool"
+ },
+ {
+ "$ref": "#/components/schemas/BashTool",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/ComputerTool",
+ "title": "ComputerTool"
+ },
+ {
+ "$ref": "#/components/schemas/TextEditorTool",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/QueryTool",
+ "title": "QueryTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleCalendarCreateEventTool",
+ "title": "GoogleCalendarCreateEventTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleSheetsRowAppendTool",
+ "title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleCalendarCheckAvailabilityTool",
+ "title": "GoogleCalendarCheckAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/SlackSendMessageTool",
+ "title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/SmsTool",
+ "title": "SmsSendTool"
+ },
+ {
+ "$ref": "#/components/schemas/McpTool",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelCalendarAvailabilityTool",
+ "title": "GoHighLevelCalendarAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelCalendarEventCreateTool",
+ "title": "GoHighLevelCalendarEventCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelContactCreateTool",
+ "title": "GoHighLevelContactCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelContactGetTool",
+ "title": "GoHighLevelContactGetTool"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "apiRequest": "#/components/schemas/ApiRequestTool",
+ "dtmf": "#/components/schemas/DtmfTool",
+ "endCall": "#/components/schemas/EndCallTool",
+ "function": "#/components/schemas/FunctionTool",
+ "ghl": "#/components/schemas/GhlTool",
+ "make": "#/components/schemas/MakeTool",
+ "transferCall": "#/components/schemas/TransferCallTool",
+ "output": "#/components/schemas/OutputTool",
+ "bash": "#/components/schemas/BashTool",
+ "computer": "#/components/schemas/ComputerTool",
+ "textEditor": "#/components/schemas/TextEditorTool",
+ "query": "#/components/schemas/QueryTool",
+ "google.calendar.event.create": "#/components/schemas/GoogleCalendarCreateEventTool",
+ "google.sheets.row.append": "#/components/schemas/GoogleSheetsRowAppendTool",
+ "google.calendar.availability.check": "#/components/schemas/GoogleCalendarCheckAvailabilityTool",
+ "slack.message.send": "#/components/schemas/SlackSendMessageTool",
+ "sms": "#/components/schemas/SmsTool",
+ "mcp": "#/components/schemas/McpTool",
+ "gohighlevel.calendar.availability.check": "#/components/schemas/GoHighLevelCalendarAvailabilityTool",
+ "gohighlevel.calendar.event.create": "#/components/schemas/GoHighLevelCalendarEventCreateTool",
+ "gohighlevel.contact.create": "#/components/schemas/GoHighLevelContactCreateTool",
+ "gohighlevel.contact.get": "#/components/schemas/GoHighLevelContactGetTool"
+ }
+ }
}
}
}
}
},
"tags": [
- "Squads"
+ "Tools"
],
"security": [
{
@@ -2759,8 +2446,8 @@
]
},
"get": {
- "operationId": "SquadController_findAll",
- "summary": "List Squads",
+ "operationId": "ToolController_findAll",
+ "summary": "List Tools",
"parameters": [
{
"name": "limit",
@@ -2862,15 +2549,131 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/Squad"
- }
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ApiRequestTool",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/DtmfTool",
+ "title": "DtmfTool"
+ },
+ {
+ "$ref": "#/components/schemas/EndCallTool",
+ "title": "EndCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/FunctionTool",
+ "title": "FunctionTool"
+ },
+ {
+ "$ref": "#/components/schemas/GhlTool",
+ "title": "GhlTool"
+ },
+ {
+ "$ref": "#/components/schemas/MakeTool",
+ "title": "MakeTool"
+ },
+ {
+ "$ref": "#/components/schemas/TransferCallTool",
+ "title": "TransferCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/OutputTool",
+ "title": "OutputTool"
+ },
+ {
+ "$ref": "#/components/schemas/BashTool",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/ComputerTool",
+ "title": "ComputerTool"
+ },
+ {
+ "$ref": "#/components/schemas/TextEditorTool",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/QueryTool",
+ "title": "QueryTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleCalendarCreateEventTool",
+ "title": "GoogleCalendarCreateEventTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleSheetsRowAppendTool",
+ "title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleCalendarCheckAvailabilityTool",
+ "title": "GoogleCalendarCheckAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/SlackSendMessageTool",
+ "title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/SmsTool",
+ "title": "SmsSendTool"
+ },
+ {
+ "$ref": "#/components/schemas/McpTool",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelCalendarAvailabilityTool",
+ "title": "GoHighLevelCalendarAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelCalendarEventCreateTool",
+ "title": "GoHighLevelCalendarEventCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelContactCreateTool",
+ "title": "GoHighLevelContactCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelContactGetTool",
+ "title": "GoHighLevelContactGetTool"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "apiRequest": "#/components/schemas/ApiRequestTool",
+ "dtmf": "#/components/schemas/DtmfTool",
+ "endCall": "#/components/schemas/EndCallTool",
+ "function": "#/components/schemas/FunctionTool",
+ "ghl": "#/components/schemas/GhlTool",
+ "make": "#/components/schemas/MakeTool",
+ "transferCall": "#/components/schemas/TransferCallTool",
+ "output": "#/components/schemas/OutputTool",
+ "bash": "#/components/schemas/BashTool",
+ "computer": "#/components/schemas/ComputerTool",
+ "textEditor": "#/components/schemas/TextEditorTool",
+ "query": "#/components/schemas/QueryTool",
+ "google.calendar.event.create": "#/components/schemas/GoogleCalendarCreateEventTool",
+ "google.sheets.row.append": "#/components/schemas/GoogleSheetsRowAppendTool",
+ "google.calendar.availability.check": "#/components/schemas/GoogleCalendarCheckAvailabilityTool",
+ "slack.message.send": "#/components/schemas/SlackSendMessageTool",
+ "sms": "#/components/schemas/SmsTool",
+ "mcp": "#/components/schemas/McpTool",
+ "gohighlevel.calendar.availability.check": "#/components/schemas/GoHighLevelCalendarAvailabilityTool",
+ "gohighlevel.calendar.event.create": "#/components/schemas/GoHighLevelCalendarEventCreateTool",
+ "gohighlevel.contact.create": "#/components/schemas/GoHighLevelContactCreateTool",
+ "gohighlevel.contact.get": "#/components/schemas/GoHighLevelContactGetTool"
+ }
+ }
+ }
}
}
}
}
},
"tags": [
- "Squads"
+ "Tools"
],
"security": [
{
@@ -2879,10 +2682,10 @@
]
}
},
- "/squad/{id}": {
+ "/tool/{id}": {
"get": {
- "operationId": "SquadController_findOne",
- "summary": "Get Squad",
+ "operationId": "ToolController_findOne",
+ "summary": "Get Tool",
"parameters": [
{
"name": "id",
@@ -2899,14 +2702,130 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Squad"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ApiRequestTool",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/DtmfTool",
+ "title": "DtmfTool"
+ },
+ {
+ "$ref": "#/components/schemas/EndCallTool",
+ "title": "EndCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/FunctionTool",
+ "title": "FunctionTool"
+ },
+ {
+ "$ref": "#/components/schemas/GhlTool",
+ "title": "GhlTool"
+ },
+ {
+ "$ref": "#/components/schemas/MakeTool",
+ "title": "MakeTool"
+ },
+ {
+ "$ref": "#/components/schemas/TransferCallTool",
+ "title": "TransferCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/OutputTool",
+ "title": "OutputTool"
+ },
+ {
+ "$ref": "#/components/schemas/BashTool",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/ComputerTool",
+ "title": "ComputerTool"
+ },
+ {
+ "$ref": "#/components/schemas/TextEditorTool",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/QueryTool",
+ "title": "QueryTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleCalendarCreateEventTool",
+ "title": "GoogleCalendarCreateEventTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleSheetsRowAppendTool",
+ "title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleCalendarCheckAvailabilityTool",
+ "title": "GoogleCalendarCheckAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/SlackSendMessageTool",
+ "title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/SmsTool",
+ "title": "SmsSendTool"
+ },
+ {
+ "$ref": "#/components/schemas/McpTool",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelCalendarAvailabilityTool",
+ "title": "GoHighLevelCalendarAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelCalendarEventCreateTool",
+ "title": "GoHighLevelCalendarEventCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelContactCreateTool",
+ "title": "GoHighLevelContactCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelContactGetTool",
+ "title": "GoHighLevelContactGetTool"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "apiRequest": "#/components/schemas/ApiRequestTool",
+ "dtmf": "#/components/schemas/DtmfTool",
+ "endCall": "#/components/schemas/EndCallTool",
+ "function": "#/components/schemas/FunctionTool",
+ "ghl": "#/components/schemas/GhlTool",
+ "make": "#/components/schemas/MakeTool",
+ "transferCall": "#/components/schemas/TransferCallTool",
+ "output": "#/components/schemas/OutputTool",
+ "bash": "#/components/schemas/BashTool",
+ "computer": "#/components/schemas/ComputerTool",
+ "textEditor": "#/components/schemas/TextEditorTool",
+ "query": "#/components/schemas/QueryTool",
+ "google.calendar.event.create": "#/components/schemas/GoogleCalendarCreateEventTool",
+ "google.sheets.row.append": "#/components/schemas/GoogleSheetsRowAppendTool",
+ "google.calendar.availability.check": "#/components/schemas/GoogleCalendarCheckAvailabilityTool",
+ "slack.message.send": "#/components/schemas/SlackSendMessageTool",
+ "sms": "#/components/schemas/SmsTool",
+ "mcp": "#/components/schemas/McpTool",
+ "gohighlevel.calendar.availability.check": "#/components/schemas/GoHighLevelCalendarAvailabilityTool",
+ "gohighlevel.calendar.event.create": "#/components/schemas/GoHighLevelCalendarEventCreateTool",
+ "gohighlevel.contact.create": "#/components/schemas/GoHighLevelContactCreateTool",
+ "gohighlevel.contact.get": "#/components/schemas/GoHighLevelContactGetTool"
+ }
+ }
}
}
}
}
},
"tags": [
- "Squads"
+ "Tools"
],
"security": [
{
@@ -2915,8 +2834,8 @@
]
},
"patch": {
- "operationId": "SquadController_update",
- "summary": "Update Squad",
+ "operationId": "ToolController_update",
+ "summary": "Update Tool",
"parameters": [
{
"name": "id",
@@ -2932,7 +2851,123 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UpdateSquadDTO"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/UpdateApiRequestToolDTO",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateDtmfToolDTO",
+ "title": "DtmfTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateEndCallToolDTO",
+ "title": "EndCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateFunctionToolDTO",
+ "title": "FunctionTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateGhlToolDTO",
+ "title": "GhlTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateMakeToolDTO",
+ "title": "MakeTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateTransferCallToolDTO",
+ "title": "TransferCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateOutputToolDTO",
+ "title": "OutputTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateBashToolDTO",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateComputerToolDTO",
+ "title": "ComputerTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateTextEditorToolDTO",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateQueryToolDTO",
+ "title": "QueryTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateGoogleCalendarCreateEventToolDTO",
+ "title": "GoogleCalendarCreateEventTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateGoogleSheetsRowAppendToolDTO",
+ "title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateSlackSendMessageToolDTO",
+ "title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateSmsToolDTO",
+ "title": "SmsSendTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "apiRequest": "#/components/schemas/UpdateApiRequestToolDTO",
+ "dtmf": "#/components/schemas/UpdateDtmfToolDTO",
+ "endCall": "#/components/schemas/UpdateEndCallToolDTO",
+ "function": "#/components/schemas/UpdateFunctionToolDTO",
+ "ghl": "#/components/schemas/UpdateGhlToolDTO",
+ "make": "#/components/schemas/UpdateMakeToolDTO",
+ "transferCall": "#/components/schemas/UpdateTransferCallToolDTO",
+ "output": "#/components/schemas/UpdateOutputToolDTO",
+ "bash": "#/components/schemas/UpdateBashToolDTO",
+ "computer": "#/components/schemas/UpdateComputerToolDTO",
+ "textEditor": "#/components/schemas/UpdateTextEditorToolDTO",
+ "query": "#/components/schemas/UpdateQueryToolDTO",
+ "google.calendar.event.create": "#/components/schemas/UpdateGoogleCalendarCreateEventToolDTO",
+ "google.sheets.row.append": "#/components/schemas/UpdateGoogleSheetsRowAppendToolDTO",
+ "google.calendar.availability.check": "#/components/schemas/UpdateGoogleCalendarCheckAvailabilityToolDTO",
+ "slack.message.send": "#/components/schemas/UpdateSlackSendMessageToolDTO",
+ "sms": "#/components/schemas/UpdateSmsToolDTO",
+ "mcp": "#/components/schemas/UpdateMcpToolDTO",
+ "gohighlevel.calendar.availability.check": "#/components/schemas/UpdateGoHighLevelCalendarAvailabilityToolDTO",
+ "gohighlevel.calendar.event.create": "#/components/schemas/UpdateGoHighLevelCalendarEventCreateToolDTO",
+ "gohighlevel.contact.create": "#/components/schemas/UpdateGoHighLevelContactCreateToolDTO",
+ "gohighlevel.contact.get": "#/components/schemas/UpdateGoHighLevelContactGetToolDTO"
+ }
+ }
}
}
}
@@ -2943,14 +2978,130 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Squad"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ApiRequestTool",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/DtmfTool",
+ "title": "DtmfTool"
+ },
+ {
+ "$ref": "#/components/schemas/EndCallTool",
+ "title": "EndCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/FunctionTool",
+ "title": "FunctionTool"
+ },
+ {
+ "$ref": "#/components/schemas/GhlTool",
+ "title": "GhlTool"
+ },
+ {
+ "$ref": "#/components/schemas/MakeTool",
+ "title": "MakeTool"
+ },
+ {
+ "$ref": "#/components/schemas/TransferCallTool",
+ "title": "TransferCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/OutputTool",
+ "title": "OutputTool"
+ },
+ {
+ "$ref": "#/components/schemas/BashTool",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/ComputerTool",
+ "title": "ComputerTool"
+ },
+ {
+ "$ref": "#/components/schemas/TextEditorTool",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/QueryTool",
+ "title": "QueryTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleCalendarCreateEventTool",
+ "title": "GoogleCalendarCreateEventTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleSheetsRowAppendTool",
+ "title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleCalendarCheckAvailabilityTool",
+ "title": "GoogleCalendarCheckAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/SlackSendMessageTool",
+ "title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/SmsTool",
+ "title": "SmsSendTool"
+ },
+ {
+ "$ref": "#/components/schemas/McpTool",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelCalendarAvailabilityTool",
+ "title": "GoHighLevelCalendarAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelCalendarEventCreateTool",
+ "title": "GoHighLevelCalendarEventCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelContactCreateTool",
+ "title": "GoHighLevelContactCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelContactGetTool",
+ "title": "GoHighLevelContactGetTool"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "apiRequest": "#/components/schemas/ApiRequestTool",
+ "dtmf": "#/components/schemas/DtmfTool",
+ "endCall": "#/components/schemas/EndCallTool",
+ "function": "#/components/schemas/FunctionTool",
+ "ghl": "#/components/schemas/GhlTool",
+ "make": "#/components/schemas/MakeTool",
+ "transferCall": "#/components/schemas/TransferCallTool",
+ "output": "#/components/schemas/OutputTool",
+ "bash": "#/components/schemas/BashTool",
+ "computer": "#/components/schemas/ComputerTool",
+ "textEditor": "#/components/schemas/TextEditorTool",
+ "query": "#/components/schemas/QueryTool",
+ "google.calendar.event.create": "#/components/schemas/GoogleCalendarCreateEventTool",
+ "google.sheets.row.append": "#/components/schemas/GoogleSheetsRowAppendTool",
+ "google.calendar.availability.check": "#/components/schemas/GoogleCalendarCheckAvailabilityTool",
+ "slack.message.send": "#/components/schemas/SlackSendMessageTool",
+ "sms": "#/components/schemas/SmsTool",
+ "mcp": "#/components/schemas/McpTool",
+ "gohighlevel.calendar.availability.check": "#/components/schemas/GoHighLevelCalendarAvailabilityTool",
+ "gohighlevel.calendar.event.create": "#/components/schemas/GoHighLevelCalendarEventCreateTool",
+ "gohighlevel.contact.create": "#/components/schemas/GoHighLevelContactCreateTool",
+ "gohighlevel.contact.get": "#/components/schemas/GoHighLevelContactGetTool"
+ }
+ }
}
}
}
}
},
"tags": [
- "Squads"
+ "Tools"
],
"security": [
{
@@ -2959,8 +3110,8 @@
]
},
"delete": {
- "operationId": "SquadController_remove",
- "summary": "Delete Squad",
+ "operationId": "ToolController_remove",
+ "summary": "Delete Tool",
"parameters": [
{
"name": "id",
@@ -2977,191 +3128,198 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Squad"
- }
- }
- }
- }
- },
- "tags": [
- "Squads"
- ],
- "security": [
- {
- "bearer": []
- }
- ]
- }
- },
- "/test-suite": {
- "get": {
- "operationId": "TestSuiteController_findAllPaginated",
- "summary": "List Test Suites",
- "parameters": [
- {
- "name": "page",
- "required": false,
- "in": "query",
- "description": "This is the page number to return. Defaults to 1.",
- "schema": {
- "minimum": 1,
- "type": "number"
- }
- },
- {
- "name": "sortOrder",
- "required": false,
- "in": "query",
- "description": "This is the sort order for pagination. Defaults to 'DESC'.",
- "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"
- }
- },
- {
- "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": {
- "$ref": "#/components/schemas/TestSuitesPaginatedResponse"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ApiRequestTool",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/DtmfTool",
+ "title": "DtmfTool"
+ },
+ {
+ "$ref": "#/components/schemas/EndCallTool",
+ "title": "EndCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/FunctionTool",
+ "title": "FunctionTool"
+ },
+ {
+ "$ref": "#/components/schemas/GhlTool",
+ "title": "GhlTool"
+ },
+ {
+ "$ref": "#/components/schemas/MakeTool",
+ "title": "MakeTool"
+ },
+ {
+ "$ref": "#/components/schemas/TransferCallTool",
+ "title": "TransferCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/OutputTool",
+ "title": "OutputTool"
+ },
+ {
+ "$ref": "#/components/schemas/BashTool",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/ComputerTool",
+ "title": "ComputerTool"
+ },
+ {
+ "$ref": "#/components/schemas/TextEditorTool",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/QueryTool",
+ "title": "QueryTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleCalendarCreateEventTool",
+ "title": "GoogleCalendarCreateEventTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleSheetsRowAppendTool",
+ "title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleCalendarCheckAvailabilityTool",
+ "title": "GoogleCalendarCheckAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/SlackSendMessageTool",
+ "title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/SmsTool",
+ "title": "SmsSendTool"
+ },
+ {
+ "$ref": "#/components/schemas/McpTool",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelCalendarAvailabilityTool",
+ "title": "GoHighLevelCalendarAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelCalendarEventCreateTool",
+ "title": "GoHighLevelCalendarEventCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelContactCreateTool",
+ "title": "GoHighLevelContactCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelContactGetTool",
+ "title": "GoHighLevelContactGetTool"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "apiRequest": "#/components/schemas/ApiRequestTool",
+ "dtmf": "#/components/schemas/DtmfTool",
+ "endCall": "#/components/schemas/EndCallTool",
+ "function": "#/components/schemas/FunctionTool",
+ "ghl": "#/components/schemas/GhlTool",
+ "make": "#/components/schemas/MakeTool",
+ "transferCall": "#/components/schemas/TransferCallTool",
+ "output": "#/components/schemas/OutputTool",
+ "bash": "#/components/schemas/BashTool",
+ "computer": "#/components/schemas/ComputerTool",
+ "textEditor": "#/components/schemas/TextEditorTool",
+ "query": "#/components/schemas/QueryTool",
+ "google.calendar.event.create": "#/components/schemas/GoogleCalendarCreateEventTool",
+ "google.sheets.row.append": "#/components/schemas/GoogleSheetsRowAppendTool",
+ "google.calendar.availability.check": "#/components/schemas/GoogleCalendarCheckAvailabilityTool",
+ "slack.message.send": "#/components/schemas/SlackSendMessageTool",
+ "sms": "#/components/schemas/SmsTool",
+ "mcp": "#/components/schemas/McpTool",
+ "gohighlevel.calendar.availability.check": "#/components/schemas/GoHighLevelCalendarAvailabilityTool",
+ "gohighlevel.calendar.event.create": "#/components/schemas/GoHighLevelCalendarEventCreateTool",
+ "gohighlevel.contact.create": "#/components/schemas/GoHighLevelContactCreateTool",
+ "gohighlevel.contact.get": "#/components/schemas/GoHighLevelContactGetTool"
+ }
+ }
}
}
}
}
},
"tags": [
- "Test Suites"
+ "Tools"
],
"security": [
{
"bearer": []
}
]
- },
+ }
+ },
+ "/file": {
"post": {
- "operationId": "TestSuiteController_create",
- "summary": "Create Test Suite",
+ "operationId": "FileController_create",
+ "summary": "Upload File",
"parameters": [],
"requestBody": {
"required": true,
"content": {
- "application/json": {
+ "multipart/form-data": {
"schema": {
- "$ref": "#/components/schemas/CreateTestSuiteDto"
+ "$ref": "#/components/schemas/CreateFileDTO"
}
}
}
},
"responses": {
"201": {
+ "description": "File uploaded successfully",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/File"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid file"
+ }
+ },
+ "tags": [
+ "Files"
+ ],
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ },
+ "get": {
+ "operationId": "FileController_findAll",
+ "summary": "List Files",
+ "parameters": [],
+ "responses": {
+ "200": {
"description": "",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TestSuite"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/File"
+ }
}
}
}
}
},
"tags": [
- "Test Suites"
+ "Files"
],
"security": [
{
@@ -3170,10 +3328,10 @@
]
}
},
- "/test-suite/{id}": {
+ "/file/{id}": {
"get": {
- "operationId": "TestSuiteController_findOne",
- "summary": "Get Test Suite",
+ "operationId": "FileController_findOne",
+ "summary": "Get File",
"parameters": [
{
"name": "id",
@@ -3190,14 +3348,14 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TestSuite"
+ "$ref": "#/components/schemas/File"
}
}
}
}
},
"tags": [
- "Test Suites"
+ "Files"
],
"security": [
{
@@ -3206,8 +3364,8 @@
]
},
"patch": {
- "operationId": "TestSuiteController_update",
- "summary": "Update Test Suite",
+ "operationId": "FileController_update",
+ "summary": "Update File",
"parameters": [
{
"name": "id",
@@ -3223,7 +3381,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UpdateTestSuiteDto"
+ "$ref": "#/components/schemas/UpdateFileDTO"
}
}
}
@@ -3234,14 +3392,14 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TestSuite"
+ "$ref": "#/components/schemas/File"
}
}
}
}
},
"tags": [
- "Test Suites"
+ "Files"
],
"security": [
{
@@ -3250,8 +3408,8 @@
]
},
"delete": {
- "operationId": "TestSuiteController_remove",
- "summary": "Delete Test Suite",
+ "operationId": "FileController_remove",
+ "summary": "Delete File",
"parameters": [
{
"name": "id",
@@ -3268,14 +3426,14 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TestSuite"
+ "$ref": "#/components/schemas/File"
}
}
}
}
},
"tags": [
- "Test Suites"
+ "Files"
],
"security": [
{
@@ -3284,42 +3442,78 @@
]
}
},
- "/test-suite/{testSuiteId}/test": {
- "get": {
- "operationId": "TestSuiteTestController_findAllPaginated",
- "summary": "List Tests",
- "parameters": [
- {
- "name": "testSuiteId",
- "required": true,
- "in": "path",
- "schema": {
- "type": "string"
+ "/knowledge-base": {
+ "post": {
+ "operationId": "KnowledgeBaseController_create",
+ "summary": "Create Knowledge Base",
+ "parameters": [],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateTrieveKnowledgeBaseDTO",
+ "title": "TrieveKnowledgeBaseDTO"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
+ "title": "CustomKnowledgeBaseDTO"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "provider",
+ "mapping": {
+ "trieve": "#/components/schemas/CreateTrieveKnowledgeBaseDTO",
+ "custom-knowledge-base": "#/components/schemas/CreateCustomKnowledgeBaseDTO"
+ }
+ }
+ }
}
- },
- {
- "name": "page",
- "required": false,
- "in": "query",
- "description": "This is the page number to return. Defaults to 1.",
- "schema": {
- "minimum": 1,
- "type": "number"
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TrieveKnowledgeBase",
+ "title": "TrieveKnowledgeBase"
+ },
+ {
+ "$ref": "#/components/schemas/CustomKnowledgeBase",
+ "title": "CustomKnowledgeBase"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "provider",
+ "mapping": {
+ "trieve": "#/components/schemas/TrieveKnowledgeBase",
+ "custom-knowledge-base": "#/components/schemas/CustomKnowledgeBase"
+ }
+ }
+ }
+ }
}
- },
+ }
+ },
+ "tags": [
+ "Knowledge Base"
+ ],
+ "security": [
{
- "name": "sortOrder",
- "required": false,
- "in": "query",
- "description": "This is the sort order for pagination. Defaults to 'DESC'.",
- "schema": {
- "enum": [
- "ASC",
- "DESC"
- ],
- "type": "string"
- }
- },
+ "bearer": []
+ }
+ ]
+ },
+ "get": {
+ "operationId": "KnowledgeBaseController_findAll",
+ "summary": "List Knowledge Bases",
+ "parameters": [
{
"name": "limit",
"required": false,
@@ -3418,81 +3612,24 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TestSuiteTestsPaginatedResponse"
- }
- }
- }
- }
- },
- "tags": [
- "Test Suite Tests"
- ],
- "security": [
- {
- "bearer": []
- }
- ]
- },
- "post": {
- "operationId": "TestSuiteTestController_create",
- "summary": "Create Test",
- "parameters": [
- {
- "name": "testSuiteId",
- "required": true,
- "in": "path",
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/CreateTestSuiteTestVoiceDto",
- "title": "TestSuiteTestVoice"
- },
- {
- "$ref": "#/components/schemas/CreateTestSuiteTestChatDto",
- "title": "TestSuiteTestChat"
- }
- ],
- "discriminator": {
- "propertyName": "type",
- "mapping": {
- "voice": "#/components/schemas/CreateTestSuiteTestVoiceDto",
- "chat": "#/components/schemas/CreateTestSuiteTestChatDto"
- }
- }
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/TestSuiteTestVoice",
- "title": "Voice"
- },
- {
- "$ref": "#/components/schemas/TestSuiteTestChat",
- "title": "Chat"
- }
- ],
- "discriminator": {
- "propertyName": "type",
- "mapping": {
- "voice": "#/components/schemas/TestSuiteTestVoice",
- "chat": "#/components/schemas/TestSuiteTestChat"
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TrieveKnowledgeBase",
+ "title": "TrieveKnowledgeBase"
+ },
+ {
+ "$ref": "#/components/schemas/CustomKnowledgeBase",
+ "title": "CustomKnowledgeBase"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "provider",
+ "mapping": {
+ "trieve": "#/components/schemas/TrieveKnowledgeBase",
+ "custom-knowledge-base": "#/components/schemas/CustomKnowledgeBase"
+ }
}
}
}
@@ -3501,7 +3638,7 @@
}
},
"tags": [
- "Test Suite Tests"
+ "Knowledge Base"
],
"security": [
{
@@ -3510,19 +3647,11 @@
]
}
},
- "/test-suite/{testSuiteId}/test/{id}": {
+ "/knowledge-base/{id}": {
"get": {
- "operationId": "TestSuiteTestController_findOne",
- "summary": "Get Test",
+ "operationId": "KnowledgeBaseController_findOne",
+ "summary": "Get Knowledge Base",
"parameters": [
- {
- "name": "testSuiteId",
- "required": true,
- "in": "path",
- "schema": {
- "type": "string"
- }
- },
{
"name": "id",
"required": true,
@@ -3540,19 +3669,19 @@
"schema": {
"oneOf": [
{
- "$ref": "#/components/schemas/TestSuiteTestVoice",
- "title": "Voice"
+ "$ref": "#/components/schemas/TrieveKnowledgeBase",
+ "title": "TrieveKnowledgeBase"
},
{
- "$ref": "#/components/schemas/TestSuiteTestChat",
- "title": "Chat"
+ "$ref": "#/components/schemas/CustomKnowledgeBase",
+ "title": "CustomKnowledgeBase"
}
],
"discriminator": {
- "propertyName": "type",
+ "propertyName": "provider",
"mapping": {
- "voice": "#/components/schemas/TestSuiteTestVoice",
- "chat": "#/components/schemas/TestSuiteTestChat"
+ "trieve": "#/components/schemas/TrieveKnowledgeBase",
+ "custom-knowledge-base": "#/components/schemas/CustomKnowledgeBase"
}
}
}
@@ -3561,7 +3690,7 @@
}
},
"tags": [
- "Test Suite Tests"
+ "Knowledge Base"
],
"security": [
{
@@ -3570,17 +3699,9 @@
]
},
"patch": {
- "operationId": "TestSuiteTestController_update",
- "summary": "Update Test",
+ "operationId": "KnowledgeBaseController_update",
+ "summary": "Update Knowledge Base",
"parameters": [
- {
- "name": "testSuiteId",
- "required": true,
- "in": "path",
- "schema": {
- "type": "string"
- }
- },
{
"name": "id",
"required": true,
@@ -3597,19 +3718,19 @@
"schema": {
"oneOf": [
{
- "$ref": "#/components/schemas/UpdateTestSuiteTestVoiceDto",
- "title": "TestSuiteTestVoice"
+ "$ref": "#/components/schemas/UpdateTrieveKnowledgeBaseDTO",
+ "title": "UpdateTrieveKnowledgeBaseDTO"
},
{
- "$ref": "#/components/schemas/UpdateTestSuiteTestChatDto",
- "title": "TestSuiteTestChat"
+ "$ref": "#/components/schemas/UpdateCustomKnowledgeBaseDTO",
+ "title": "UpdateCustomKnowledgeBaseDTO"
}
],
"discriminator": {
- "propertyName": "type",
+ "propertyName": "provider",
"mapping": {
- "voice": "#/components/schemas/UpdateTestSuiteTestVoiceDto",
- "chat": "#/components/schemas/UpdateTestSuiteTestChatDto"
+ "trieve": "#/components/schemas/UpdateTrieveKnowledgeBaseDTO",
+ "custom-knowledge-base": "#/components/schemas/UpdateCustomKnowledgeBaseDTO"
}
}
}
@@ -3624,19 +3745,19 @@
"schema": {
"oneOf": [
{
- "$ref": "#/components/schemas/TestSuiteTestVoice",
- "title": "Voice"
+ "$ref": "#/components/schemas/TrieveKnowledgeBase",
+ "title": "TrieveKnowledgeBase"
},
{
- "$ref": "#/components/schemas/TestSuiteTestChat",
- "title": "Chat"
+ "$ref": "#/components/schemas/CustomKnowledgeBase",
+ "title": "CustomKnowledgeBase"
}
],
"discriminator": {
- "propertyName": "type",
+ "propertyName": "provider",
"mapping": {
- "voice": "#/components/schemas/TestSuiteTestVoice",
- "chat": "#/components/schemas/TestSuiteTestChat"
+ "trieve": "#/components/schemas/TrieveKnowledgeBase",
+ "custom-knowledge-base": "#/components/schemas/CustomKnowledgeBase"
}
}
}
@@ -3645,7 +3766,7 @@
}
},
"tags": [
- "Test Suite Tests"
+ "Knowledge Base"
],
"security": [
{
@@ -3654,17 +3775,9 @@
]
},
"delete": {
- "operationId": "TestSuiteTestController_remove",
- "summary": "Delete Test",
+ "operationId": "KnowledgeBaseController_remove",
+ "summary": "Delete Knowledge Base",
"parameters": [
- {
- "name": "testSuiteId",
- "required": true,
- "in": "path",
- "schema": {
- "type": "string"
- }
- },
{
"name": "id",
"required": true,
@@ -3682,19 +3795,19 @@
"schema": {
"oneOf": [
{
- "$ref": "#/components/schemas/TestSuiteTestVoice",
- "title": "Voice"
+ "$ref": "#/components/schemas/TrieveKnowledgeBase",
+ "title": "TrieveKnowledgeBase"
},
{
- "$ref": "#/components/schemas/TestSuiteTestChat",
- "title": "Chat"
+ "$ref": "#/components/schemas/CustomKnowledgeBase",
+ "title": "CustomKnowledgeBase"
}
],
"discriminator": {
- "propertyName": "type",
+ "propertyName": "provider",
"mapping": {
- "voice": "#/components/schemas/TestSuiteTestVoice",
- "chat": "#/components/schemas/TestSuiteTestChat"
+ "trieve": "#/components/schemas/TrieveKnowledgeBase",
+ "custom-knowledge-base": "#/components/schemas/CustomKnowledgeBase"
}
}
}
@@ -3703,7 +3816,7 @@
}
},
"tags": [
- "Test Suite Tests"
+ "Knowledge Base"
],
"security": [
{
@@ -3712,42 +3825,272 @@
]
}
},
- "/test-suite/{testSuiteId}/run": {
+ "/workflow": {
"get": {
- "operationId": "TestSuiteRunController_findAllPaginated",
- "summary": "List Test Suite Runs",
+ "operationId": "WorkflowController_findAll",
+ "summary": "Get Workflows",
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Workflow"
+ }
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ "Workflow"
+ ],
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ },
+ "post": {
+ "operationId": "WorkflowController_create",
+ "summary": "Create Workflow",
+ "parameters": [],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateWorkflowDTO"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Workflow"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ "Workflow"
+ ],
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ }
+ },
+ "/workflow/{id}": {
+ "get": {
+ "operationId": "WorkflowController_findOne",
+ "summary": "Get Workflow",
"parameters": [
{
- "name": "testSuiteId",
+ "name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
- },
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Workflow"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ "Workflow"
+ ],
+ "security": [
{
- "name": "page",
- "required": false,
- "in": "query",
- "description": "This is the page number to return. Defaults to 1.",
+ "bearer": []
+ }
+ ]
+ },
+ "delete": {
+ "operationId": "WorkflowController_delete",
+ "summary": "Delete Workflow",
+ "parameters": [
+ {
+ "name": "id",
+ "required": true,
+ "in": "path",
"schema": {
- "minimum": 1,
- "type": "number"
+ "type": "string"
}
- },
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Workflow"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ "Workflow"
+ ],
+ "security": [
{
- "name": "sortOrder",
- "required": false,
- "in": "query",
- "description": "This is the sort order for pagination. Defaults to 'DESC'.",
+ "bearer": []
+ }
+ ]
+ },
+ "patch": {
+ "operationId": "WorkflowController_update",
+ "summary": "Update Workflow",
+ "parameters": [
+ {
+ "name": "id",
+ "required": true,
+ "in": "path",
"schema": {
- "enum": [
- "ASC",
- "DESC"
- ],
"type": "string"
}
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateWorkflowDTO"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Workflow"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ "Workflow"
+ ],
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ }
+ },
+ "/workflow/generate": {
+ "post": {
+ "operationId": "WorkflowController_generateFromTranscripts",
+ "summary": "Generate Workflow JSON from Transcript Files",
+ "parameters": [],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GenerateWorkflowDTO"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WorkflowUserEditable"
+ }
+ }
+ }
},
+ "201": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WorkflowUserEditable"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ "Workflow"
+ ],
+ "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,
@@ -3846,58 +4189,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TestSuiteRunsPaginatedResponse"
- }
- }
- }
- }
- },
- "tags": [
- "Test Suite Runs"
- ],
- "security": [
- {
- "bearer": []
- }
- ]
- },
- "post": {
- "operationId": "TestSuiteRunController_create",
- "summary": "Create Test Suite Run",
- "parameters": [
- {
- "name": "testSuiteId",
- "required": true,
- "in": "path",
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CreateTestSuiteRunDto"
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/TestSuiteRun"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Squad"
+ }
}
}
}
}
},
"tags": [
- "Test Suite Runs"
+ "Squads"
],
"security": [
{
@@ -3906,19 +4208,11 @@
]
}
},
- "/test-suite/{testSuiteId}/run/{id}": {
+ "/squad/{id}": {
"get": {
- "operationId": "TestSuiteRunController_findOne",
- "summary": "Get Test Suite Run",
+ "operationId": "SquadController_findOne",
+ "summary": "Get Squad",
"parameters": [
- {
- "name": "testSuiteId",
- "required": true,
- "in": "path",
- "schema": {
- "type": "string"
- }
- },
{
"name": "id",
"required": true,
@@ -3934,14 +4228,14 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TestSuiteRun"
+ "$ref": "#/components/schemas/Squad"
}
}
}
}
},
"tags": [
- "Test Suite Runs"
+ "Squads"
],
"security": [
{
@@ -3950,17 +4244,9 @@
]
},
"patch": {
- "operationId": "TestSuiteRunController_update",
- "summary": "Update Test Suite Run",
+ "operationId": "SquadController_update",
+ "summary": "Update Squad",
"parameters": [
- {
- "name": "testSuiteId",
- "required": true,
- "in": "path",
- "schema": {
- "type": "string"
- }
- },
{
"name": "id",
"required": true,
@@ -3975,7 +4261,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UpdateTestSuiteRunDto"
+ "$ref": "#/components/schemas/UpdateSquadDTO"
}
}
}
@@ -3986,14 +4272,14 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TestSuiteRun"
+ "$ref": "#/components/schemas/Squad"
}
}
}
}
},
"tags": [
- "Test Suite Runs"
+ "Squads"
],
"security": [
{
@@ -4002,17 +4288,9 @@
]
},
"delete": {
- "operationId": "TestSuiteRunController_remove",
- "summary": "Delete Test Suite Run",
+ "operationId": "SquadController_remove",
+ "summary": "Delete Squad",
"parameters": [
- {
- "name": "testSuiteId",
- "required": true,
- "in": "path",
- "schema": {
- "type": "string"
- }
- },
{
"name": "id",
"required": true,
@@ -4028,57 +4306,14 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/TestSuiteRun"
- }
- }
- }
- }
- },
- "tags": [
- "Test Suite Runs"
- ],
- "security": [
- {
- "bearer": []
- }
- ]
- }
- },
- "/analytics": {
- "post": {
- "operationId": "AnalyticsController_query",
- "summary": "Create Analytics Queries",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AnalyticsQueryDTO"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AnalyticsQueryResult"
- }
+ "$ref": "#/components/schemas/Squad"
}
}
}
- },
- "201": {
- "description": ""
}
},
"tags": [
- "Analytics"
+ "Squads"
],
"security": [
{
@@ -4087,81 +4322,11 @@
]
}
},
- "/logs": {
+ "/test-suite": {
"get": {
- "operationId": "LoggingController_logsQuery",
- "summary": "Get Logs",
- "deprecated": true,
+ "operationId": "TestSuiteController_findAllPaginated",
+ "summary": "List Test Suites",
"parameters": [
- {
- "name": "type",
- "required": false,
- "in": "query",
- "description": "This is the type of the log.",
- "schema": {
- "enum": [
- "API",
- "Webhook",
- "Call",
- "Provider"
- ],
- "type": "string"
- }
- },
- {
- "name": "webhookType",
- "required": false,
- "in": "query",
- "description": "This is the type of the webhook, given the log is from a webhook.",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "assistantId",
- "required": false,
- "in": "query",
- "description": "This is the ID of the assistant.",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "phoneNumberId",
- "required": false,
- "in": "query",
- "description": "This is the ID of the phone number.",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "customerId",
- "required": false,
- "in": "query",
- "description": "This is the ID of the customer.",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "squadId",
- "required": false,
- "in": "query",
- "description": "This is the ID of the squad.",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "callId",
- "required": false,
- "in": "query",
- "description": "This is the ID of the call.",
- "schema": {
- "type": "string"
- }
- },
{
"name": "page",
"required": false,
@@ -4283,14 +4448,14 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/LogsPaginatedResponse"
+ "$ref": "#/components/schemas/TestSuitesPaginatedResponse"
}
}
}
}
},
"tags": [
- "Logs"
+ "Test Suites"
],
"security": [
{
@@ -4298,1754 +4463,1700 @@
}
]
},
- "delete": {
- "operationId": "LoggingController_logsDeleteQuery",
- "summary": "Delete Logs",
- "deprecated": true,
- "parameters": [
- {
- "name": "type",
- "required": false,
- "in": "query",
- "description": "This is the type of the log.",
+ "post": {
+ "operationId": "TestSuiteController_create",
+ "summary": "Create Test Suite",
+ "parameters": [],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateTestSuiteDto"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TestSuite"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ "Test Suites"
+ ],
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ }
+ },
+ "/test-suite/{id}": {
+ "get": {
+ "operationId": "TestSuiteController_findOne",
+ "summary": "Get Test Suite",
+ "parameters": [
+ {
+ "name": "id",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TestSuite"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ "Test Suites"
+ ],
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ },
+ "patch": {
+ "operationId": "TestSuiteController_update",
+ "summary": "Update Test Suite",
+ "parameters": [
+ {
+ "name": "id",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateTestSuiteDto"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TestSuite"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ "Test Suites"
+ ],
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ },
+ "delete": {
+ "operationId": "TestSuiteController_remove",
+ "summary": "Delete Test Suite",
+ "parameters": [
+ {
+ "name": "id",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TestSuite"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ "Test Suites"
+ ],
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ }
+ },
+ "/test-suite/{testSuiteId}/test": {
+ "get": {
+ "operationId": "TestSuiteTestController_findAllPaginated",
+ "summary": "List Tests",
+ "parameters": [
+ {
+ "name": "testSuiteId",
+ "required": true,
+ "in": "path",
+ "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"
+ }
+ },
+ {
+ "name": "sortOrder",
+ "required": false,
+ "in": "query",
+ "description": "This is the sort order for pagination. Defaults to 'DESC'.",
"schema": {
"enum": [
- "API",
- "Webhook",
- "Call",
- "Provider"
+ "ASC",
+ "DESC"
],
"type": "string"
}
},
{
- "name": "assistantId",
+ "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": "phoneNumberId",
+ "name": "createdAtLt",
"required": false,
"in": "query",
- "description": "This is the ID of the phone number.",
+ "description": "This will return items where the createdAt is less than the specified value.",
"schema": {
+ "format": "date-time",
"type": "string"
}
},
{
- "name": "customerId",
+ "name": "createdAtGe",
"required": false,
"in": "query",
- "description": "This is the ID of the customer.",
+ "description": "This will return items where the createdAt is greater than or equal to the specified value.",
"schema": {
+ "format": "date-time",
"type": "string"
}
},
{
- "name": "squadId",
+ "name": "createdAtLe",
"required": false,
"in": "query",
- "description": "This is the ID of the squad.",
+ "description": "This will return items where the createdAt is less than or equal to the specified value.",
"schema": {
+ "format": "date-time",
"type": "string"
}
},
{
- "name": "callId",
+ "name": "updatedAtGt",
"required": false,
"in": "query",
- "description": "This is the ID of the call.",
+ "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": ""
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TestSuiteTestsPaginatedResponse"
+ }
+ }
+ }
}
},
"tags": [
- "Logs"
+ "Test Suite Tests"
+ ],
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ },
+ "post": {
+ "operationId": "TestSuiteTestController_create",
+ "summary": "Create Test",
+ "parameters": [
+ {
+ "name": "testSuiteId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateTestSuiteTestVoiceDto",
+ "title": "TestSuiteTestVoice"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTestSuiteTestChatDto",
+ "title": "TestSuiteTestChat"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "voice": "#/components/schemas/CreateTestSuiteTestVoiceDto",
+ "chat": "#/components/schemas/CreateTestSuiteTestChatDto"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TestSuiteTestVoice",
+ "title": "Voice"
+ },
+ {
+ "$ref": "#/components/schemas/TestSuiteTestChat",
+ "title": "Chat"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "voice": "#/components/schemas/TestSuiteTestVoice",
+ "chat": "#/components/schemas/TestSuiteTestChat"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ "Test Suite Tests"
],
"security": [
{
"bearer": []
}
]
- }
- }
- },
- "info": {
- "title": "Vapi API",
- "description": "Voice AI for developers.",
- "version": "1.0",
- "contact": {}
- },
- "tags": [],
- "servers": [
- {
- "url": "https://api.vapi.ai"
- }
- ],
- "components": {
- "securitySchemes": {
- "bearer": {
- "scheme": "bearer",
- "bearerFormat": "Bearer",
- "type": "http",
- "description": "Retrieve your API Key from [Dashboard](dashboard.vapi.ai)."
}
},
- "schemas": {
- "AnalysisCostBreakdown": {
- "type": "object",
- "properties": {
- "summary": {
- "type": "number",
- "description": "This is the cost to summarize the call."
- },
- "summaryPromptTokens": {
- "type": "number",
- "description": "This is the number of prompt tokens used to summarize the call."
- },
- "summaryCompletionTokens": {
- "type": "number",
- "description": "This is the number of completion tokens used to summarize the call."
- },
- "structuredData": {
- "type": "number",
- "description": "This is the cost to extract structured data from the call."
- },
- "structuredDataPromptTokens": {
- "type": "number",
- "description": "This is the number of prompt tokens used to extract structured data from the call."
- },
- "structuredDataCompletionTokens": {
- "type": "number",
- "description": "This is the number of completion tokens used to extract structured data from the call."
- },
- "successEvaluation": {
- "type": "number",
- "description": "This is the cost to evaluate if the call was successful."
- },
- "successEvaluationPromptTokens": {
- "type": "number",
- "description": "This is the number of prompt tokens used to evaluate if the call was successful."
+ "/test-suite/{testSuiteId}/test/{id}": {
+ "get": {
+ "operationId": "TestSuiteTestController_findOne",
+ "summary": "Get Test",
+ "parameters": [
+ {
+ "name": "testSuiteId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
},
- "successEvaluationCompletionTokens": {
- "type": "number",
- "description": "This is the number of completion tokens used to evaluate if the call was successful."
+ {
+ "name": "id",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
}
- }
- },
- "CostBreakdown": {
- "type": "object",
- "properties": {
- "transport": {
- "type": "number",
- "description": "This is the cost of the transport provider, like Twilio or Vonage."
- },
- "stt": {
- "type": "number",
- "description": "This is the cost of the speech-to-text service."
- },
- "llm": {
- "type": "number",
- "description": "This is the cost of the language model."
- },
- "tts": {
- "type": "number",
- "description": "This is the cost of the text-to-speech service."
- },
- "vapi": {
- "type": "number",
- "description": "This is the cost of Vapi."
- },
- "total": {
- "type": "number",
- "description": "This is the total cost of the call."
- },
- "llmPromptTokens": {
- "type": "number",
- "description": "This is the LLM prompt tokens used for the call."
- },
- "llmCompletionTokens": {
- "type": "number",
- "description": "This is the LLM completion tokens used for the call."
- },
- "ttsCharacters": {
- "type": "number",
- "description": "This is the TTS characters used for the call."
- },
- "analysisCostBreakdown": {
- "description": "This is the cost of the analysis.",
- "allOf": [
- {
- "$ref": "#/components/schemas/AnalysisCostBreakdown"
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TestSuiteTestVoice",
+ "title": "Voice"
+ },
+ {
+ "$ref": "#/components/schemas/TestSuiteTestChat",
+ "title": "Chat"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "voice": "#/components/schemas/TestSuiteTestVoice",
+ "chat": "#/components/schemas/TestSuiteTestChat"
+ }
+ }
+ }
}
- ]
+ }
}
- }
- },
- "TranscriptPlan": {
- "type": "object",
- "properties": {
- "enabled": {
- "type": "boolean",
- "description": "This determines whether the transcript is stored in `call.artifact.transcript`. Defaults to true.\n\n@default true",
- "example": true
- },
- "assistantName": {
- "type": "string",
- "description": "This is the name of the assistant in the transcript. Defaults to 'AI'.\n\nUsage:\n- If you want to change the name of the assistant in the transcript, set this. Example, here is what the transcript would look like with `assistantName` set to 'Buyer':\n```\nUser: Hello, how are you?\nBuyer: I'm fine.\nUser: Do you want to buy a car?\nBuyer: No.\n```\n\n@default 'AI'"
- },
- "userName": {
- "type": "string",
- "description": "This is the name of the user in the transcript. Defaults to 'User'.\n\nUsage:\n- If you want to change the name of the user in the transcript, set this. Example, here is what the transcript would look like with `userName` set to 'Seller':\n```\nSeller: Hello, how are you?\nAI: I'm fine.\nSeller: Do you want to buy a car?\nAI: No.\n```\n\n@default 'User'"
+ },
+ "tags": [
+ "Test Suite Tests"
+ ],
+ "security": [
+ {
+ "bearer": []
}
- }
+ ]
},
- "ArtifactPlan": {
- "type": "object",
- "properties": {
- "recordingEnabled": {
- "type": "boolean",
- "description": "This determines whether assistant's calls are recorded. Defaults to true.\n\nUsage:\n- If you don't want to record the calls, set this to false.\n- If you want to record the calls when `assistant.hipaaEnabled` (deprecated) or `assistant.compliancePlan.hipaaEnabled` explicity set this to true and make sure to provide S3 or GCP credentials on the Provider Credentials page in the Dashboard.\n\nYou can find the recording at `call.artifact.recordingUrl` and `call.artifact.stereoRecordingUrl` after the call is ended.\n\n@default true",
- "example": true
- },
- "recordingFormat": {
- "type": "string",
- "description": "This determines the format of the recording. Defaults to `wav;l16`.\n\n@default 'wav;l16'",
- "enum": [
- "wav;l16",
- "mp3"
- ]
- },
- "videoRecordingEnabled": {
- "type": "boolean",
- "description": "This determines whether the video is recorded during the call. Defaults to false. Only relevant for `webCall` type.\n\nYou can find the video recording at `call.artifact.videoRecordingUrl` after the call is ended.\n\n@default false",
- "example": false
- },
- "pcapEnabled": {
- "type": "boolean",
- "description": "This determines whether the SIP packet capture is enabled. Defaults to true. Only relevant for `phone` type calls where phone number's provider is `vapi` or `byo-phone-number`.\n\nYou can find the packet capture at `call.artifact.pcapUrl` after the call is ended.\n\n@default true",
- "example": true
- },
- "pcapS3PathPrefix": {
- "type": "string",
- "description": "This is the path where the SIP packet capture will be uploaded. This is only used if you have provided S3 or GCP credentials on the Provider Credentials page in the Dashboard.\n\nIf credential.s3PathPrefix or credential.bucketPlan.path is set, this will append to it.\n\nUsage:\n- If you want to upload the packet capture to a specific path, set this to the path. Example: `/my-assistant-captures`.\n- If you want to upload the packet capture to the root of the bucket, set this to `/`.\n\n@default '/'",
- "example": "/pcaps"
+ "patch": {
+ "operationId": "TestSuiteTestController_update",
+ "summary": "Update Test",
+ "parameters": [
+ {
+ "name": "testSuiteId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
},
- "transcriptPlan": {
- "description": "This is the plan for `call.artifact.transcript`. To disable, set `transcriptPlan.enabled` to false.",
- "allOf": [
- {
- "$ref": "#/components/schemas/TranscriptPlan"
+ {
+ "name": "id",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/UpdateTestSuiteTestVoiceDto",
+ "title": "TestSuiteTestVoice"
+ },
+ {
+ "$ref": "#/components/schemas/UpdateTestSuiteTestChatDto",
+ "title": "TestSuiteTestChat"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "voice": "#/components/schemas/UpdateTestSuiteTestVoiceDto",
+ "chat": "#/components/schemas/UpdateTestSuiteTestChatDto"
+ }
+ }
}
- ]
- },
- "recordingPath": {
- "type": "string",
- "description": "This is the path where the recording will be uploaded. This is only used if you have provided S3 or GCP credentials on the Provider Credentials page in the Dashboard.\n\nIf credential.s3PathPrefix or credential.bucketPlan.path is set, this will append to it.\n\nUsage:\n- If you want to upload the recording to a specific path, set this to the path. Example: `/my-assistant-recordings`.\n- If you want to upload the recording to the root of the bucket, set this to `/`.\n\n@default '/'"
+ }
}
- }
- },
- "Analysis": {
- "type": "object",
- "properties": {
- "summary": {
- "type": "string",
- "description": "This is the summary of the call. Customize by setting `assistant.analysisPlan.summaryPrompt`."
- },
- "structuredData": {
- "type": "object",
- "description": "This is the structured data extracted from the call. Customize by setting `assistant.analysisPlan.structuredDataPrompt` and/or `assistant.analysisPlan.structuredDataSchema`."
- },
- "structuredDataMulti": {
- "description": "This is the structured data catalog of the call. Customize by setting `assistant.analysisPlan.structuredDataMultiPlan`.",
- "type": "array",
- "items": {
- "type": "object"
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TestSuiteTestVoice",
+ "title": "Voice"
+ },
+ {
+ "$ref": "#/components/schemas/TestSuiteTestChat",
+ "title": "Chat"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "voice": "#/components/schemas/TestSuiteTestVoice",
+ "chat": "#/components/schemas/TestSuiteTestChat"
+ }
+ }
+ }
+ }
}
- },
- "successEvaluation": {
- "type": "string",
- "description": "This is the evaluation of the call. Customize by setting `assistant.analysisPlan.successEvaluationPrompt` and/or `assistant.analysisPlan.successEvaluationRubric`."
}
- }
- },
- "Monitor": {
- "type": "object",
- "properties": {
- "listenUrl": {
- "type": "string",
- "description": "This is the URL where the assistant's calls can be listened to in real-time. To enable, set `assistant.monitorPlan.listenEnabled` to `true`."
- },
- "controlUrl": {
- "type": "string",
- "description": "This is the URL where the assistant's calls can be controlled in real-time. To enable, set `assistant.monitorPlan.controlEnabled` to `true`."
+ },
+ "tags": [
+ "Test Suite Tests"
+ ],
+ "security": [
+ {
+ "bearer": []
}
- }
+ ]
},
- "OpenAIMessage": {
- "type": "object",
- "properties": {
- "content": {
- "type": "string",
- "nullable": true,
- "maxLength": 100000000
+ "delete": {
+ "operationId": "TestSuiteTestController_remove",
+ "summary": "Delete Test",
+ "parameters": [
+ {
+ "name": "testSuiteId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
},
- "role": {
- "type": "string",
- "enum": [
- "assistant",
- "function",
- "user",
- "system",
- "tool"
- ]
+ {
+ "name": "id",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TestSuiteTestVoice",
+ "title": "Voice"
+ },
+ {
+ "$ref": "#/components/schemas/TestSuiteTestChat",
+ "title": "Chat"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "voice": "#/components/schemas/TestSuiteTestVoice",
+ "chat": "#/components/schemas/TestSuiteTestChat"
+ }
+ }
+ }
+ }
+ }
}
},
- "required": [
- "content",
- "role"
+ "tags": [
+ "Test Suite Tests"
+ ],
+ "security": [
+ {
+ "bearer": []
+ }
]
- },
- "Artifact": {
- "type": "object",
- "properties": {
- "messages": {
- "type": "array",
- "description": "These are the messages that were spoken during the call.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/UserMessage",
- "title": "UserMessage"
- },
- {
- "$ref": "#/components/schemas/SystemMessage",
- "title": "SystemMessage"
- },
- {
- "$ref": "#/components/schemas/BotMessage",
- "title": "BotMessage"
- },
- {
- "$ref": "#/components/schemas/ToolCallMessage",
- "title": "ToolCallMessage"
- },
- {
- "$ref": "#/components/schemas/ToolCallResultMessage",
- "title": "ToolCallResultMessage"
- }
- ]
+ }
+ },
+ "/test-suite/{testSuiteId}/run": {
+ "get": {
+ "operationId": "TestSuiteRunController_findAllPaginated",
+ "summary": "List Test Suite Runs",
+ "parameters": [
+ {
+ "name": "testSuiteId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "string"
}
},
- "messagesOpenAIFormatted": {
- "description": "These are the messages that were spoken during the call, formatted for OpenAI.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/OpenAIMessage"
+ {
+ "name": "page",
+ "required": false,
+ "in": "query",
+ "description": "This is the page number to return. Defaults to 1.",
+ "schema": {
+ "minimum": 1,
+ "type": "number"
}
},
- "recordingUrl": {
- "type": "string",
- "description": "This is the recording url for the call. To enable, set `assistant.artifactPlan.recordingEnabled`."
- },
- "stereoRecordingUrl": {
- "type": "string",
- "description": "This is the stereo recording url for the call. To enable, set `assistant.artifactPlan.recordingEnabled`."
- },
- "videoRecordingUrl": {
- "type": "string",
- "description": "This is video recording url for the call. To enable, set `assistant.artifactPlan.videoRecordingEnabled`."
- },
- "videoRecordingStartDelaySeconds": {
- "type": "number",
- "description": "This is video recording start delay in ms. To enable, set `assistant.artifactPlan.videoRecordingEnabled`. This can be used to align the playback of the recording with artifact.messages timestamps."
+ {
+ "name": "sortOrder",
+ "required": false,
+ "in": "query",
+ "description": "This is the sort order for pagination. Defaults to 'DESC'.",
+ "schema": {
+ "enum": [
+ "ASC",
+ "DESC"
+ ],
+ "type": "string"
+ }
},
- "transcript": {
- "type": "string",
- "description": "This is the transcript of the call. This is derived from `artifact.messages` but provided for convenience."
+ {
+ "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"
+ }
},
- "pcapUrl": {
- "type": "string",
- "description": "This is the packet capture url for the call. This is only available for `phone` type calls where phone number's provider is `vapi` or `byo-phone-number`."
- }
- }
- },
- "FallbackTranscriberPlan": {
- "type": "object",
- "properties": {
- "transcribers": {
- "type": "array",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/FallbackAssemblyAITranscriber",
- "title": "AssemblyAI"
- },
- {
- "$ref": "#/components/schemas/FallbackAzureSpeechTranscriber",
- "title": "Azure"
- },
- {
- "$ref": "#/components/schemas/FallbackCustomTranscriber",
- "title": "Custom"
- },
- {
- "$ref": "#/components/schemas/FallbackDeepgramTranscriber",
- "title": "Deepgram"
- },
- {
- "$ref": "#/components/schemas/FallbackElevenLabsTranscriber",
- "title": "ElevenLabs"
- },
- {
- "$ref": "#/components/schemas/FallbackGladiaTranscriber",
- "title": "Gladia"
- },
- {
- "$ref": "#/components/schemas/FallbackGoogleTranscriber",
- "title": "Google"
- },
- {
- "$ref": "#/components/schemas/FallbackTalkscriberTranscriber",
- "title": "Talkscriber"
- },
- {
- "$ref": "#/components/schemas/FallbackSpeechmaticsTranscriber",
- "title": "Speechmatics"
- },
- {
- "$ref": "#/components/schemas/FallbackOpenAITranscriber",
- "title": "OpenAI"
- }
- ]
+ {
+ "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"
}
- }
- },
- "required": [
- "transcribers"
- ]
- },
- "AssemblyAITranscriber": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "description": "This is the transcription provider that will be used.",
- "enum": [
- "assembly-ai"
- ]
},
- "language": {
- "type": "string",
- "description": "This is the language that will be set for the transcription.",
- "enum": [
- "en"
- ]
+ {
+ "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"
+ }
},
- "confidenceThreshold": {
- "type": "number",
- "description": "Transcripts below this confidence threshold will be discarded.\n\n@default 0.4",
- "minimum": 0,
- "maximum": 1,
- "example": 0.4
+ {
+ "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"
+ }
},
- "realtimeUrl": {
- "type": "string",
- "description": "The WebSocket URL that the transcriber connects to."
+ {
+ "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"
+ }
},
- "wordBoost": {
- "description": "Add up to 2500 characters of custom vocabulary.",
- "type": "array",
- "items": {
- "type": "string",
- "maxLength": 2500
+ {
+ "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"
}
},
- "endUtteranceSilenceThreshold": {
- "type": "number",
- "description": "The duration of the end utterance silence threshold in milliseconds."
+ {
+ "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"
+ }
},
- "disablePartialTranscripts": {
- "type": "boolean",
- "description": "Disable partial transcripts.\nSet to `true` to not receive partial transcripts. Defaults to `false`."
+ {
+ "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"
+ }
},
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
- "allOf": [
- {
- "$ref": "#/components/schemas/FallbackTranscriberPlan"
+ {
+ "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": {
+ "$ref": "#/components/schemas/TestSuiteRunsPaginatedResponse"
+ }
}
- ]
+ }
}
},
- "required": [
- "provider"
+ "tags": [
+ "Test Suite Runs"
+ ],
+ "security": [
+ {
+ "bearer": []
+ }
]
},
- "AzureSpeechTranscriber": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "description": "This is the transcription provider that will be used.",
- "enum": [
- "azure"
- ]
- },
- "language": {
- "type": "string",
- "description": "This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt",
- "enum": [
- "af-ZA",
- "am-ET",
- "ar-AE",
- "ar-BH",
- "ar-DZ",
- "ar-EG",
- "ar-IL",
- "ar-IQ",
- "ar-JO",
- "ar-KW",
- "ar-LB",
- "ar-LY",
- "ar-MA",
- "ar-OM",
- "ar-PS",
- "ar-QA",
- "ar-SA",
- "ar-SY",
- "ar-TN",
- "ar-YE",
- "az-AZ",
- "bg-BG",
- "bn-IN",
- "bs-BA",
- "ca-ES",
- "cs-CZ",
- "cy-GB",
- "da-DK",
- "de-AT",
- "de-CH",
- "de-DE",
- "el-GR",
- "en-AU",
- "en-CA",
- "en-GB",
- "en-GH",
- "en-HK",
- "en-IE",
- "en-IN",
- "en-KE",
- "en-NG",
- "en-NZ",
- "en-PH",
- "en-SG",
- "en-TZ",
- "en-US",
- "en-ZA",
- "es-AR",
- "es-BO",
- "es-CL",
- "es-CO",
- "es-CR",
- "es-CU",
- "es-DO",
- "es-EC",
- "es-ES",
- "es-GQ",
- "es-GT",
- "es-HN",
- "es-MX",
- "es-NI",
- "es-PA",
- "es-PE",
- "es-PR",
- "es-PY",
- "es-SV",
- "es-US",
- "es-UY",
- "es-VE",
- "et-EE",
- "eu-ES",
- "fa-IR",
- "fi-FI",
- "fil-PH",
- "fr-BE",
- "fr-CA",
- "fr-CH",
- "fr-FR",
- "ga-IE",
- "gl-ES",
- "gu-IN",
- "he-IL",
- "hi-IN",
- "hr-HR",
- "hu-HU",
- "hy-AM",
- "id-ID",
- "is-IS",
- "it-CH",
- "it-IT",
- "ja-JP",
- "jv-ID",
- "ka-GE",
- "kk-KZ",
- "km-KH",
- "kn-IN",
- "ko-KR",
- "lo-LA",
- "lt-LT",
- "lv-LV",
- "mk-MK",
- "ml-IN",
- "mn-MN",
- "mr-IN",
- "ms-MY",
- "mt-MT",
- "my-MM",
- "nb-NO",
- "ne-NP",
- "nl-BE",
- "nl-NL",
- "pa-IN",
- "pl-PL",
- "ps-AF",
- "pt-BR",
- "pt-PT",
- "ro-RO",
- "ru-RU",
- "si-LK",
- "sk-SK",
- "sl-SI",
- "so-SO",
- "sq-AL",
- "sr-RS",
- "sv-SE",
- "sw-KE",
- "sw-TZ",
- "ta-IN",
- "te-IN",
- "th-TH",
- "tr-TR",
- "uk-UA",
- "ur-IN",
- "uz-UZ",
- "vi-VN",
- "wuu-CN",
- "yue-CN",
- "zh-CN",
- "zh-CN-shandong",
- "zh-CN-sichuan",
- "zh-HK",
- "zh-TW",
- "zu-ZA"
- ]
- },
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
- "allOf": [
- {
- "$ref": "#/components/schemas/FallbackTranscriberPlan"
+ "post": {
+ "operationId": "TestSuiteRunController_create",
+ "summary": "Create Test Suite Run",
+ "parameters": [
+ {
+ "name": "testSuiteId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateTestSuiteRunDto"
}
- ]
+ }
}
},
- "required": [
- "provider"
- ]
- },
- "BackoffPlan": {
- "type": "object",
- "properties": {
- "maxRetries": {
- "type": "number",
- "description": "This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0",
- "minimum": 0,
- "maximum": 10,
- "example": 0
- },
- "type": {
- "type": "object",
- "description": "This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed",
- "enum": [
- "fixed",
- "exponential"
- ],
- "example": "fixed"
- },
- "baseDelaySeconds": {
- "type": "number",
- "description": "This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.",
- "minimum": 0,
- "maximum": 10,
- "example": 1
+ "responses": {
+ "201": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TestSuiteRun"
+ }
+ }
+ }
}
},
- "required": [
- "maxRetries",
- "type",
- "baseDelaySeconds"
+ "tags": [
+ "Test Suite Runs"
+ ],
+ "security": [
+ {
+ "bearer": []
+ }
]
- },
- "Server": {
- "type": "object",
- "properties": {
- "timeoutSeconds": {
- "type": "number",
- "description": "This is the timeout in seconds for the request to your server. Defaults to 20 seconds.\n\n@default 20",
- "minimum": 1,
- "maximum": 120,
- "example": 20
- },
- "url": {
- "type": "string",
- "description": "API endpoint to send requests to."
- },
- "secret": {
- "type": "string",
- "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."
- },
- "headers": {
- "type": "object",
- "description": "These are the custom headers to include in the request sent to your server.\n\nEach key-value pair represents a header name and its value."
+ }
+ },
+ "/test-suite/{testSuiteId}/run/{id}": {
+ "get": {
+ "operationId": "TestSuiteRunController_findOne",
+ "summary": "Get Test Suite Run",
+ "parameters": [
+ {
+ "name": "testSuiteId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
},
- "backoffPlan": {
- "description": "This is the backoff plan to use if the request fails.",
- "allOf": [
- {
- "$ref": "#/components/schemas/BackoffPlan"
+ {
+ "name": "id",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TestSuiteRun"
+ }
}
- ]
+ }
}
},
- "required": [
- "url"
+ "tags": [
+ "Test Suite Runs"
+ ],
+ "security": [
+ {
+ "bearer": []
+ }
]
},
- "CustomTranscriber": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "description": "This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported.",
- "enum": [
- "custom-transcriber"
- ]
+ "patch": {
+ "operationId": "TestSuiteRunController_update",
+ "summary": "Update Test Suite Run",
+ "parameters": [
+ {
+ "name": "testSuiteId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
},
- "server": {
- "description": "This is where the transcription request will be sent.\n\nUsage:\n1. Vapi will initiate a websocket connection with `server.url`.\n\n2. Vapi will send an initial text frame with the sample rate. Format:\n```\n {\n \"type\": \"start\",\n \"encoding\": \"linear16\", // 16-bit raw PCM format\n \"container\": \"raw\",\n \"sampleRate\": {{sampleRate}},\n \"channels\": 2 // customer is channel 0, assistant is channel 1\n }\n```\n\n3. Vapi will send the audio data in 16-bit raw PCM format as binary frames.\n\n4. You can read the messages something like this:\n```\nws.on('message', (data, isBinary) => {\n if (isBinary) {\n pcmBuffer = Buffer.concat([pcmBuffer, data]);\n console.log(`Received PCM data, buffer size: ${pcmBuffer.length}`);\n } else {\n console.log('Received message:', JSON.parse(data.toString()));\n }\n});\n```\n\n5. You will respond with transcriptions as you have them. Format:\n```\n {\n \"type\": \"transcriber-response\",\n \"transcription\": \"Hello, world!\",\n \"channel\": \"customer\" | \"assistant\"\n }\n```",
- "allOf": [
- {
- "$ref": "#/components/schemas/Server"
+ {
+ "name": "id",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpdateTestSuiteRunDto"
}
- ]
- },
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
- "allOf": [
- {
- "$ref": "#/components/schemas/FallbackTranscriberPlan"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TestSuiteRun"
+ }
}
- ]
+ }
}
},
- "required": [
- "provider",
- "server"
+ "tags": [
+ "Test Suite Runs"
+ ],
+ "security": [
+ {
+ "bearer": []
+ }
]
},
- "DeepgramTranscriber": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "description": "This is the transcription provider that will be used.",
- "enum": [
- "deepgram"
- ]
+ "delete": {
+ "operationId": "TestSuiteRunController_remove",
+ "summary": "Delete Test Suite Run",
+ "parameters": [
+ {
+ "name": "testSuiteId",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
},
- "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",
- "oneOf": [
- {
- "type": "string",
- "enum": [
- "nova-3",
- "nova-3-general",
- "nova-3-medical",
- "nova-2",
- "nova-2-general",
- "nova-2-meeting",
- "nova-2-phonecall",
- "nova-2-finance",
- "nova-2-conversationalai",
- "nova-2-voicemail",
- "nova-2-video",
- "nova-2-medical",
- "nova-2-drivethru",
- "nova-2-automotive",
- "nova",
- "nova-general",
- "nova-phonecall",
- "nova-medical",
- "enhanced",
- "enhanced-general",
- "enhanced-meeting",
- "enhanced-phonecall",
- "enhanced-finance",
- "base",
- "base-general",
- "base-meeting",
- "base-phonecall",
- "base-finance",
- "base-conversationalai",
- "base-voicemail",
- "base-video"
- ]
- },
- {
- "type": "string"
+ {
+ "name": "id",
+ "required": true,
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TestSuiteRun"
+ }
}
- ]
+ }
+ }
+ },
+ "tags": [
+ "Test Suite Runs"
+ ],
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ }
+ },
+ "/analytics": {
+ "post": {
+ "operationId": "AnalyticsController_query",
+ "summary": "Create Analytics Queries",
+ "parameters": [],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AnalyticsQueryDTO"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AnalyticsQueryResult"
+ }
+ }
+ }
+ }
},
- "language": {
- "type": "string",
- "description": "This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview",
- "enum": [
- "bg",
- "ca",
- "cs",
- "da",
- "da-DK",
- "de",
- "de-CH",
- "el",
- "en",
- "en-AU",
- "en-GB",
- "en-IN",
- "en-NZ",
- "en-US",
- "es",
- "es-419",
- "es-LATAM",
- "et",
- "fi",
- "fr",
- "fr-CA",
- "hi",
- "hi-Latn",
- "hu",
- "id",
- "it",
- "ja",
- "ko",
- "ko-KR",
- "lt",
- "lv",
- "ms",
- "multi",
- "nl",
- "nl-BE",
- "no",
- "pl",
- "pt",
- "pt-BR",
- "ro",
- "ru",
- "sk",
- "sv",
- "sv-SE",
- "ta",
- "taq",
- "th",
- "th-TH",
- "tr",
- "uk",
- "vi",
- "zh",
- "zh-CN",
- "zh-HK",
- "zh-Hans",
- "zh-Hant",
- "zh-TW"
- ]
+ "201": {
+ "description": ""
+ }
+ },
+ "tags": [
+ "Analytics"
+ ],
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ }
+ },
+ "/logs": {
+ "get": {
+ "operationId": "LoggingController_logsQuery",
+ "summary": "Get Logs",
+ "deprecated": true,
+ "parameters": [
+ {
+ "name": "type",
+ "required": false,
+ "in": "query",
+ "description": "This is the type of the log.",
+ "schema": {
+ "enum": [
+ "API",
+ "Webhook",
+ "Call",
+ "Provider"
+ ],
+ "type": "string"
+ }
},
- "smartFormat": {
- "type": "boolean",
- "description": "This will be use smart format option provided by Deepgram. It's default disabled because it can sometimes format numbers as times but it's getting better.",
- "example": false
+ {
+ "name": "webhookType",
+ "required": false,
+ "in": "query",
+ "description": "This is the type of the webhook, given the log is from a webhook.",
+ "schema": {
+ "type": "string"
+ }
},
- "codeSwitchingEnabled": {
- "type": "boolean",
- "description": "This automatically switches the transcriber's language when the customer's language changes. Defaults to false.\n\nUsage:\n- If your customers switch languages mid-call, you can set this to true.\n\nNote:\n- To detect language changes, Vapi uses a custom trained model. Languages supported (X = limited support):\n 1. Arabic\n 2. Bengali\n 3. Cantonese\n 4. Chinese\n 5. Chinese Simplified (X)\n 6. Chinese Traditional (X)\n 7. English\n 8. Farsi (X)\n 9. French\n 10. German\n 11. Haitian Creole (X)\n 12. Hindi\n 13. Italian\n 14. Japanese\n 15. Korean\n 16. Portuguese\n 17. Russian\n 18. Spanish\n 19. Thai\n 20. Urdu\n 21. Vietnamese\n- To receive `language-change-detected` webhook events, add it to `assistant.serverMessages`.\n\n@default false",
- "example": false
+ {
+ "name": "assistantId",
+ "required": false,
+ "in": "query",
+ "description": "This is the ID of the assistant.",
+ "schema": {
+ "type": "string"
+ }
},
- "mipOptOut": {
- "type": "boolean",
- "description": "If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false",
- "example": false,
- "default": false
+ {
+ "name": "phoneNumberId",
+ "required": false,
+ "in": "query",
+ "description": "This is the ID of the phone number.",
+ "schema": {
+ "type": "string"
+ }
},
- "numerals": {
- "type": "boolean",
- "description": "If set to true, this will cause deepgram to convert spoken numbers to literal numerals. For example, \"my phone number is nine-seven-two...\" would become \"my phone number is 972...\"\n\n@default false",
- "example": false
+ {
+ "name": "customerId",
+ "required": false,
+ "in": "query",
+ "description": "This is the ID of the customer.",
+ "schema": {
+ "type": "string"
+ }
},
- "confidenceThreshold": {
- "type": "number",
- "description": "Transcripts below this confidence threshold will be discarded.\n\n@default 0.4",
- "minimum": 0,
- "maximum": 1,
- "example": 0.4
+ {
+ "name": "squadId",
+ "required": false,
+ "in": "query",
+ "description": "This is the ID of the squad.",
+ "schema": {
+ "type": "string"
+ }
},
- "keywords": {
- "description": "These keywords are passed to the transcription model to help it pick up use-case specific words. Anything that may not be a common word, like your company name, should be added here.",
- "type": "array",
- "items": {
- "type": "string",
- "pattern": "/^\\p{L}[\\p{L}\\d]*(?::[+-]?\\d+)?$/u"
+ {
+ "name": "callId",
+ "required": false,
+ "in": "query",
+ "description": "This is the ID of the call.",
+ "schema": {
+ "type": "string"
}
},
- "keyterm": {
- "description": "Keyterm Prompting allows you improve Keyword Recall Rate (KRR) for important keyterms or phrases up to 90%.",
- "type": "array",
- "items": {
+ {
+ "name": "page",
+ "required": false,
+ "in": "query",
+ "description": "This is the page number to return. Defaults to 1.",
+ "schema": {
+ "minimum": 1,
+ "type": "number"
+ }
+ },
+ {
+ "name": "sortOrder",
+ "required": false,
+ "in": "query",
+ "description": "This is the sort order for pagination. Defaults to 'DESC'.",
+ "schema": {
+ "enum": [
+ "ASC",
+ "DESC"
+ ],
"type": "string"
}
},
- "endpointing": {
+ {
+ "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": {
+ "$ref": "#/components/schemas/LogsPaginatedResponse"
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ "Logs"
+ ],
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ },
+ "delete": {
+ "operationId": "LoggingController_logsDeleteQuery",
+ "summary": "Delete Logs",
+ "deprecated": true,
+ "parameters": [
+ {
+ "name": "type",
+ "required": false,
+ "in": "query",
+ "description": "This is the type of the log.",
+ "schema": {
+ "enum": [
+ "API",
+ "Webhook",
+ "Call",
+ "Provider"
+ ],
+ "type": "string"
+ }
+ },
+ {
+ "name": "assistantId",
+ "required": false,
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "phoneNumberId",
+ "required": false,
+ "in": "query",
+ "description": "This is the ID of the phone number.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "customerId",
+ "required": false,
+ "in": "query",
+ "description": "This is the ID of the customer.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "squadId",
+ "required": false,
+ "in": "query",
+ "description": "This is the ID of the squad.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "callId",
+ "required": false,
+ "in": "query",
+ "description": "This is the ID of the call.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": ""
+ }
+ },
+ "tags": [
+ "Logs"
+ ],
+ "security": [
+ {
+ "bearer": []
+ }
+ ]
+ }
+ }
+ },
+ "info": {
+ "title": "Vapi API",
+ "description": "Voice AI for developers.",
+ "version": "1.0",
+ "contact": {}
+ },
+ "tags": [],
+ "servers": [
+ {
+ "url": "https://api.vapi.ai"
+ }
+ ],
+ "components": {
+ "securitySchemes": {
+ "bearer": {
+ "scheme": "bearer",
+ "bearerFormat": "Bearer",
+ "type": "http",
+ "description": "Retrieve your API Key from [Dashboard](dashboard.vapi.ai)."
+ }
+ },
+ "schemas": {
+ "AnalysisCostBreakdown": {
+ "type": "object",
+ "properties": {
+ "summary": {
"type": "number",
- "description": "This is the timeout after which Deepgram will send transcription on user silence. You can read in-depth documentation here: https://developers.deepgram.com/docs/endpointing.\n\nHere are the most important bits:\n- Defaults to 10. This is recommended for most use cases to optimize for latency.\n- 10 can cause some missing transcriptions since because of the shorter context. This mostly happens for one-word utterances. For those uses cases, it's recommended to try 300. It will add a bit of latency but the quality and reliability of the experience will be better.\n- If neither 10 nor 300 work, contact support@vapi.ai and we'll find another solution.\n\n@default 10",
- "minimum": 10,
- "maximum": 500
+ "description": "This is the cost to summarize the call."
},
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "summaryPromptTokens": {
+ "type": "number",
+ "description": "This is the number of prompt tokens used to summarize the call."
+ },
+ "summaryCompletionTokens": {
+ "type": "number",
+ "description": "This is the number of completion tokens used to summarize the call."
+ },
+ "structuredData": {
+ "type": "number",
+ "description": "This is the cost to extract structured data from the call."
+ },
+ "structuredDataPromptTokens": {
+ "type": "number",
+ "description": "This is the number of prompt tokens used to extract structured data from the call."
+ },
+ "structuredDataCompletionTokens": {
+ "type": "number",
+ "description": "This is the number of completion tokens used to extract structured data from the call."
+ },
+ "successEvaluation": {
+ "type": "number",
+ "description": "This is the cost to evaluate if the call was successful."
+ },
+ "successEvaluationPromptTokens": {
+ "type": "number",
+ "description": "This is the number of prompt tokens used to evaluate if the call was successful."
+ },
+ "successEvaluationCompletionTokens": {
+ "type": "number",
+ "description": "This is the number of completion tokens used to evaluate if the call was successful."
+ }
+ }
+ },
+ "CostBreakdown": {
+ "type": "object",
+ "properties": {
+ "transport": {
+ "type": "number",
+ "description": "This is the cost of the transport provider, like Twilio or Vonage."
+ },
+ "stt": {
+ "type": "number",
+ "description": "This is the cost of the speech-to-text service."
+ },
+ "llm": {
+ "type": "number",
+ "description": "This is the cost of the language model."
+ },
+ "tts": {
+ "type": "number",
+ "description": "This is the cost of the text-to-speech service."
+ },
+ "vapi": {
+ "type": "number",
+ "description": "This is the cost of Vapi."
+ },
+ "chat": {
+ "type": "number",
+ "description": "This is the cost of chat interactions."
+ },
+ "total": {
+ "type": "number",
+ "description": "This is the total cost of the call."
+ },
+ "llmPromptTokens": {
+ "type": "number",
+ "description": "This is the LLM prompt tokens used for the call."
+ },
+ "llmCompletionTokens": {
+ "type": "number",
+ "description": "This is the LLM completion tokens used for the call."
+ },
+ "ttsCharacters": {
+ "type": "number",
+ "description": "This is the TTS characters used for the call."
+ },
+ "analysisCostBreakdown": {
+ "description": "This is the cost of the analysis.",
"allOf": [
{
- "$ref": "#/components/schemas/FallbackTranscriberPlan"
+ "$ref": "#/components/schemas/AnalysisCostBreakdown"
}
]
}
- },
- "required": [
- "provider"
- ]
+ }
},
- "ElevenLabsTranscriber": {
+ "TranscriptPlan": {
"type": "object",
"properties": {
- "provider": {
- "type": "string",
- "description": "This is the transcription provider that will be used.",
- "enum": [
- "11labs"
- ]
+ "enabled": {
+ "type": "boolean",
+ "description": "This determines whether the transcript is stored in `call.artifact.transcript`. Defaults to true.\n\n@default true",
+ "example": true
},
- "model": {
+ "assistantName": {
"type": "string",
- "description": "This is the model that will be used for the transcription.",
- "enum": [
- "scribe_v1"
- ]
+ "description": "This is the name of the assistant in the transcript. Defaults to 'AI'.\n\nUsage:\n- If you want to change the name of the assistant in the transcript, set this. Example, here is what the transcript would look like with `assistantName` set to 'Buyer':\n```\nUser: Hello, how are you?\nBuyer: I'm fine.\nUser: Do you want to buy a car?\nBuyer: No.\n```\n\n@default 'AI'"
},
- "language": {
+ "userName": {
"type": "string",
- "enum": [
- "aa",
- "ab",
- "ae",
- "af",
- "ak",
- "am",
- "an",
- "ar",
- "as",
- "av",
- "ay",
- "az",
- "ba",
- "be",
- "bg",
- "bh",
- "bi",
- "bm",
- "bn",
- "bo",
- "br",
- "bs",
- "ca",
- "ce",
- "ch",
- "co",
- "cr",
- "cs",
- "cu",
- "cv",
- "cy",
- "da",
- "de",
- "dv",
- "dz",
- "ee",
- "el",
- "en",
- "eo",
- "es",
- "et",
- "eu",
- "fa",
- "ff",
- "fi",
- "fj",
- "fo",
- "fr",
- "fy",
- "ga",
- "gd",
- "gl",
- "gn",
- "gu",
- "gv",
- "ha",
- "he",
- "hi",
- "ho",
- "hr",
- "ht",
- "hu",
- "hy",
- "hz",
- "ia",
- "id",
- "ie",
- "ig",
- "ii",
- "ik",
- "io",
- "is",
- "it",
- "iu",
- "ja",
- "jv",
- "ka",
- "kg",
- "ki",
- "kj",
- "kk",
- "kl",
- "km",
- "kn",
- "ko",
- "kr",
- "ks",
- "ku",
- "kv",
- "kw",
- "ky",
- "la",
- "lb",
- "lg",
- "li",
- "ln",
- "lo",
- "lt",
- "lu",
- "lv",
- "mg",
- "mh",
- "mi",
- "mk",
- "ml",
- "mn",
- "mr",
- "ms",
- "mt",
- "my",
- "na",
- "nb",
- "nd",
- "ne",
- "ng",
- "nl",
- "nn",
- "no",
- "nr",
- "nv",
- "ny",
- "oc",
- "oj",
- "om",
- "or",
- "os",
- "pa",
- "pi",
- "pl",
- "ps",
- "pt",
- "qu",
- "rm",
- "rn",
- "ro",
- "ru",
- "rw",
- "sa",
- "sc",
- "sd",
- "se",
- "sg",
- "si",
- "sk",
- "sl",
- "sm",
- "sn",
- "so",
- "sq",
- "sr",
- "ss",
- "st",
- "su",
- "sv",
- "sw",
- "ta",
- "te",
- "tg",
- "th",
- "ti",
- "tk",
- "tl",
- "tn",
- "to",
- "tr",
- "ts",
- "tt",
- "tw",
- "ty",
- "ug",
- "uk",
- "ur",
- "uz",
- "ve",
- "vi",
- "vo",
- "wa",
- "wo",
- "xh",
- "yi",
- "yue",
- "yo",
- "za",
- "zh",
- "zu"
- ]
- },
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
- "allOf": [
- {
- "$ref": "#/components/schemas/FallbackTranscriberPlan"
- }
- ]
+ "description": "This is the name of the user in the transcript. Defaults to 'User'.\n\nUsage:\n- If you want to change the name of the user in the transcript, set this. Example, here is what the transcript would look like with `userName` set to 'Seller':\n```\nSeller: Hello, how are you?\nAI: I'm fine.\nSeller: Do you want to buy a car?\nAI: No.\n```\n\n@default 'User'"
}
- },
- "required": [
- "provider"
- ]
+ }
},
- "GladiaTranscriber": {
+ "ArtifactPlan": {
"type": "object",
"properties": {
- "provider": {
- "type": "string",
- "description": "This is the transcription provider that will be used.",
- "enum": [
- "gladia"
- ]
- },
- "model": {
- "description": "This is the Gladia model that will be used. Default is 'fast'",
- "oneOf": [
- {
- "enum": [
- "fast",
- "accurate"
- ]
- }
- ]
- },
- "languageBehaviour": {
- "description": "Defines how the transcription model detects the audio language. Default value is 'automatic single language'.",
- "oneOf": [
- {
- "type": "string",
- "enum": [
- "manual",
- "automatic single language",
- "automatic multiple languages"
- ]
- }
- ]
+ "recordingEnabled": {
+ "type": "boolean",
+ "description": "This determines whether assistant's calls are recorded. Defaults to true.\n\nUsage:\n- If you don't want to record the calls, set this to false.\n- If you want to record the calls when `assistant.hipaaEnabled` (deprecated) or `assistant.compliancePlan.hipaaEnabled` explicity set this to true and make sure to provide S3 or GCP credentials on the Provider Credentials page in the Dashboard.\n\nYou can find the recording at `call.artifact.recordingUrl` and `call.artifact.stereoRecordingUrl` after the call is ended.\n\n@default true",
+ "example": true
},
- "language": {
+ "recordingFormat": {
"type": "string",
- "description": "Defines the language to use for the transcription. Required when languageBehaviour is 'manual'.",
+ "description": "This determines the format of the recording. Defaults to `wav;l16`.\n\n@default 'wav;l16'",
"enum": [
- "af",
- "sq",
- "am",
- "ar",
- "hy",
- "as",
- "az",
- "ba",
- "eu",
- "be",
- "bn",
- "bs",
- "br",
- "bg",
- "ca",
- "zh",
- "hr",
- "cs",
- "da",
- "nl",
- "en",
- "et",
- "fo",
- "fi",
- "fr",
- "gl",
- "ka",
- "de",
- "el",
- "gu",
- "ht",
- "ha",
- "haw",
- "he",
- "hi",
- "hu",
- "is",
- "id",
- "it",
- "ja",
- "jv",
- "kn",
- "kk",
- "km",
- "ko",
- "lo",
- "la",
- "lv",
- "ln",
- "lt",
- "lb",
- "mk",
- "mg",
- "ms",
- "ml",
- "mt",
- "mi",
- "mr",
- "mn",
- "my",
- "ne",
- "no",
- "nn",
- "oc",
- "ps",
- "fa",
- "pl",
- "pt",
- "pa",
- "ro",
- "ru",
- "sa",
- "sr",
- "sn",
- "sd",
- "si",
- "sk",
- "sl",
- "so",
- "es",
- "su",
- "sw",
- "sv",
- "tl",
- "tg",
- "ta",
- "tt",
- "te",
- "th",
- "bo",
- "tr",
- "tk",
- "uk",
- "ur",
- "uz",
- "vi",
- "cy",
- "yi",
- "yo"
+ "wav;l16",
+ "mp3"
]
},
- "transcriptionHint": {
- "type": "string",
- "description": "Provides a custom vocabulary to the model to improve accuracy of transcribing context specific words, technical terms, names, etc. If empty, this argument is ignored.\n⚠️ Warning ⚠️: Please be aware that the transcription_hint field has a character limit of 600. If you provide a transcription_hint longer than 600 characters, it will be automatically truncated to meet this limit.",
- "maxLength": 600,
- "example": "custom vocabulary"
- },
- "prosody": {
+ "videoRecordingEnabled": {
"type": "boolean",
- "description": "If prosody is true, you will get a transcription that can contain prosodies i.e. (laugh) (giggles) (malefic laugh) (toss) (music)… Default value is false.",
+ "description": "This determines whether the video is recorded during the call. Defaults to false. Only relevant for `webCall` type.\n\nYou can find the video recording at `call.artifact.videoRecordingUrl` after the call is ended.\n\n@default false",
"example": false
},
- "audioEnhancer": {
+ "pcapEnabled": {
"type": "boolean",
- "description": "If true, audio will be pre-processed to improve accuracy but latency will increase. Default value is false.",
- "example": false
+ "description": "This determines whether the SIP packet capture is enabled. Defaults to true. Only relevant for `phone` type calls where phone number's provider is `vapi` or `byo-phone-number`.\n\nYou can find the packet capture at `call.artifact.pcapUrl` after the call is ended.\n\n@default true",
+ "example": true
},
- "confidenceThreshold": {
- "type": "number",
- "description": "Transcripts below this confidence threshold will be discarded.\n\n@default 0.4",
- "minimum": 0,
- "maximum": 1,
- "example": 0.4
+ "pcapS3PathPrefix": {
+ "type": "string",
+ "description": "This is the path where the SIP packet capture will be uploaded. This is only used if you have provided S3 or GCP credentials on the Provider Credentials page in the Dashboard.\n\nIf credential.s3PathPrefix or credential.bucketPlan.path is set, this will append to it.\n\nUsage:\n- If you want to upload the packet capture to a specific path, set this to the path. Example: `/my-assistant-captures`.\n- If you want to upload the packet capture to the root of the bucket, set this to `/`.\n\n@default '/'",
+ "example": "/pcaps"
},
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "transcriptPlan": {
+ "description": "This is the plan for `call.artifact.transcript`. To disable, set `transcriptPlan.enabled` to false.",
"allOf": [
{
- "$ref": "#/components/schemas/FallbackTranscriberPlan"
+ "$ref": "#/components/schemas/TranscriptPlan"
}
]
+ },
+ "recordingPath": {
+ "type": "string",
+ "description": "This is the path where the recording will be uploaded. This is only used if you have provided S3 or GCP credentials on the Provider Credentials page in the Dashboard.\n\nIf credential.s3PathPrefix or credential.bucketPlan.path is set, this will append to it.\n\nUsage:\n- If you want to upload the recording to a specific path, set this to the path. Example: `/my-assistant-recordings`.\n- If you want to upload the recording to the root of the bucket, set this to `/`.\n\n@default '/'"
}
- },
- "required": [
- "provider"
- ]
+ }
},
- "SpeechmaticsTranscriber": {
+ "Analysis": {
"type": "object",
"properties": {
- "provider": {
+ "summary": {
"type": "string",
- "description": "This is the transcription provider that will be used.",
- "enum": [
- "speechmatics"
- ]
+ "description": "This is the summary of the call. Customize by setting `assistant.analysisPlan.summaryPrompt`."
},
- "model": {
+ "structuredData": {
+ "type": "object",
+ "description": "This is the structured data extracted from the call. Customize by setting `assistant.analysisPlan.structuredDataPrompt` and/or `assistant.analysisPlan.structuredDataSchema`."
+ },
+ "structuredDataMulti": {
+ "description": "This is the structured data catalog of the call. Customize by setting `assistant.analysisPlan.structuredDataMultiPlan`.",
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ },
+ "successEvaluation": {
"type": "string",
- "description": "This is the model that will be used for the transcription.",
- "enum": [
- "default"
- ]
+ "description": "This is the evaluation of the call. Customize by setting `assistant.analysisPlan.successEvaluationPrompt` and/or `assistant.analysisPlan.successEvaluationRubric`."
+ }
+ }
+ },
+ "Monitor": {
+ "type": "object",
+ "properties": {
+ "listenUrl": {
+ "type": "string",
+ "description": "This is the URL where the assistant's calls can be listened to in real-time. To enable, set `assistant.monitorPlan.listenEnabled` to `true`."
},
- "language": {
+ "controlUrl": {
"type": "string",
- "enum": [
- "auto",
- "ar",
- "ba",
- "eu",
- "be",
- "bn",
- "bg",
- "yue",
- "ca",
- "hr",
- "cs",
- "da",
- "nl",
- "en",
- "eo",
- "et",
- "fi",
- "fr",
- "gl",
- "de",
- "el",
- "he",
- "hi",
- "hu",
- "id",
- "ia",
- "ga",
- "it",
- "ja",
- "ko",
- "lv",
- "lt",
- "ms",
- "mt",
- "cmn",
- "mr",
- "mn",
- "no",
- "fa",
- "pl",
- "pt",
- "ro",
- "ru",
- "sk",
- "sl",
- "es",
- "sw",
- "sv",
- "ta",
- "th",
- "tr",
- "uk",
- "ur",
- "ug",
- "vi",
- "cy"
- ]
+ "description": "This is the URL where the assistant's calls can be controlled in real-time. To enable, set `assistant.monitorPlan.controlEnabled` to `true`."
+ }
+ }
+ },
+ "OpenAIMessage": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "nullable": true,
+ "maxLength": 100000000
},
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
- "allOf": [
- {
- "$ref": "#/components/schemas/FallbackTranscriberPlan"
- }
+ "role": {
+ "type": "string",
+ "enum": [
+ "assistant",
+ "function",
+ "user",
+ "system",
+ "tool"
]
}
},
"required": [
- "provider"
+ "content",
+ "role"
]
},
- "TalkscriberTranscriber": {
+ "Mono": {
"type": "object",
"properties": {
- "provider": {
+ "combinedUrl": {
"type": "string",
- "description": "This is the transcription provider that will be used.",
- "enum": [
- "talkscriber"
- ]
+ "description": "This is the combined recording url for the call. To enable, set `assistant.artifactPlan.recordingEnabled`."
},
- "model": {
+ "assistantUrl": {
"type": "string",
- "description": "This is the model that will be used for the transcription.",
- "enum": [
- "whisper"
- ]
+ "description": "This is the mono recording url for the assistant. To enable, set `assistant.artifactPlan.recordingEnabled`."
},
- "language": {
+ "customerUrl": {
"type": "string",
- "description": "This is the language that will be set for the transcription. The list of languages Whisper supports can be found here: https://github.com/openai/whisper/blob/main/whisper/tokenizer.py",
- "enum": [
- "en",
- "zh",
- "de",
- "es",
- "ru",
- "ko",
- "fr",
- "ja",
- "pt",
- "tr",
- "pl",
- "ca",
- "nl",
- "ar",
- "sv",
- "it",
- "id",
- "hi",
- "fi",
- "vi",
- "he",
- "uk",
- "el",
- "ms",
- "cs",
- "ro",
- "da",
- "hu",
- "ta",
- "no",
- "th",
- "ur",
- "hr",
- "bg",
- "lt",
- "la",
- "mi",
- "ml",
- "cy",
- "sk",
- "te",
- "fa",
- "lv",
- "bn",
- "sr",
- "az",
- "sl",
- "kn",
- "et",
- "mk",
- "br",
- "eu",
- "is",
- "hy",
- "ne",
- "mn",
- "bs",
- "kk",
- "sq",
- "sw",
- "gl",
- "mr",
- "pa",
- "si",
- "km",
- "sn",
- "yo",
- "so",
- "af",
- "oc",
- "ka",
- "be",
- "tg",
- "sd",
- "gu",
- "am",
- "yi",
- "lo",
- "uz",
- "fo",
- "ht",
- "ps",
- "tk",
- "nn",
- "mt",
- "sa",
- "lb",
- "my",
- "bo",
- "tl",
- "mg",
- "as",
- "tt",
- "haw",
- "ln",
- "ha",
- "ba",
- "jw",
- "su",
- "yue"
- ]
- },
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
- "allOf": [
- {
- "$ref": "#/components/schemas/FallbackTranscriberPlan"
- }
- ]
+ "description": "This is the mono recording url for the customer. To enable, set `assistant.artifactPlan.recordingEnabled`."
}
- },
- "required": [
- "provider"
- ]
+ }
},
- "GoogleTranscriber": {
+ "Recording": {
"type": "object",
"properties": {
- "provider": {
+ "stereoUrl": {
"type": "string",
- "description": "This is the transcription provider that will be used.",
- "enum": [
- "google"
- ]
+ "description": "This is the stereo recording url for the call. To enable, set `assistant.artifactPlan.recordingEnabled`."
},
- "model": {
+ "videoUrl": {
"type": "string",
- "description": "This is the model that will be used for the transcription.",
- "enum": [
- "gemini-2.0-flash-thinking-exp",
- "gemini-2.0-pro-exp-02-05",
- "gemini-2.0-flash",
- "gemini-2.0-flash-lite",
- "gemini-2.0-flash-lite-preview-02-05",
- "gemini-2.0-flash-exp",
- "gemini-2.0-flash-realtime-exp",
- "gemini-1.5-flash",
- "gemini-1.5-flash-002",
- "gemini-1.5-pro",
- "gemini-1.5-pro-002",
- "gemini-1.0-pro"
- ]
+ "description": "This is the video recording url for the call. To enable, set `assistant.artifactPlan.videoRecordingEnabled`."
},
- "language": {
- "type": "string",
- "description": "This is the language that will be set for the transcription.",
- "enum": [
- "Multilingual",
- "Arabic",
- "Bengali",
- "Bulgarian",
- "Chinese",
- "Croatian",
- "Czech",
- "Danish",
- "Dutch",
- "English",
- "Estonian",
- "Finnish",
- "French",
- "German",
- "Greek",
- "Hebrew",
- "Hindi",
- "Hungarian",
- "Indonesian",
- "Italian",
- "Japanese",
- "Korean",
- "Latvian",
- "Lithuanian",
- "Norwegian",
- "Polish",
- "Portuguese",
- "Romanian",
- "Russian",
- "Serbian",
- "Slovak",
- "Slovenian",
- "Spanish",
- "Swahili",
- "Swedish",
- "Thai",
- "Turkish",
- "Ukrainian",
- "Vietnamese"
- ]
+ "videoRecordingStartDelaySeconds": {
+ "type": "number",
+ "description": "This is video recording start delay in ms. To enable, set `assistant.artifactPlan.videoRecordingEnabled`. This can be used to align the playback of the recording with artifact.messages timestamps."
},
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "mono": {
+ "description": "This is the mono recording url for the call. To enable, set `assistant.artifactPlan.recordingEnabled`.",
"allOf": [
{
- "$ref": "#/components/schemas/FallbackTranscriberPlan"
+ "$ref": "#/components/schemas/Mono"
}
]
}
- },
- "required": [
- "provider"
- ]
+ }
},
- "OpenAITranscriber": {
+ "NodeArtifact": {
"type": "object",
"properties": {
- "provider": {
+ "nodeName": {
"type": "string",
- "description": "This is the transcription provider that will be used.",
- "enum": [
- "openai"
- ]
+ "description": "This is the node id."
},
- "model": {
+ "messages": {
+ "description": "This is the messages that were spoken during the node.",
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ },
+ "variables": {
+ "type": "object",
+ "description": "This is the object containing the variables extracted from the node."
+ }
+ }
+ },
+ "Artifact": {
+ "type": "object",
+ "properties": {
+ "messages": {
+ "type": "array",
+ "description": "These are the messages that were spoken during the call.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/UserMessage",
+ "title": "UserMessage"
+ },
+ {
+ "$ref": "#/components/schemas/SystemMessage",
+ "title": "SystemMessage"
+ },
+ {
+ "$ref": "#/components/schemas/BotMessage",
+ "title": "BotMessage"
+ },
+ {
+ "$ref": "#/components/schemas/ToolCallMessage",
+ "title": "ToolCallMessage"
+ },
+ {
+ "$ref": "#/components/schemas/ToolCallResultMessage",
+ "title": "ToolCallResultMessage"
+ }
+ ]
+ }
+ },
+ "messagesOpenAIFormatted": {
+ "description": "These are the messages that were spoken during the call, formatted for OpenAI.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OpenAIMessage"
+ }
+ },
+ "recordingUrl": {
"type": "string",
- "description": "This is the model that will be used for the transcription.",
- "enum": [
- "gpt-4o-transcribe",
- "gpt-4o-mini-transcribe"
- ]
+ "description": "This is the recording url for the call. To enable, set `assistant.artifactPlan.recordingEnabled`.",
+ "deprecated": true
},
- "language": {
+ "stereoRecordingUrl": {
"type": "string",
- "description": "This is the language that will be set for the transcription.",
- "enum": [
- "af",
- "ar",
- "hy",
- "az",
- "be",
- "bs",
- "bg",
- "ca",
- "zh",
- "hr",
- "cs",
- "da",
- "nl",
- "en",
- "et",
- "fi",
- "fr",
- "gl",
- "de",
- "el",
- "he",
- "hi",
- "hu",
- "is",
- "id",
- "it",
- "ja",
- "kn",
- "kk",
- "ko",
- "lv",
- "lt",
- "mk",
- "ms",
- "mr",
- "mi",
- "ne",
- "no",
- "fa",
- "pl",
- "pt",
- "ro",
- "ru",
- "sr",
- "sk",
- "sl",
- "es",
- "sw",
- "sv",
- "tl",
- "ta",
- "th",
- "tr",
- "uk",
- "ur",
- "vi",
- "cy"
- ]
+ "description": "This is the stereo recording url for the call. To enable, set `assistant.artifactPlan.recordingEnabled`.",
+ "deprecated": true
},
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "videoRecordingUrl": {
+ "type": "string",
+ "description": "This is video recording url for the call. To enable, set `assistant.artifactPlan.videoRecordingEnabled`.",
+ "deprecated": true
+ },
+ "videoRecordingStartDelaySeconds": {
+ "type": "number",
+ "description": "This is video recording start delay in ms. To enable, set `assistant.artifactPlan.videoRecordingEnabled`. This can be used to align the playback of the recording with artifact.messages timestamps.",
+ "deprecated": true
+ },
+ "recording": {
+ "description": "This is the recording url for the call. To enable, set `assistant.artifactPlan.recordingEnabled`.",
"allOf": [
{
- "$ref": "#/components/schemas/FallbackTranscriberPlan"
+ "$ref": "#/components/schemas/Recording"
}
]
+ },
+ "transcript": {
+ "type": "string",
+ "description": "This is the transcript of the call. This is derived from `artifact.messages` but provided for convenience."
+ },
+ "pcapUrl": {
+ "type": "string",
+ "description": "This is the packet capture url for the call. This is only available for `phone` type calls where phone number's provider is `vapi` or `byo-phone-number`."
+ },
+ "nodes": {
+ "description": "This is the history of workflow nodes that were executed during the call.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/NodeArtifact"
+ }
+ },
+ "variables": {
+ "type": "object",
+ "description": "This is the state of variables at the end of the workflow execution."
+ }
+ }
+ },
+ "FallbackTranscriberPlan": {
+ "type": "object",
+ "properties": {
+ "transcribers": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/FallbackAssemblyAITranscriber",
+ "title": "AssemblyAI"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackAzureSpeechTranscriber",
+ "title": "Azure"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackCustomTranscriber",
+ "title": "Custom"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackDeepgramTranscriber",
+ "title": "Deepgram"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackElevenLabsTranscriber",
+ "title": "ElevenLabs"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackGladiaTranscriber",
+ "title": "Gladia"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackGoogleTranscriber",
+ "title": "Google"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackTalkscriberTranscriber",
+ "title": "Talkscriber"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackSpeechmaticsTranscriber",
+ "title": "Speechmatics"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackOpenAITranscriber",
+ "title": "OpenAI"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackCartesiaTranscriber",
+ "title": "Cartesia"
+ }
+ ]
+ }
}
},
"required": [
- "provider",
- "model"
+ "transcribers"
]
},
- "FallbackAssemblyAITranscriber": {
+ "AssemblyAITranscriber": {
"type": "object",
"properties": {
"provider": {
@@ -6069,6 +6180,41 @@
"maximum": 1,
"example": 0.4
},
+ "enableUniversalStreamingApi": {
+ "type": "boolean",
+ "description": "Uses Assembly AI's new Universal Streaming API. See: https://www.assemblyai.com/docs/speech-to-text/universal-streaming\n\n@default false",
+ "example": false
+ },
+ "formatTurns": {
+ "type": "boolean",
+ "description": "This enables formatting of transcripts. Only used when `enableUniversalStreamingApi` is true.\n\n@default false",
+ "example": false
+ },
+ "endOfTurnConfidenceThreshold": {
+ "type": "number",
+ "description": "The confidence threshold to use when determining if the end of a turn has been reached. Only used when `enableUniversalStreamingApi` is true.\n\n@default 0.7",
+ "minimum": 0,
+ "maximum": 1,
+ "example": 0.7
+ },
+ "minEndOfTurnSilenceWhenConfident": {
+ "type": "number",
+ "description": "The minimum amount of silence in milliseconds required to detect end of turn when confident. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160",
+ "minimum": 0,
+ "example": 160
+ },
+ "wordFinalizationMaxWaitTime": {
+ "type": "number",
+ "description": "The maximum wait time for word finalization. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160",
+ "minimum": 0,
+ "example": 160
+ },
+ "maxTurnSilence": {
+ "type": "number",
+ "description": "The maximum amount of silence in milliseconds allowed in a turn before end of turn is triggered. Only used when `enableUniversalStreamingApi` is true.\n\n@default 400",
+ "minimum": 0,
+ "example": 400
+ },
"realtimeUrl": {
"type": "string",
"description": "The WebSocket URL that the transcriber connects to."
@@ -6088,13 +6234,21 @@
"disablePartialTranscripts": {
"type": "boolean",
"description": "Disable partial transcripts.\nSet to `true` to not receive partial transcripts. Defaults to `false`."
+ },
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackTranscriberPlan"
+ }
+ ]
}
},
"required": [
"provider"
]
},
- "FallbackAzureSpeechTranscriber": {
+ "AzureSpeechTranscriber": {
"type": "object",
"properties": {
"provider": {
@@ -6252,104 +6406,404 @@
"zh-TW",
"zu-ZA"
]
- }
- },
- "required": [
- "provider"
- ]
- },
- "FallbackCustomTranscriber": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "description": "This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported.",
- "enum": [
- "custom-transcriber"
- ]
},
- "server": {
- "description": "This is where the transcription request will be sent.\n\nUsage:\n1. Vapi will initiate a websocket connection with `server.url`.\n\n2. Vapi will send an initial text frame with the sample rate. Format:\n```\n {\n \"type\": \"start\",\n \"encoding\": \"linear16\", // 16-bit raw PCM format\n \"container\": \"raw\",\n \"sampleRate\": {{sampleRate}},\n \"channels\": 2 // customer is channel 0, assistant is channel 1\n }\n```\n\n3. Vapi will send the audio data in 16-bit raw PCM format as binary frames.\n\n4. You can read the messages something like this:\n```\nws.on('message', (data, isBinary) => {\n if (isBinary) {\n pcmBuffer = Buffer.concat([pcmBuffer, data]);\n console.log(`Received PCM data, buffer size: ${pcmBuffer.length}`);\n } else {\n console.log('Received message:', JSON.parse(data.toString()));\n }\n});\n```\n\n5. You will respond with transcriptions as you have them. Format:\n```\n {\n \"type\": \"transcriber-response\",\n \"transcription\": \"Hello, world!\",\n \"channel\": \"customer\" | \"assistant\"\n }\n```",
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/FallbackTranscriberPlan"
}
]
}
},
"required": [
- "provider",
- "server"
+ "provider"
]
},
- "FallbackDeepgramTranscriber": {
+ "CartesiaTranscriber": {
"type": "object",
"properties": {
"provider": {
"type": "string",
- "description": "This is the transcription provider that will be used.",
"enum": [
- "deepgram"
+ "cartesia"
]
},
"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",
- "oneOf": [
- {
- "type": "string",
- "enum": [
- "nova-3",
- "nova-3-general",
- "nova-3-medical",
- "nova-2",
- "nova-2-general",
- "nova-2-meeting",
- "nova-2-phonecall",
- "nova-2-finance",
- "nova-2-conversationalai",
- "nova-2-voicemail",
- "nova-2-video",
- "nova-2-medical",
- "nova-2-drivethru",
- "nova-2-automotive",
- "nova",
- "nova-general",
- "nova-phonecall",
- "nova-medical",
- "enhanced",
- "enhanced-general",
- "enhanced-meeting",
- "enhanced-phonecall",
- "enhanced-finance",
- "base",
- "base-general",
- "base-meeting",
- "base-phonecall",
- "base-finance",
- "base-conversationalai",
- "base-voicemail",
- "base-video"
- ]
- },
- {
- "type": "string"
- }
+ "type": "string",
+ "enum": [
+ "ink-whisper"
]
},
"language": {
"type": "string",
- "description": "This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview",
"enum": [
- "bg",
- "ca",
- "cs",
- "da",
- "da-DK",
- "de",
- "de-CH",
- "el",
- "en",
- "en-AU",
+ "aa",
+ "ab",
+ "ae",
+ "af",
+ "ak",
+ "am",
+ "an",
+ "ar",
+ "as",
+ "av",
+ "ay",
+ "az",
+ "ba",
+ "be",
+ "bg",
+ "bh",
+ "bi",
+ "bm",
+ "bn",
+ "bo",
+ "br",
+ "bs",
+ "ca",
+ "ce",
+ "ch",
+ "co",
+ "cr",
+ "cs",
+ "cu",
+ "cv",
+ "cy",
+ "da",
+ "de",
+ "dv",
+ "dz",
+ "ee",
+ "el",
+ "en",
+ "eo",
+ "es",
+ "et",
+ "eu",
+ "fa",
+ "ff",
+ "fi",
+ "fj",
+ "fo",
+ "fr",
+ "fy",
+ "ga",
+ "gd",
+ "gl",
+ "gn",
+ "gu",
+ "gv",
+ "ha",
+ "he",
+ "hi",
+ "ho",
+ "hr",
+ "ht",
+ "hu",
+ "hy",
+ "hz",
+ "ia",
+ "id",
+ "ie",
+ "ig",
+ "ii",
+ "ik",
+ "io",
+ "is",
+ "it",
+ "iu",
+ "ja",
+ "jv",
+ "ka",
+ "kg",
+ "ki",
+ "kj",
+ "kk",
+ "kl",
+ "km",
+ "kn",
+ "ko",
+ "kr",
+ "ks",
+ "ku",
+ "kv",
+ "kw",
+ "ky",
+ "la",
+ "lb",
+ "lg",
+ "li",
+ "ln",
+ "lo",
+ "lt",
+ "lu",
+ "lv",
+ "mg",
+ "mh",
+ "mi",
+ "mk",
+ "ml",
+ "mn",
+ "mr",
+ "ms",
+ "mt",
+ "my",
+ "na",
+ "nb",
+ "nd",
+ "ne",
+ "ng",
+ "nl",
+ "nn",
+ "no",
+ "nr",
+ "nv",
+ "ny",
+ "oc",
+ "oj",
+ "om",
+ "or",
+ "os",
+ "pa",
+ "pi",
+ "pl",
+ "ps",
+ "pt",
+ "qu",
+ "rm",
+ "rn",
+ "ro",
+ "ru",
+ "rw",
+ "sa",
+ "sc",
+ "sd",
+ "se",
+ "sg",
+ "si",
+ "sk",
+ "sl",
+ "sm",
+ "sn",
+ "so",
+ "sq",
+ "sr",
+ "ss",
+ "st",
+ "su",
+ "sv",
+ "sw",
+ "ta",
+ "te",
+ "tg",
+ "th",
+ "ti",
+ "tk",
+ "tl",
+ "tn",
+ "to",
+ "tr",
+ "ts",
+ "tt",
+ "tw",
+ "ty",
+ "ug",
+ "uk",
+ "ur",
+ "uz",
+ "ve",
+ "vi",
+ "vo",
+ "wa",
+ "wo",
+ "xh",
+ "yi",
+ "yue",
+ "yo",
+ "za",
+ "zh",
+ "zu"
+ ]
+ },
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackTranscriberPlan"
+ }
+ ]
+ }
+ },
+ "required": [
+ "provider"
+ ]
+ },
+ "BackoffPlan": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "object",
+ "description": "This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed",
+ "enum": [
+ "fixed",
+ "exponential"
+ ],
+ "example": "fixed"
+ },
+ "maxRetries": {
+ "type": "number",
+ "description": "This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0",
+ "minimum": 0,
+ "maximum": 10,
+ "example": 0
+ },
+ "baseDelaySeconds": {
+ "type": "number",
+ "description": "This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.",
+ "minimum": 0,
+ "maximum": 10,
+ "example": 1
+ }
+ },
+ "required": [
+ "type",
+ "maxRetries",
+ "baseDelaySeconds"
+ ]
+ },
+ "Server": {
+ "type": "object",
+ "properties": {
+ "timeoutSeconds": {
+ "type": "number",
+ "description": "This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20",
+ "minimum": 1,
+ "maximum": 300,
+ "example": 20
+ },
+ "url": {
+ "type": "string",
+ "description": "This is where the request will be sent."
+ },
+ "headers": {
+ "type": "object",
+ "description": "These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value."
+ },
+ "backoffPlan": {
+ "description": "This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BackoffPlan"
+ }
+ ]
+ }
+ }
+ },
+ "CustomTranscriber": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "description": "This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported.",
+ "enum": [
+ "custom-transcriber"
+ ]
+ },
+ "server": {
+ "description": "This is where the transcription request will be sent.\n\nUsage:\n1. Vapi will initiate a websocket connection with `server.url`.\n\n2. Vapi will send an initial text frame with the sample rate. Format:\n```\n {\n \"type\": \"start\",\n \"encoding\": \"linear16\", // 16-bit raw PCM format\n \"container\": \"raw\",\n \"sampleRate\": {{sampleRate}},\n \"channels\": 2 // customer is channel 0, assistant is channel 1\n }\n```\n\n3. Vapi will send the audio data in 16-bit raw PCM format as binary frames.\n\n4. You can read the messages something like this:\n```\nws.on('message', (data, isBinary) => {\n if (isBinary) {\n pcmBuffer = Buffer.concat([pcmBuffer, data]);\n console.log(`Received PCM data, buffer size: ${pcmBuffer.length}`);\n } else {\n console.log('Received message:', JSON.parse(data.toString()));\n }\n});\n```\n\n5. You will respond with transcriptions as you have them. Format:\n```\n {\n \"type\": \"transcriber-response\",\n \"transcription\": \"Hello, world!\",\n \"channel\": \"customer\" | \"assistant\"\n }\n```",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
+ },
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackTranscriberPlan"
+ }
+ ]
+ }
+ },
+ "required": [
+ "provider",
+ "server"
+ ]
+ },
+ "DeepgramTranscriber": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "description": "This is the transcription provider that will be used.",
+ "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",
+ "oneOf": [
+ {
+ "type": "string",
+ "enum": [
+ "nova-3",
+ "nova-3-general",
+ "nova-3-medical",
+ "nova-2",
+ "nova-2-general",
+ "nova-2-meeting",
+ "nova-2-phonecall",
+ "nova-2-finance",
+ "nova-2-conversationalai",
+ "nova-2-voicemail",
+ "nova-2-video",
+ "nova-2-medical",
+ "nova-2-drivethru",
+ "nova-2-automotive",
+ "nova",
+ "nova-general",
+ "nova-phonecall",
+ "nova-medical",
+ "enhanced",
+ "enhanced-general",
+ "enhanced-meeting",
+ "enhanced-phonecall",
+ "enhanced-finance",
+ "base",
+ "base-general",
+ "base-meeting",
+ "base-phonecall",
+ "base-finance",
+ "base-conversationalai",
+ "base-voicemail",
+ "base-video",
+ "whisper"
+ ]
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "language": {
+ "type": "string",
+ "description": "This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview",
+ "enum": [
+ "ar",
+ "az",
+ "ba",
+ "bg",
+ "br",
+ "ca",
+ "cs",
+ "da",
+ "da-DK",
+ "de",
+ "de-CH",
+ "el",
+ "en",
+ "en-AU",
"en-GB",
"en-IN",
"en-NZ",
@@ -6358,19 +6812,28 @@
"es-419",
"es-LATAM",
"et",
+ "eu",
"fi",
"fr",
"fr-CA",
+ "ha",
+ "haw",
+ "he",
"hi",
"hi-Latn",
"hu",
"id",
+ "is",
"it",
"ja",
+ "jw",
+ "kn",
"ko",
"ko-KR",
+ "ln",
"lt",
"lv",
+ "mk",
"ms",
"multi",
"nl",
@@ -6382,6 +6845,11 @@
"ro",
"ru",
"sk",
+ "sl",
+ "sn",
+ "so",
+ "sr",
+ "su",
"sv",
"sv-SE",
"ta",
@@ -6389,8 +6857,11 @@
"th",
"th-TH",
"tr",
+ "tt",
"uk",
+ "ur",
"vi",
+ "yo",
"zh",
"zh-CN",
"zh-HK",
@@ -6447,13 +6918,21 @@
"description": "This is the timeout after which Deepgram will send transcription on user silence. You can read in-depth documentation here: https://developers.deepgram.com/docs/endpointing.\n\nHere are the most important bits:\n- Defaults to 10. This is recommended for most use cases to optimize for latency.\n- 10 can cause some missing transcriptions since because of the shorter context. This mostly happens for one-word utterances. For those uses cases, it's recommended to try 300. It will add a bit of latency but the quality and reliability of the experience will be better.\n- If neither 10 nor 300 work, contact support@vapi.ai and we'll find another solution.\n\n@default 10",
"minimum": 10,
"maximum": 500
+ },
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackTranscriberPlan"
+ }
+ ]
}
},
"required": [
"provider"
]
},
- "FallbackElevenLabsTranscriber": {
+ "ElevenLabsTranscriber": {
"type": "object",
"properties": {
"provider": {
@@ -6659,13 +7138,21 @@
"zh",
"zu"
]
+ },
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackTranscriberPlan"
+ }
+ ]
}
},
"required": [
"provider"
]
},
- "FallbackGladiaTranscriber": {
+ "GladiaTranscriber": {
"type": "object",
"properties": {
"provider": {
@@ -6681,7 +7168,8 @@
{
"enum": [
"fast",
- "accurate"
+ "accurate",
+ "solaria-1"
]
}
]
@@ -6804,6 +7292,111 @@
"yo"
]
},
+ "languages": {
+ "type": "string",
+ "description": "Defines the languages to use for the transcription. Required when languageBehaviour is 'manual'.",
+ "enum": [
+ "af",
+ "sq",
+ "am",
+ "ar",
+ "hy",
+ "as",
+ "az",
+ "ba",
+ "eu",
+ "be",
+ "bn",
+ "bs",
+ "br",
+ "bg",
+ "ca",
+ "zh",
+ "hr",
+ "cs",
+ "da",
+ "nl",
+ "en",
+ "et",
+ "fo",
+ "fi",
+ "fr",
+ "gl",
+ "ka",
+ "de",
+ "el",
+ "gu",
+ "ht",
+ "ha",
+ "haw",
+ "he",
+ "hi",
+ "hu",
+ "is",
+ "id",
+ "it",
+ "ja",
+ "jv",
+ "kn",
+ "kk",
+ "km",
+ "ko",
+ "lo",
+ "la",
+ "lv",
+ "ln",
+ "lt",
+ "lb",
+ "mk",
+ "mg",
+ "ms",
+ "ml",
+ "mt",
+ "mi",
+ "mr",
+ "mn",
+ "my",
+ "ne",
+ "no",
+ "nn",
+ "oc",
+ "ps",
+ "fa",
+ "pl",
+ "pt",
+ "pa",
+ "ro",
+ "ru",
+ "sa",
+ "sr",
+ "sn",
+ "sd",
+ "si",
+ "sk",
+ "sl",
+ "so",
+ "es",
+ "su",
+ "sw",
+ "sv",
+ "tl",
+ "tg",
+ "ta",
+ "tt",
+ "te",
+ "th",
+ "bo",
+ "tr",
+ "tk",
+ "uk",
+ "ur",
+ "uz",
+ "vi",
+ "cy",
+ "yi",
+ "yo"
+ ]
+ },
"transcriptionHint": {
"type": "string",
"description": "Provides a custom vocabulary to the model to improve accuracy of transcribing context specific words, technical terms, names, etc. If empty, this argument is ignored.\n⚠️ Warning ⚠️: Please be aware that the transcription_hint field has a character limit of 600. If you provide a transcription_hint longer than 600 characters, it will be automatically truncated to meet this limit.",
@@ -6826,13 +7419,21 @@
"minimum": 0,
"maximum": 1,
"example": 0.4
+ },
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackTranscriberPlan"
+ }
+ ]
}
},
"required": [
"provider"
]
},
- "FallbackSpeechmaticsTranscriber": {
+ "SpeechmaticsTranscriber": {
"type": "object",
"properties": {
"provider": {
@@ -6909,13 +7510,21 @@
"vi",
"cy"
]
- }
- },
- "required": [
+ },
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackTranscriberPlan"
+ }
+ ]
+ }
+ },
+ "required": [
"provider"
]
},
- "FallbackTalkscriberTranscriber": {
+ "TalkscriberTranscriber": {
"type": "object",
"properties": {
"provider": {
@@ -7037,13 +7646,21 @@
"su",
"yue"
]
+ },
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackTranscriberPlan"
+ }
+ ]
}
},
"required": [
"provider"
]
},
- "FallbackGoogleTranscriber": {
+ "GoogleTranscriber": {
"type": "object",
"properties": {
"provider": {
@@ -7057,6 +7674,9 @@
"type": "string",
"description": "This is the model that will be used for the transcription.",
"enum": [
+ "gemini-2.5-pro-preview-05-06",
+ "gemini-2.5-flash-preview-05-20",
+ "gemini-2.5-flash-preview-04-17",
"gemini-2.0-flash-thinking-exp",
"gemini-2.0-pro-exp-02-05",
"gemini-2.0-flash",
@@ -7115,13 +7735,21 @@
"Ukrainian",
"Vietnamese"
]
+ },
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackTranscriberPlan"
+ }
+ ]
}
},
"required": [
"provider"
]
},
- "FallbackOpenAITranscriber": {
+ "OpenAITranscriber": {
"type": "object",
"properties": {
"provider": {
@@ -7201,6 +7829,14 @@
"vi",
"cy"
]
+ },
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackTranscriberPlan"
+ }
+ ]
}
},
"required": [
@@ -7208,43 +7844,268 @@
"model"
]
},
- "LangfuseObservabilityPlan": {
+ "FallbackAssemblyAITranscriber": {
"type": "object",
"properties": {
"provider": {
"type": "string",
+ "description": "This is the transcription provider that will be used.",
"enum": [
- "langfuse"
+ "assembly-ai"
]
},
- "tags": {
- "description": "This is an array of tags to be added to the Langfuse trace. Tags allow you to categorize and filter traces. https://langfuse.com/docs/tracing-features/tags",
+ "language": {
+ "type": "string",
+ "description": "This is the language that will be set for the transcription.",
+ "enum": [
+ "en"
+ ]
+ },
+ "confidenceThreshold": {
+ "type": "number",
+ "description": "Transcripts below this confidence threshold will be discarded.\n\n@default 0.4",
+ "minimum": 0,
+ "maximum": 1,
+ "example": 0.4
+ },
+ "enableUniversalStreamingApi": {
+ "type": "boolean",
+ "description": "Uses Assembly AI's new Universal Streaming API. See: https://www.assemblyai.com/docs/speech-to-text/universal-streaming\n\n@default false",
+ "example": false
+ },
+ "formatTurns": {
+ "type": "boolean",
+ "description": "This enables formatting of transcripts. Only used when `enableUniversalStreamingApi` is true.\n\n@default false",
+ "example": false
+ },
+ "endOfTurnConfidenceThreshold": {
+ "type": "number",
+ "description": "The confidence threshold to use when determining if the end of a turn has been reached. Only used when `enableUniversalStreamingApi` is true.\n\n@default 0.7",
+ "minimum": 0,
+ "maximum": 1,
+ "example": 0.7
+ },
+ "minEndOfTurnSilenceWhenConfident": {
+ "type": "number",
+ "description": "The minimum amount of silence in milliseconds required to detect end of turn when confident. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160",
+ "minimum": 0,
+ "example": 160
+ },
+ "wordFinalizationMaxWaitTime": {
+ "type": "number",
+ "description": "The maximum wait time for word finalization. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160",
+ "minimum": 0,
+ "example": 160
+ },
+ "maxTurnSilence": {
+ "type": "number",
+ "description": "The maximum amount of silence in milliseconds allowed in a turn before end of turn is triggered. Only used when `enableUniversalStreamingApi` is true.\n\n@default 400",
+ "minimum": 0,
+ "example": 400
+ },
+ "realtimeUrl": {
+ "type": "string",
+ "description": "The WebSocket URL that the transcriber connects to."
+ },
+ "wordBoost": {
+ "description": "Add up to 2500 characters of custom vocabulary.",
"type": "array",
"items": {
- "type": "string"
+ "type": "string",
+ "maxLength": 2500
}
},
- "metadata": {
- "type": "object",
- "description": "This is a JSON object that will be added to the Langfuse trace. Traces can be enriched with metadata to better understand your users, application, and experiments. https://langfuse.com/docs/tracing-features/metadata\nBy default it includes the call metadata, assistant metadata, and assistant overrides."
+ "endUtteranceSilenceThreshold": {
+ "type": "number",
+ "description": "The duration of the end utterance silence threshold in milliseconds."
+ },
+ "disablePartialTranscripts": {
+ "type": "boolean",
+ "description": "Disable partial transcripts.\nSet to `true` to not receive partial transcripts. Defaults to `false`."
}
},
"required": [
- "provider",
- "tags"
+ "provider"
]
},
- "TextContent": {
+ "FallbackAzureSpeechTranscriber": {
"type": "object",
"properties": {
- "type": {
+ "provider": {
"type": "string",
+ "description": "This is the transcription provider that will be used.",
"enum": [
- "text"
+ "azure"
]
},
- "text": {
- "type": "string"
+ "language": {
+ "type": "string",
+ "description": "This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt",
+ "enum": [
+ "af-ZA",
+ "am-ET",
+ "ar-AE",
+ "ar-BH",
+ "ar-DZ",
+ "ar-EG",
+ "ar-IL",
+ "ar-IQ",
+ "ar-JO",
+ "ar-KW",
+ "ar-LB",
+ "ar-LY",
+ "ar-MA",
+ "ar-OM",
+ "ar-PS",
+ "ar-QA",
+ "ar-SA",
+ "ar-SY",
+ "ar-TN",
+ "ar-YE",
+ "az-AZ",
+ "bg-BG",
+ "bn-IN",
+ "bs-BA",
+ "ca-ES",
+ "cs-CZ",
+ "cy-GB",
+ "da-DK",
+ "de-AT",
+ "de-CH",
+ "de-DE",
+ "el-GR",
+ "en-AU",
+ "en-CA",
+ "en-GB",
+ "en-GH",
+ "en-HK",
+ "en-IE",
+ "en-IN",
+ "en-KE",
+ "en-NG",
+ "en-NZ",
+ "en-PH",
+ "en-SG",
+ "en-TZ",
+ "en-US",
+ "en-ZA",
+ "es-AR",
+ "es-BO",
+ "es-CL",
+ "es-CO",
+ "es-CR",
+ "es-CU",
+ "es-DO",
+ "es-EC",
+ "es-ES",
+ "es-GQ",
+ "es-GT",
+ "es-HN",
+ "es-MX",
+ "es-NI",
+ "es-PA",
+ "es-PE",
+ "es-PR",
+ "es-PY",
+ "es-SV",
+ "es-US",
+ "es-UY",
+ "es-VE",
+ "et-EE",
+ "eu-ES",
+ "fa-IR",
+ "fi-FI",
+ "fil-PH",
+ "fr-BE",
+ "fr-CA",
+ "fr-CH",
+ "fr-FR",
+ "ga-IE",
+ "gl-ES",
+ "gu-IN",
+ "he-IL",
+ "hi-IN",
+ "hr-HR",
+ "hu-HU",
+ "hy-AM",
+ "id-ID",
+ "is-IS",
+ "it-CH",
+ "it-IT",
+ "ja-JP",
+ "jv-ID",
+ "ka-GE",
+ "kk-KZ",
+ "km-KH",
+ "kn-IN",
+ "ko-KR",
+ "lo-LA",
+ "lt-LT",
+ "lv-LV",
+ "mk-MK",
+ "ml-IN",
+ "mn-MN",
+ "mr-IN",
+ "ms-MY",
+ "mt-MT",
+ "my-MM",
+ "nb-NO",
+ "ne-NP",
+ "nl-BE",
+ "nl-NL",
+ "pa-IN",
+ "pl-PL",
+ "ps-AF",
+ "pt-BR",
+ "pt-PT",
+ "ro-RO",
+ "ru-RU",
+ "si-LK",
+ "sk-SK",
+ "sl-SI",
+ "so-SO",
+ "sq-AL",
+ "sr-RS",
+ "sv-SE",
+ "sw-KE",
+ "sw-TZ",
+ "ta-IN",
+ "te-IN",
+ "th-TH",
+ "tr-TR",
+ "uk-UA",
+ "ur-IN",
+ "uz-UZ",
+ "vi-VN",
+ "wuu-CN",
+ "yue-CN",
+ "zh-CN",
+ "zh-CN-shandong",
+ "zh-CN-sichuan",
+ "zh-HK",
+ "zh-TW",
+ "zu-ZA"
+ ]
+ }
+ },
+ "required": [
+ "provider"
+ ]
+ },
+ "FallbackCartesiaTranscriber": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "cartesia"
+ ]
+ },
+ "model": {
+ "type": "string",
+ "enum": [
+ "ink-whisper"
+ ]
},
"language": {
"type": "string",
@@ -7438,1061 +8299,1368 @@
}
},
"required": [
- "type",
- "text",
- "language"
+ "provider"
]
},
- "Condition": {
+ "FallbackCustomTranscriber": {
"type": "object",
"properties": {
- "operator": {
+ "provider": {
"type": "string",
- "description": "This is the operator you want to use to compare the parameter and value.",
+ "description": "This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported.",
"enum": [
- "eq",
- "neq",
- "gt",
- "gte",
- "lt",
- "lte"
+ "custom-transcriber"
]
},
- "param": {
- "type": "string",
- "description": "This is the name of the parameter that you want to check.",
- "maxLength": 1000
- },
- "value": {
- "type": "object",
- "description": "This is the value you want to compare against the parameter.",
- "maxLength": 1000
+ "server": {
+ "description": "This is where the transcription request will be sent.\n\nUsage:\n1. Vapi will initiate a websocket connection with `server.url`.\n\n2. Vapi will send an initial text frame with the sample rate. Format:\n```\n {\n \"type\": \"start\",\n \"encoding\": \"linear16\", // 16-bit raw PCM format\n \"container\": \"raw\",\n \"sampleRate\": {{sampleRate}},\n \"channels\": 2 // customer is channel 0, assistant is channel 1\n }\n```\n\n3. Vapi will send the audio data in 16-bit raw PCM format as binary frames.\n\n4. You can read the messages something like this:\n```\nws.on('message', (data, isBinary) => {\n if (isBinary) {\n pcmBuffer = Buffer.concat([pcmBuffer, data]);\n console.log(`Received PCM data, buffer size: ${pcmBuffer.length}`);\n } else {\n console.log('Received message:', JSON.parse(data.toString()));\n }\n});\n```\n\n5. You will respond with transcriptions as you have them. Format:\n```\n {\n \"type\": \"transcriber-response\",\n \"transcription\": \"Hello, world!\",\n \"channel\": \"customer\" | \"assistant\"\n }\n```",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
}
},
"required": [
- "operator",
- "param",
- "value"
+ "provider",
+ "server"
]
},
- "ToolMessageStart": {
+ "FallbackDeepgramTranscriber": {
"type": "object",
"properties": {
- "contents": {
- "type": "array",
- "description": "This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/TextContent",
- "title": "Text"
- }
- ]
- }
+ "provider": {
+ "type": "string",
+ "description": "This is the transcription provider that will be used.",
+ "enum": [
+ "deepgram"
+ ]
},
- "type": {
+ "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",
+ "oneOf": [
+ {
+ "type": "string",
+ "enum": [
+ "nova-3",
+ "nova-3-general",
+ "nova-3-medical",
+ "nova-2",
+ "nova-2-general",
+ "nova-2-meeting",
+ "nova-2-phonecall",
+ "nova-2-finance",
+ "nova-2-conversationalai",
+ "nova-2-voicemail",
+ "nova-2-video",
+ "nova-2-medical",
+ "nova-2-drivethru",
+ "nova-2-automotive",
+ "nova",
+ "nova-general",
+ "nova-phonecall",
+ "nova-medical",
+ "enhanced",
+ "enhanced-general",
+ "enhanced-meeting",
+ "enhanced-phonecall",
+ "enhanced-finance",
+ "base",
+ "base-general",
+ "base-meeting",
+ "base-phonecall",
+ "base-finance",
+ "base-conversationalai",
+ "base-voicemail",
+ "base-video",
+ "whisper"
+ ]
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "language": {
"type": "string",
+ "description": "This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview",
"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."
+ "ar",
+ "az",
+ "ba",
+ "bg",
+ "br",
+ "ca",
+ "cs",
+ "da",
+ "da-DK",
+ "de",
+ "de-CH",
+ "el",
+ "en",
+ "en-AU",
+ "en-GB",
+ "en-IN",
+ "en-NZ",
+ "en-US",
+ "es",
+ "es-419",
+ "es-LATAM",
+ "et",
+ "eu",
+ "fi",
+ "fr",
+ "fr-CA",
+ "ha",
+ "haw",
+ "he",
+ "hi",
+ "hi-Latn",
+ "hu",
+ "id",
+ "is",
+ "it",
+ "ja",
+ "jw",
+ "kn",
+ "ko",
+ "ko-KR",
+ "ln",
+ "lt",
+ "lv",
+ "mk",
+ "ms",
+ "multi",
+ "nl",
+ "nl-BE",
+ "no",
+ "pl",
+ "pt",
+ "pt-BR",
+ "ro",
+ "ru",
+ "sk",
+ "sl",
+ "sn",
+ "so",
+ "sr",
+ "su",
+ "sv",
+ "sv-SE",
+ "ta",
+ "taq",
+ "th",
+ "th-TH",
+ "tr",
+ "tt",
+ "uk",
+ "ur",
+ "vi",
+ "yo",
+ "zh",
+ "zh-CN",
+ "zh-HK",
+ "zh-Hans",
+ "zh-Hant",
+ "zh-TW"
+ ]
},
- "blocking": {
+ "smartFormat": {
"type": "boolean",
- "description": "This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false",
+ "description": "This will be use smart format option provided by Deepgram. It's default disabled because it can sometimes format numbers as times but it's getting better.",
+ "example": false
+ },
+ "codeSwitchingEnabled": {
+ "type": "boolean",
+ "description": "This automatically switches the transcriber's language when the customer's language changes. Defaults to false.\n\nUsage:\n- If your customers switch languages mid-call, you can set this to true.\n\nNote:\n- To detect language changes, Vapi uses a custom trained model. Languages supported (X = limited support):\n 1. Arabic\n 2. Bengali\n 3. Cantonese\n 4. Chinese\n 5. Chinese Simplified (X)\n 6. Chinese Traditional (X)\n 7. English\n 8. Farsi (X)\n 9. French\n 10. German\n 11. Haitian Creole (X)\n 12. Hindi\n 13. Italian\n 14. Japanese\n 15. Korean\n 16. Portuguese\n 17. Russian\n 18. Spanish\n 19. Thai\n 20. Urdu\n 21. Vietnamese\n- To receive `language-change-detected` webhook events, add it to `assistant.serverMessages`.\n\n@default false",
+ "example": false
+ },
+ "mipOptOut": {
+ "type": "boolean",
+ "description": "If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false",
"example": false,
"default": false
},
- "content": {
- "type": "string",
- "description": "This is the content that the assistant says when this message is triggered.",
- "maxLength": 1000
+ "numerals": {
+ "type": "boolean",
+ "description": "If set to true, this will cause deepgram to convert spoken numbers to literal numerals. For example, \"my phone number is nine-seven-two...\" would become \"my phone number is 972...\"\n\n@default false",
+ "example": false
},
- "conditions": {
- "description": "This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.",
+ "confidenceThreshold": {
+ "type": "number",
+ "description": "Transcripts below this confidence threshold will be discarded.\n\n@default 0.4",
+ "minimum": 0,
+ "maximum": 1,
+ "example": 0.4
+ },
+ "keywords": {
+ "description": "These keywords are passed to the transcription model to help it pick up use-case specific words. Anything that may not be a common word, like your company name, should be added here.",
"type": "array",
"items": {
- "$ref": "#/components/schemas/Condition"
+ "type": "string",
+ "pattern": "/^\\p{L}[\\p{L}\\d]*(?::[+-]?\\d+)?$/u"
+ }
+ },
+ "keyterm": {
+ "description": "Keyterm Prompting allows you improve Keyword Recall Rate (KRR) for important keyterms or phrases up to 90%.",
+ "type": "array",
+ "items": {
+ "type": "string"
}
+ },
+ "endpointing": {
+ "type": "number",
+ "description": "This is the timeout after which Deepgram will send transcription on user silence. You can read in-depth documentation here: https://developers.deepgram.com/docs/endpointing.\n\nHere are the most important bits:\n- Defaults to 10. This is recommended for most use cases to optimize for latency.\n- 10 can cause some missing transcriptions since because of the shorter context. This mostly happens for one-word utterances. For those uses cases, it's recommended to try 300. It will add a bit of latency but the quality and reliability of the experience will be better.\n- If neither 10 nor 300 work, contact support@vapi.ai and we'll find another solution.\n\n@default 10",
+ "minimum": 10,
+ "maximum": 500
}
},
"required": [
- "type"
- ]
- },
- "ToolMessageComplete": {
- "type": "object",
- "properties": {
- "contents": {
- "type": "array",
- "description": "This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/TextContent",
- "title": "Text"
- }
- ]
- }
- },
- "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"
- ]
- },
- "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 <--- 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"
- ]
- },
- "endCallAfterSpokenEnabled": {
- "type": "boolean",
- "description": "This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false",
- "example": false
- },
- "content": {
- "type": "string",
- "description": "This is the content that the assistant says when this message is triggered.",
- "maxLength": 1000
- },
- "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"
- }
- }
- },
- "required": [
- "type"
+ "provider"
]
},
- "ToolMessageFailed": {
+ "FallbackElevenLabsTranscriber": {
"type": "object",
"properties": {
- "contents": {
- "type": "array",
- "description": "This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/TextContent",
- "title": "Text"
- }
- ]
- }
- },
- "type": {
+ "provider": {
"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.",
+ "description": "This is the transcription provider that will be used.",
"enum": [
- "request-failed"
+ "11labs"
]
},
- "endCallAfterSpokenEnabled": {
- "type": "boolean",
- "description": "This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false",
- "example": false
- },
- "content": {
- "type": "string",
- "description": "This is the content that the assistant says when this message is triggered.",
- "maxLength": 1000
- },
- "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"
- }
- }
- },
- "required": [
- "type"
- ]
- },
- "ToolMessageDelayed": {
- "type": "object",
- "properties": {
- "contents": {
- "type": "array",
- "description": "This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/TextContent",
- "title": "Text"
- }
- ]
- }
- },
- "type": {
+ "model": {
"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.",
+ "description": "This is the model that will be used for the transcription.",
"enum": [
- "request-response-delayed"
+ "scribe_v1"
]
},
- "timingMilliseconds": {
- "type": "number",
- "minimum": 100,
- "maximum": 120000,
- "example": 1000,
- "description": "The number of milliseconds to wait for the server response before saying this message."
- },
- "content": {
- "type": "string",
- "description": "This is the content that the assistant says when this message is triggered.",
- "maxLength": 1000
- },
- "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"
- }
- }
- },
- "required": [
- "type"
- ]
- },
- "JsonSchema": {
- "type": "object",
- "properties": {
- "type": {
+ "language": {
"type": "string",
- "description": "This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.",
"enum": [
- "string",
- "number",
- "integer",
- "boolean",
- "array",
- "object"
+ "aa",
+ "ab",
+ "ae",
+ "af",
+ "ak",
+ "am",
+ "an",
+ "ar",
+ "as",
+ "av",
+ "ay",
+ "az",
+ "ba",
+ "be",
+ "bg",
+ "bh",
+ "bi",
+ "bm",
+ "bn",
+ "bo",
+ "br",
+ "bs",
+ "ca",
+ "ce",
+ "ch",
+ "co",
+ "cr",
+ "cs",
+ "cu",
+ "cv",
+ "cy",
+ "da",
+ "de",
+ "dv",
+ "dz",
+ "ee",
+ "el",
+ "en",
+ "eo",
+ "es",
+ "et",
+ "eu",
+ "fa",
+ "ff",
+ "fi",
+ "fj",
+ "fo",
+ "fr",
+ "fy",
+ "ga",
+ "gd",
+ "gl",
+ "gn",
+ "gu",
+ "gv",
+ "ha",
+ "he",
+ "hi",
+ "ho",
+ "hr",
+ "ht",
+ "hu",
+ "hy",
+ "hz",
+ "ia",
+ "id",
+ "ie",
+ "ig",
+ "ii",
+ "ik",
+ "io",
+ "is",
+ "it",
+ "iu",
+ "ja",
+ "jv",
+ "ka",
+ "kg",
+ "ki",
+ "kj",
+ "kk",
+ "kl",
+ "km",
+ "kn",
+ "ko",
+ "kr",
+ "ks",
+ "ku",
+ "kv",
+ "kw",
+ "ky",
+ "la",
+ "lb",
+ "lg",
+ "li",
+ "ln",
+ "lo",
+ "lt",
+ "lu",
+ "lv",
+ "mg",
+ "mh",
+ "mi",
+ "mk",
+ "ml",
+ "mn",
+ "mr",
+ "ms",
+ "mt",
+ "my",
+ "na",
+ "nb",
+ "nd",
+ "ne",
+ "ng",
+ "nl",
+ "nn",
+ "no",
+ "nr",
+ "nv",
+ "ny",
+ "oc",
+ "oj",
+ "om",
+ "or",
+ "os",
+ "pa",
+ "pi",
+ "pl",
+ "ps",
+ "pt",
+ "qu",
+ "rm",
+ "rn",
+ "ro",
+ "ru",
+ "rw",
+ "sa",
+ "sc",
+ "sd",
+ "se",
+ "sg",
+ "si",
+ "sk",
+ "sl",
+ "sm",
+ "sn",
+ "so",
+ "sq",
+ "sr",
+ "ss",
+ "st",
+ "su",
+ "sv",
+ "sw",
+ "ta",
+ "te",
+ "tg",
+ "th",
+ "ti",
+ "tk",
+ "tl",
+ "tn",
+ "to",
+ "tr",
+ "ts",
+ "tt",
+ "tw",
+ "ty",
+ "ug",
+ "uk",
+ "ur",
+ "uz",
+ "ve",
+ "vi",
+ "vo",
+ "wa",
+ "wo",
+ "xh",
+ "yi",
+ "yue",
+ "yo",
+ "za",
+ "zh",
+ "zu"
]
- },
- "items": {
- "type": "object",
- "description": "This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references."
- },
- "properties": {
- "type": "object",
- "description": "This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references."
- },
- "description": {
- "type": "string",
- "description": "This is the description to help the model understand what it needs to output."
- },
- "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"
- }
- },
- "regex": {
- "type": "string",
- "description": "This is a regex that will be used to validate data in question."
- },
- "value": {
- "type": "string",
- "description": "This the value that will be used in filling the property."
- },
- "target": {
- "type": "string",
- "description": "This the target variable that will be filled with the value of this property."
- },
- "enum": {
- "description": "This array specifies the allowed values that can be used to restrict the output of the model.",
- "type": "array",
- "items": {
- "type": "string"
- }
}
},
"required": [
- "type"
+ "provider"
]
},
- "OpenAIFunctionParameters": {
+ "FallbackGladiaTranscriber": {
"type": "object",
"properties": {
- "type": {
+ "provider": {
"type": "string",
- "description": "This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.",
+ "description": "This is the transcription provider that will be used.",
"enum": [
- "object"
- ]
- },
- "properties": {
- "type": "object",
- "description": "This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.",
- "additionalProperties": {
- "$ref": "#/components/schemas/JsonSchema"
- }
- },
- "required": {
- "description": "This specifies the properties that are required by the function.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": [
- "type",
- "properties"
- ]
- },
- "OpenAIFunction": {
- "type": "object",
- "properties": {
- "strict": {
- "type": "boolean",
- "description": "This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false",
- "default": false
- },
- "name": {
- "type": "string",
- "description": "This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.",
- "maxLength": 64,
- "pattern": "/^[a-zA-Z0-9_-]{1,64}$/"
- },
- "description": {
- "type": "string",
- "description": "This is the description of what the function does, used by the AI to choose when and how to call the function.",
- "maxLength": 1000
- },
- "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"
- }
+ "gladia"
]
- }
- },
- "required": [
- "name"
- ]
- },
- "CreateDtmfToolDTO": {
- "type": "object",
- "properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
- "type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
- },
- {
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
- },
- {
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
- },
- {
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "dtmf"
- ],
- "description": "The type of tool. \"dtmf\" for DTMF tool."
},
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "allOf": [
+ "model": {
+ "description": "This is the Gladia model that will be used. Default is 'fast'",
+ "oneOf": [
{
- "$ref": "#/components/schemas/OpenAIFunction"
+ "enum": [
+ "fast",
+ "accurate",
+ "solaria-1"
+ ]
}
]
},
- "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": [
+ "languageBehaviour": {
+ "description": "Defines how the transcription model detects the audio language. Default value is 'automatic single language'.",
+ "oneOf": [
{
- "$ref": "#/components/schemas/Server"
+ "type": "string",
+ "enum": [
+ "manual",
+ "automatic single language",
+ "automatic multiple languages"
+ ]
}
]
- }
- },
- "required": [
- "type"
- ]
- },
- "CreateEndCallToolDTO": {
- "type": "object",
- "properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
},
- "messages": {
- "type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
- },
- {
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
- },
- {
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
- },
- {
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
- },
- "type": {
+ "language": {
"type": "string",
+ "description": "Defines the language to use for the transcription. Required when languageBehaviour is 'manual'.",
"enum": [
- "endCall"
- ],
- "description": "The type of tool. \"endCall\" for End Call tool."
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "allOf": [
- {
- "$ref": "#/components/schemas/OpenAIFunction"
- }
+ "af",
+ "sq",
+ "am",
+ "ar",
+ "hy",
+ "as",
+ "az",
+ "ba",
+ "eu",
+ "be",
+ "bn",
+ "bs",
+ "br",
+ "bg",
+ "ca",
+ "zh",
+ "hr",
+ "cs",
+ "da",
+ "nl",
+ "en",
+ "et",
+ "fo",
+ "fi",
+ "fr",
+ "gl",
+ "ka",
+ "de",
+ "el",
+ "gu",
+ "ht",
+ "ha",
+ "haw",
+ "he",
+ "hi",
+ "hu",
+ "is",
+ "id",
+ "it",
+ "ja",
+ "jv",
+ "kn",
+ "kk",
+ "km",
+ "ko",
+ "lo",
+ "la",
+ "lv",
+ "ln",
+ "lt",
+ "lb",
+ "mk",
+ "mg",
+ "ms",
+ "ml",
+ "mt",
+ "mi",
+ "mr",
+ "mn",
+ "my",
+ "ne",
+ "no",
+ "nn",
+ "oc",
+ "ps",
+ "fa",
+ "pl",
+ "pt",
+ "pa",
+ "ro",
+ "ru",
+ "sa",
+ "sr",
+ "sn",
+ "sd",
+ "si",
+ "sk",
+ "sl",
+ "so",
+ "es",
+ "su",
+ "sw",
+ "sv",
+ "tl",
+ "tg",
+ "ta",
+ "tt",
+ "te",
+ "th",
+ "bo",
+ "tr",
+ "tk",
+ "uk",
+ "ur",
+ "uz",
+ "vi",
+ "cy",
+ "yi",
+ "yo"
]
},
- "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"
- }
+ "languages": {
+ "type": "string",
+ "description": "Defines the languages to use for the transcription. Required when languageBehaviour is 'manual'.",
+ "enum": [
+ "af",
+ "sq",
+ "am",
+ "ar",
+ "hy",
+ "as",
+ "az",
+ "ba",
+ "eu",
+ "be",
+ "bn",
+ "bs",
+ "br",
+ "bg",
+ "ca",
+ "zh",
+ "hr",
+ "cs",
+ "da",
+ "nl",
+ "en",
+ "et",
+ "fo",
+ "fi",
+ "fr",
+ "gl",
+ "ka",
+ "de",
+ "el",
+ "gu",
+ "ht",
+ "ha",
+ "haw",
+ "he",
+ "hi",
+ "hu",
+ "is",
+ "id",
+ "it",
+ "ja",
+ "jv",
+ "kn",
+ "kk",
+ "km",
+ "ko",
+ "lo",
+ "la",
+ "lv",
+ "ln",
+ "lt",
+ "lb",
+ "mk",
+ "mg",
+ "ms",
+ "ml",
+ "mt",
+ "mi",
+ "mr",
+ "mn",
+ "my",
+ "ne",
+ "no",
+ "nn",
+ "oc",
+ "ps",
+ "fa",
+ "pl",
+ "pt",
+ "pa",
+ "ro",
+ "ru",
+ "sa",
+ "sr",
+ "sn",
+ "sd",
+ "si",
+ "sk",
+ "sl",
+ "so",
+ "es",
+ "su",
+ "sw",
+ "sv",
+ "tl",
+ "tg",
+ "ta",
+ "tt",
+ "te",
+ "th",
+ "bo",
+ "tr",
+ "tk",
+ "uk",
+ "ur",
+ "uz",
+ "vi",
+ "cy",
+ "yi",
+ "yo"
]
- }
- },
- "required": [
- "type"
- ]
- },
- "CreateVoicemailToolDTO": {
- "type": "object",
- "properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
- "type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
- },
- {
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
- },
- {
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
- },
- {
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
},
- "type": {
+ "transcriptionHint": {
"type": "string",
- "enum": [
- "voicemail"
- ],
- "description": "The type of tool. \"voicemail\". This uses the model itself to determine if a voicemil was reached. Can be used alternatively/alongside with TwilioVoicemailDetection"
+ "description": "Provides a custom vocabulary to the model to improve accuracy of transcribing context specific words, technical terms, names, etc. If empty, this argument is ignored.\n⚠️ Warning ⚠️: Please be aware that the transcription_hint field has a character limit of 600. If you provide a transcription_hint longer than 600 characters, it will be automatically truncated to meet this limit.",
+ "maxLength": 600,
+ "example": "custom vocabulary"
},
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "allOf": [
- {
- "$ref": "#/components/schemas/OpenAIFunction"
- }
- ]
+ "prosody": {
+ "type": "boolean",
+ "description": "If prosody is true, you will get a transcription that can contain prosodies i.e. (laugh) (giggles) (malefic laugh) (toss) (music)… Default value is false.",
+ "example": false
},
- "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"
- }
- ]
+ "audioEnhancer": {
+ "type": "boolean",
+ "description": "If true, audio will be pre-processed to improve accuracy but latency will increase. Default value is false.",
+ "example": false
+ },
+ "confidenceThreshold": {
+ "type": "number",
+ "description": "Transcripts below this confidence threshold will be discarded.\n\n@default 0.4",
+ "minimum": 0,
+ "maximum": 1,
+ "example": 0.4
}
},
"required": [
- "type"
+ "provider"
]
},
- "CreateFunctionToolDTO": {
+ "FallbackSpeechmaticsTranscriber": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
- "type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
- },
- {
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
- },
- {
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
- },
- {
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
- },
- "type": {
+ "provider": {
"type": "string",
+ "description": "This is the transcription provider that will be used.",
"enum": [
- "function"
- ],
- "description": "The type of tool. \"function\" for Function tool."
+ "speechmatics"
+ ]
},
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "allOf": [
- {
- "$ref": "#/components/schemas/OpenAIFunction"
- }
+ "model": {
+ "type": "string",
+ "description": "This is the model that will be used for the transcription.",
+ "enum": [
+ "default"
]
},
- "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"
- }
+ "language": {
+ "type": "string",
+ "enum": [
+ "auto",
+ "ar",
+ "ba",
+ "eu",
+ "be",
+ "bn",
+ "bg",
+ "yue",
+ "ca",
+ "hr",
+ "cs",
+ "da",
+ "nl",
+ "en",
+ "eo",
+ "et",
+ "fi",
+ "fr",
+ "gl",
+ "de",
+ "el",
+ "he",
+ "hi",
+ "hu",
+ "id",
+ "ia",
+ "ga",
+ "it",
+ "ja",
+ "ko",
+ "lv",
+ "lt",
+ "ms",
+ "mt",
+ "cmn",
+ "mr",
+ "mn",
+ "no",
+ "fa",
+ "pl",
+ "pt",
+ "ro",
+ "ru",
+ "sk",
+ "sl",
+ "es",
+ "sw",
+ "sv",
+ "ta",
+ "th",
+ "tr",
+ "uk",
+ "ur",
+ "ug",
+ "vi",
+ "cy"
]
}
},
"required": [
- "type"
+ "provider"
]
},
- "GhlToolMetadata": {
- "type": "object",
- "properties": {
- "workflowId": {
- "type": "string"
- },
- "locationId": {
- "type": "string"
- }
- }
- },
- "CreateGhlToolDTO": {
+ "FallbackTalkscriberTranscriber": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
- "type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
- },
- {
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
- },
- {
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
- },
- {
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
- },
- "type": {
+ "provider": {
"type": "string",
+ "description": "This is the transcription provider that will be used.",
"enum": [
- "ghl"
- ],
- "description": "The type of tool. \"ghl\" for GHL tool."
- },
- "metadata": {
- "$ref": "#/components/schemas/GhlToolMetadata"
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "allOf": [
- {
- "$ref": "#/components/schemas/OpenAIFunction"
- }
+ "talkscriber"
]
},
- "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"
- }
+ "model": {
+ "type": "string",
+ "description": "This is the model that will be used for the transcription.",
+ "enum": [
+ "whisper"
]
- }
- },
- "required": [
- "type",
- "metadata"
- ]
- },
- "MakeToolMetadata": {
- "type": "object",
- "properties": {
- "scenarioId": {
- "type": "number"
},
- "triggerHookId": {
- "type": "number"
- }
- }
- },
- "CreateMakeToolDTO": {
- "type": "object",
- "properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
- "type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
- },
- {
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
- },
- {
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
- },
- {
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
- },
- "type": {
+ "language": {
"type": "string",
+ "description": "This is the language that will be set for the transcription. The list of languages Whisper supports can be found here: https://github.com/openai/whisper/blob/main/whisper/tokenizer.py",
"enum": [
- "make"
- ],
- "description": "The type of tool. \"make\" for Make tool."
- },
- "metadata": {
- "$ref": "#/components/schemas/MakeToolMetadata"
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "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"
- }
+ "en",
+ "zh",
+ "de",
+ "es",
+ "ru",
+ "ko",
+ "fr",
+ "ja",
+ "pt",
+ "tr",
+ "pl",
+ "ca",
+ "nl",
+ "ar",
+ "sv",
+ "it",
+ "id",
+ "hi",
+ "fi",
+ "vi",
+ "he",
+ "uk",
+ "el",
+ "ms",
+ "cs",
+ "ro",
+ "da",
+ "hu",
+ "ta",
+ "no",
+ "th",
+ "ur",
+ "hr",
+ "bg",
+ "lt",
+ "la",
+ "mi",
+ "ml",
+ "cy",
+ "sk",
+ "te",
+ "fa",
+ "lv",
+ "bn",
+ "sr",
+ "az",
+ "sl",
+ "kn",
+ "et",
+ "mk",
+ "br",
+ "eu",
+ "is",
+ "hy",
+ "ne",
+ "mn",
+ "bs",
+ "kk",
+ "sq",
+ "sw",
+ "gl",
+ "mr",
+ "pa",
+ "si",
+ "km",
+ "sn",
+ "yo",
+ "so",
+ "af",
+ "oc",
+ "ka",
+ "be",
+ "tg",
+ "sd",
+ "gu",
+ "am",
+ "yi",
+ "lo",
+ "uz",
+ "fo",
+ "ht",
+ "ps",
+ "tk",
+ "nn",
+ "mt",
+ "sa",
+ "lb",
+ "my",
+ "bo",
+ "tl",
+ "mg",
+ "as",
+ "tt",
+ "haw",
+ "ln",
+ "ha",
+ "ba",
+ "jw",
+ "su",
+ "yue"
]
}
},
"required": [
- "type",
- "metadata"
+ "provider"
]
},
- "CustomMessage": {
+ "FallbackGoogleTranscriber": {
"type": "object",
"properties": {
- "contents": {
- "type": "array",
- "description": "This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/TextContent",
- "title": "Text"
- }
- ]
- }
- },
- "type": {
+ "provider": {
"type": "string",
- "description": "This is a custom message.",
+ "description": "This is the transcription provider that will be used.",
"enum": [
- "custom-message"
- ]
- },
- "content": {
- "type": "string",
- "description": "This is the content that the assistant will say when this message is triggered.",
- "maxLength": 1000
- }
- },
- "required": [
- "type"
- ]
- },
- "TransferDestinationAssistant": {
- "type": "object",
- "properties": {
- "message": {
- "description": "This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.",
- "oneOf": [
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/CustomMessage"
- }
+ "google"
]
},
- "type": {
+ "model": {
"type": "string",
+ "description": "This is the model that will be used for the transcription.",
"enum": [
- "assistant"
+ "gemini-2.5-pro-preview-05-06",
+ "gemini-2.5-flash-preview-05-20",
+ "gemini-2.5-flash-preview-04-17",
+ "gemini-2.0-flash-thinking-exp",
+ "gemini-2.0-pro-exp-02-05",
+ "gemini-2.0-flash",
+ "gemini-2.0-flash-lite",
+ "gemini-2.0-flash-lite-preview-02-05",
+ "gemini-2.0-flash-exp",
+ "gemini-2.0-flash-realtime-exp",
+ "gemini-1.5-flash",
+ "gemini-1.5-flash-002",
+ "gemini-1.5-pro",
+ "gemini-1.5-pro-002",
+ "gemini-1.0-pro"
]
},
- "transferMode": {
+ "language": {
"type": "string",
- "description": "This is the mode to use for the transfer. Defaults to `rolling-history`.\n\n- `rolling-history`: This is the default mode. It keeps the entire conversation history and appends the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n system: assistant2 system message\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `swap-system-message-in-history`: This replaces the original system message with the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `delete-history`: This deletes the entire conversation history on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant2 first message\n user: Yes, please\n assistant: how can i help?\n user: i need help with my account\n\n- `swap-system-message-in-history-and-remove-transfer-tool-messages`: This replaces the original system message with the new assistant's system message on transfer and removes transfer tool messages from conversation history sent to the LLM.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n transfer-tool\n transfer-tool-result\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n@default 'rolling-history'",
+ "description": "This is the language that will be set for the transcription.",
"enum": [
- "rolling-history",
- "swap-system-message-in-history",
- "swap-system-message-in-history-and-remove-transfer-tool-messages",
- "delete-history"
+ "Multilingual",
+ "Arabic",
+ "Bengali",
+ "Bulgarian",
+ "Chinese",
+ "Croatian",
+ "Czech",
+ "Danish",
+ "Dutch",
+ "English",
+ "Estonian",
+ "Finnish",
+ "French",
+ "German",
+ "Greek",
+ "Hebrew",
+ "Hindi",
+ "Hungarian",
+ "Indonesian",
+ "Italian",
+ "Japanese",
+ "Korean",
+ "Latvian",
+ "Lithuanian",
+ "Norwegian",
+ "Polish",
+ "Portuguese",
+ "Romanian",
+ "Russian",
+ "Serbian",
+ "Slovak",
+ "Slovenian",
+ "Spanish",
+ "Swahili",
+ "Swedish",
+ "Thai",
+ "Turkish",
+ "Ukrainian",
+ "Vietnamese"
]
- },
- "assistantName": {
- "type": "string",
- "description": "This is the assistant to transfer the call to."
- },
- "description": {
- "type": "string",
- "description": "This is the description of the destination, used by the AI to choose when and how to transfer the call."
}
},
"required": [
- "type",
- "assistantName"
+ "provider"
]
},
- "TransferDestinationStep": {
+ "FallbackOpenAITranscriber": {
"type": "object",
"properties": {
- "message": {
- "description": "This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.",
- "oneOf": [
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/CustomMessage"
- }
- ]
- },
- "type": {
+ "provider": {
"type": "string",
+ "description": "This is the transcription provider that will be used.",
"enum": [
- "step"
+ "openai"
]
},
- "stepName": {
+ "model": {
"type": "string",
- "description": "This is the step to transfer to."
+ "description": "This is the model that will be used for the transcription.",
+ "enum": [
+ "gpt-4o-transcribe",
+ "gpt-4o-mini-transcribe"
+ ]
},
- "description": {
+ "language": {
"type": "string",
- "description": "This is the description of the destination, used by the AI to choose when and how to transfer the call."
+ "description": "This is the language that will be set for the transcription.",
+ "enum": [
+ "af",
+ "ar",
+ "hy",
+ "az",
+ "be",
+ "bs",
+ "bg",
+ "ca",
+ "zh",
+ "hr",
+ "cs",
+ "da",
+ "nl",
+ "en",
+ "et",
+ "fi",
+ "fr",
+ "gl",
+ "de",
+ "el",
+ "he",
+ "hi",
+ "hu",
+ "is",
+ "id",
+ "it",
+ "ja",
+ "kn",
+ "kk",
+ "ko",
+ "lv",
+ "lt",
+ "mk",
+ "ms",
+ "mr",
+ "mi",
+ "ne",
+ "no",
+ "fa",
+ "pl",
+ "pt",
+ "ro",
+ "ru",
+ "sr",
+ "sk",
+ "sl",
+ "es",
+ "sw",
+ "sv",
+ "tl",
+ "ta",
+ "th",
+ "tr",
+ "uk",
+ "ur",
+ "vi",
+ "cy"
+ ]
}
},
"required": [
- "type",
- "stepName"
+ "provider",
+ "model"
]
},
- "SummaryPlan": {
- "type": "object",
- "properties": {
- "messages": {
- "description": "These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript`- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content`",
- "type": "array",
- "items": {
- "type": "object"
- }
- },
- "enabled": {
- "type": "boolean",
- "description": "This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true"
- },
- "timeoutSeconds": {
- "type": "number",
- "description": "This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds",
- "minimum": 1,
- "maximum": 60
- }
- }
- },
- "TransferPlan": {
+ "LangfuseObservabilityPlan": {
"type": "object",
"properties": {
- "mode": {
+ "provider": {
"type": "string",
- "description": "This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n\n@default 'blind-transfer'",
"enum": [
- "blind-transfer",
- "blind-transfer-add-summary-to-sip-header",
- "warm-transfer-say-message",
- "warm-transfer-say-summary",
- "warm-transfer-twiml",
- "warm-transfer-wait-for-operator-to-speak-first-and-then-say-message",
- "warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary"
+ "langfuse"
]
},
- "message": {
- "description": "This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`.",
- "oneOf": [
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/CustomMessage"
- }
- ]
+ "tags": {
+ "description": "This is an array of tags to be added to the Langfuse trace. Tags allow you to categorize and filter traces. https://langfuse.com/docs/tracing-features/tags",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
},
- "sipVerb": {
+ "metadata": {
"type": "object",
- "description": "This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call",
- "default": "refer",
- "enum": [
- "refer",
- "bye",
- "dial"
- ]
- },
- "twiml": {
- "type": "string",
- "description": "This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\nHello, transferring a customer to you.\n\nThey called about billing questions.\n```",
- "maxLength": 4096
- },
- "summaryPlan": {
- "description": "This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`.",
- "allOf": [
- {
- "$ref": "#/components/schemas/SummaryPlan"
- }
- ]
+ "description": "This is a JSON object that will be added to the Langfuse trace. Traces can be enriched with metadata to better understand your users, application, and experiments. https://langfuse.com/docs/tracing-features/metadata\nBy default it includes the call metadata, assistant metadata, and assistant overrides."
}
},
"required": [
- "mode"
+ "provider",
+ "tags"
]
},
- "TransferDestinationNumber": {
+ "TextContent": {
"type": "object",
"properties": {
- "message": {
- "description": "This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.",
- "oneOf": [
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/CustomMessage"
- }
- ]
- },
"type": {
"type": "string",
"enum": [
- "number"
- ]
- },
- "numberE164CheckEnabled": {
- "type": "boolean",
- "description": "This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)",
- "default": true
- },
- "number": {
- "type": "string",
- "description": "This is the phone number to transfer the call to.",
- "minLength": 3,
- "maxLength": 40
- },
- "extension": {
- "type": "string",
- "description": "This is the extension to dial after transferring the call to the `number`.",
- "minLength": 1,
- "maxLength": 10
- },
- "callerId": {
- "type": "string",
- "description": "This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid",
- "maxLength": 40
- },
- "transferPlan": {
- "description": "This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`",
- "allOf": [
- {
- "$ref": "#/components/schemas/TransferPlan"
- }
+ "text"
]
},
- "description": {
- "type": "string",
- "description": "This is the description of the destination, used by the AI to choose when and how to transfer the call."
- }
- },
- "required": [
- "type",
- "number"
- ]
- },
- "TransferDestinationSip": {
- "type": "object",
- "properties": {
- "message": {
- "description": "This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.",
- "oneOf": [
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/CustomMessage"
- }
- ]
+ "text": {
+ "type": "string"
},
- "type": {
+ "language": {
"type": "string",
"enum": [
- "sip"
- ]
- },
- "sipUri": {
+ "aa",
+ "ab",
+ "ae",
+ "af",
+ "ak",
+ "am",
+ "an",
+ "ar",
+ "as",
+ "av",
+ "ay",
+ "az",
+ "ba",
+ "be",
+ "bg",
+ "bh",
+ "bi",
+ "bm",
+ "bn",
+ "bo",
+ "br",
+ "bs",
+ "ca",
+ "ce",
+ "ch",
+ "co",
+ "cr",
+ "cs",
+ "cu",
+ "cv",
+ "cy",
+ "da",
+ "de",
+ "dv",
+ "dz",
+ "ee",
+ "el",
+ "en",
+ "eo",
+ "es",
+ "et",
+ "eu",
+ "fa",
+ "ff",
+ "fi",
+ "fj",
+ "fo",
+ "fr",
+ "fy",
+ "ga",
+ "gd",
+ "gl",
+ "gn",
+ "gu",
+ "gv",
+ "ha",
+ "he",
+ "hi",
+ "ho",
+ "hr",
+ "ht",
+ "hu",
+ "hy",
+ "hz",
+ "ia",
+ "id",
+ "ie",
+ "ig",
+ "ii",
+ "ik",
+ "io",
+ "is",
+ "it",
+ "iu",
+ "ja",
+ "jv",
+ "ka",
+ "kg",
+ "ki",
+ "kj",
+ "kk",
+ "kl",
+ "km",
+ "kn",
+ "ko",
+ "kr",
+ "ks",
+ "ku",
+ "kv",
+ "kw",
+ "ky",
+ "la",
+ "lb",
+ "lg",
+ "li",
+ "ln",
+ "lo",
+ "lt",
+ "lu",
+ "lv",
+ "mg",
+ "mh",
+ "mi",
+ "mk",
+ "ml",
+ "mn",
+ "mr",
+ "ms",
+ "mt",
+ "my",
+ "na",
+ "nb",
+ "nd",
+ "ne",
+ "ng",
+ "nl",
+ "nn",
+ "no",
+ "nr",
+ "nv",
+ "ny",
+ "oc",
+ "oj",
+ "om",
+ "or",
+ "os",
+ "pa",
+ "pi",
+ "pl",
+ "ps",
+ "pt",
+ "qu",
+ "rm",
+ "rn",
+ "ro",
+ "ru",
+ "rw",
+ "sa",
+ "sc",
+ "sd",
+ "se",
+ "sg",
+ "si",
+ "sk",
+ "sl",
+ "sm",
+ "sn",
+ "so",
+ "sq",
+ "sr",
+ "ss",
+ "st",
+ "su",
+ "sv",
+ "sw",
+ "ta",
+ "te",
+ "tg",
+ "th",
+ "ti",
+ "tk",
+ "tl",
+ "tn",
+ "to",
+ "tr",
+ "ts",
+ "tt",
+ "tw",
+ "ty",
+ "ug",
+ "uk",
+ "ur",
+ "uz",
+ "ve",
+ "vi",
+ "vo",
+ "wa",
+ "wo",
+ "xh",
+ "yi",
+ "yue",
+ "yo",
+ "za",
+ "zh",
+ "zu"
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "text",
+ "language"
+ ]
+ },
+ "Condition": {
+ "type": "object",
+ "properties": {
+ "operator": {
"type": "string",
- "description": "This is the SIP URI to transfer the call to."
- },
- "transferPlan": {
- "description": "This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`",
- "allOf": [
- {
- "$ref": "#/components/schemas/TransferPlan"
- }
+ "description": "This is the operator you want to use to compare the parameter and value.",
+ "enum": [
+ "eq",
+ "neq",
+ "gt",
+ "gte",
+ "lt",
+ "lte"
]
},
- "sipHeaders": {
- "type": "object",
- "description": "These are custom headers to be added to SIP refer during transfer call."
+ "param": {
+ "type": "string",
+ "description": "This is the name of the parameter that you want to check.",
+ "maxLength": 1000
},
- "description": {
+ "value": {
"type": "string",
- "description": "This is the description of the destination, used by the AI to choose when and how to transfer the call."
+ "description": "This is the value you want to compare against the parameter.",
+ "maxLength": 1000
}
},
"required": [
- "type",
- "sipUri"
+ "operator",
+ "param",
+ "value"
]
},
- "CreateTransferCallToolDTO": {
+ "ToolMessageStart": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
+ "contents": {
"type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "description": "This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
- },
- {
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
- },
- {
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
- },
- {
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
+ "$ref": "#/components/schemas/TextContent",
+ "title": "Text"
}
]
}
@@ -8500,266 +9668,294 @@
"type": {
"type": "string",
"enum": [
- "transferCall"
- ]
+ "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."
},
- "destinations": {
+ "blocking": {
+ "type": "boolean",
+ "description": "This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false",
+ "example": false,
+ "default": false
+ },
+ "content": {
+ "type": "string",
+ "description": "This is the content that the assistant says when this message is triggered.",
+ "maxLength": 1000
+ },
+ "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",
- "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.",
"items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransferDestinationAssistant",
- "title": "Assistant"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationStep",
- "title": "Step"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationNumber",
- "title": "Number"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationSip",
- "title": "Sip"
- }
- ]
+ "$ref": "#/components/schemas/Condition"
}
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "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"
- }
- ]
}
},
"required": [
"type"
]
},
- "CreateCustomKnowledgeBaseDTO": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "description": "This knowledge base is bring your own knowledge base implementation.",
- "enum": [
- "custom-knowledge-base"
- ]
- },
- "server": {
- "description": "This is where the knowledge base request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"messsage\": {\n \"type\": \"knowledge-base-request\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Why is ocean blue?\"\n }\n ],\n ...other metadata about the call...\n }\n}\n\nResponse Expected:\n```\n{\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The ocean is blue because water absorbs everything but blue.\",\n }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK\n \"documents\": [\n {\n \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",\n \"similarity\": 1\n },\n {\n \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",\n \"similarity\": .5\n }\n ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL\n}\n```",
- "allOf": [
- {
- "$ref": "#/components/schemas/Server"
- }
- ]
- }
- },
- "required": [
- "provider",
- "server"
- ]
- },
- "KnowledgeBase": {
+ "ToolMessageComplete": {
"type": "object",
"properties": {
- "name": {
- "type": "string",
- "description": "The name of the knowledge base",
- "example": "My Knowledge Base"
+ "contents": {
+ "type": "array",
+ "description": "This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TextContent",
+ "title": "Text"
+ }
+ ]
+ }
},
- "provider": {
+ "type": {
"type": "string",
- "description": "The provider of the knowledge base",
+ "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": [
- "google"
- ],
- "example": "google"
+ "request-complete"
+ ]
},
- "model": {
+ "role": {
"type": "string",
- "description": "The model to use for the knowledge base",
+ "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": [
- "gemini-2.0-flash-thinking-exp",
- "gemini-2.0-pro-exp-02-05",
- "gemini-2.0-flash",
- "gemini-2.0-flash-lite",
- "gemini-2.0-flash-lite-preview-02-05",
- "gemini-2.0-flash-exp",
- "gemini-2.0-flash-realtime-exp",
- "gemini-1.5-flash",
- "gemini-1.5-flash-002",
- "gemini-1.5-pro",
- "gemini-1.5-pro-002",
- "gemini-1.0-pro"
+ "assistant",
+ "system"
]
},
- "description": {
+ "endCallAfterSpokenEnabled": {
+ "type": "boolean",
+ "description": "This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false",
+ "example": false
+ },
+ "content": {
"type": "string",
- "description": "A description of the knowledge base"
+ "description": "This is the content that the assistant says when this message is triggered.",
+ "maxLength": 1000
},
- "fileIds": {
- "description": "The file IDs associated with this knowledge base",
+ "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": {
- "type": "string"
+ "$ref": "#/components/schemas/Condition"
}
}
},
"required": [
- "name",
- "provider",
- "description",
- "fileIds"
+ "type"
]
},
- "CreateQueryToolDTO": {
+ "ToolMessageFailed": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
+ "contents": {
"type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "description": "This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
- },
- {
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
- },
- {
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
- },
- {
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
+ "$ref": "#/components/schemas/TextContent",
+ "title": "Text"
}
]
}
},
"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": [
- "query"
- ],
- "description": "The type of tool. \"query\" for Query tool."
+ "request-failed"
+ ]
},
- "knowledgeBases": {
- "description": "The knowledge bases to query",
+ "endCallAfterSpokenEnabled": {
+ "type": "boolean",
+ "description": "This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false",
+ "example": false
+ },
+ "content": {
+ "type": "string",
+ "description": "This is the content that the assistant says when this message is triggered.",
+ "maxLength": 1000
+ },
+ "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/KnowledgeBase"
+ "$ref": "#/components/schemas/Condition"
}
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "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"
- }
- ]
}
},
"required": [
"type"
]
},
- "CreateGoogleCalendarCreateEventToolDTO": {
+ "ToolMessageDelayed": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
+ "contents": {
"type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "description": "This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
- },
- {
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
- },
- {
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
- },
- {
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
+ "$ref": "#/components/schemas/TextContent",
+ "title": "Text"
}
]
}
},
"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": [
- "google.calendar.event.create"
- ],
- "description": "The type of tool. \"google.calendar.event.create\" for Google Calendar tool."
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "allOf": [
- {
- "$ref": "#/components/schemas/OpenAIFunction"
- }
+ "request-response-delayed"
]
},
- "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"
- }
- ]
- }
- },
- "required": [
- "type"
- ]
- },
- "CreateGoogleSheetsRowAppendToolDTO": {
+ "timingMilliseconds": {
+ "type": "number",
+ "minimum": 100,
+ "maximum": 120000,
+ "example": 1000,
+ "description": "The number of milliseconds to wait for the server response before saying this message."
+ },
+ "content": {
+ "type": "string",
+ "description": "This is the content that the assistant says when this message is triggered.",
+ "maxLength": 1000
+ },
+ "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"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "JsonSchema": {
"type": "object",
"properties": {
- "async": {
+ "type": {
+ "type": "string",
+ "description": "This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.",
+ "enum": [
+ "string",
+ "number",
+ "integer",
+ "boolean",
+ "array",
+ "object"
+ ]
+ },
+ "items": {
+ "type": "object",
+ "description": "This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references."
+ },
+ "properties": {
+ "type": "object",
+ "description": "This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references."
+ },
+ "description": {
+ "type": "string",
+ "description": "This is the description to help the model understand what it needs to output."
+ },
+ "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"
+ }
+ },
+ "value": {
+ "type": "string",
+ "description": "This the value that will be used in filling the property."
+ },
+ "target": {
+ "type": "string",
+ "description": "This the target variable that will be filled with the value of this property."
+ },
+ "enum": {
+ "description": "This array specifies the allowed values that can be used to restrict the output of the model.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "OpenAIFunctionParameters": {
+ "type": "object",
+ "properties": {
+ "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"
+ ]
+ },
+ "properties": {
+ "type": "object",
+ "description": "This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/JsonSchema"
+ }
+ },
+ "required": {
+ "description": "This specifies the properties that are required by the function.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "type",
+ "properties"
+ ]
+ },
+ "OpenAIFunction": {
+ "type": "object",
+ "properties": {
+ "strict": {
"type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
+ "description": "This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false",
+ "default": false
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.",
+ "maxLength": 64,
+ "pattern": "/^[a-zA-Z0-9_-]{1,64}$/"
+ },
+ "description": {
+ "type": "string",
+ "description": "This is the description of what the function does, used by the AI to choose when and how to call the function.",
+ "maxLength": 1000
},
+ "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"
+ }
+ ]
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "CreateDtmfToolDTO": {
+ "type": "object",
+ "properties": {
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -8787,9 +9983,9 @@
"type": {
"type": "string",
"enum": [
- "google.sheets.row.append"
+ "dtmf"
],
- "description": "The type of tool. \"google.sheets.row.append\" for Google Sheets tool."
+ "description": "The type of tool. \"dtmf\" for DTMF tool."
},
"function": {
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
@@ -8798,28 +9994,15 @@
"$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"
- }
- ]
}
},
"required": [
"type"
]
},
- "CreateGoogleCalendarCheckAvailabilityToolDTO": {
+ "CreateEndCallToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -8847,9 +10030,9 @@
"type": {
"type": "string",
"enum": [
- "google.calendar.availability.check"
+ "endCall"
],
- "description": "The type of tool. \"google.calendar.availability.check\" for Google Calendar availability check tool."
+ "description": "The type of tool. \"endCall\" for End Call tool."
},
"function": {
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
@@ -8858,28 +10041,15 @@
"$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"
- }
- ]
}
},
"required": [
"type"
]
},
- "CreateSlackSendMessageToolDTO": {
+ "CreateVoicemailToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -8906,10 +10076,11 @@
},
"type": {
"type": "string",
+ "deprecated": true,
"enum": [
- "slack.message.send"
+ "voicemail"
],
- "description": "The type of tool. \"slack.message.send\" for Slack send message tool."
+ "description": "The type of tool. \"voicemail\". This uses the model itself to determine if a voicemil was reached. Can be used alternatively/alongside with TwilioVoicemailDetection"
},
"function": {
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
@@ -8918,985 +10089,620 @@
"$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"
- }
- ]
}
},
"required": [
"type"
]
},
- "AnyscaleModel": {
+ "CreateFunctionToolDTO": {
"type": "object",
"properties": {
"messages": {
- "description": "This is the starting state for the conversation.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/OpenAIMessage"
- }
- },
- "tools": {
"type": "array",
- "description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/CreateDtmfToolDTO",
- "title": "DtmfTool"
- },
- {
- "$ref": "#/components/schemas/CreateEndCallToolDTO",
- "title": "EndCallTool"
- },
- {
- "$ref": "#/components/schemas/CreateVoicemailToolDTO",
- "title": "VoicemailTool"
- },
- {
- "$ref": "#/components/schemas/CreateFunctionToolDTO",
- "title": "FunctionTool"
- },
- {
- "$ref": "#/components/schemas/CreateGhlToolDTO",
- "title": "GhlTool"
- },
- {
- "$ref": "#/components/schemas/CreateMakeToolDTO",
- "title": "MakeTool"
- },
- {
- "$ref": "#/components/schemas/CreateTransferCallToolDTO",
- "title": "TransferTool"
- },
- {
- "$ref": "#/components/schemas/CreateQueryToolDTO",
- "title": "QueryTool"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
- "title": "GoogleCalendarCreateEventTool"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
},
{
- "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
- "title": "GoogleSheetsRowAppendTool"
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
},
{
- "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
- "title": "GoogleCalendarCheckAvailabilityTool"
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
},
{
- "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
- "title": "SlackSendMessageTool"
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "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"
- }
+ "type": {
+ "type": "string",
+ "enum": [
+ "function"
+ ],
+ "description": "The type of tool. \"function\" for Function tool."
},
- "knowledgeBase": {
- "description": "These are the options for the knowledge base.",
- "oneOf": [
+ "async": {
+ "type": "boolean",
+ "example": false,
+ "description": "This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`)."
+ },
+ "server": {
+ "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.",
+ "allOf": [
{
- "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
- "title": "Custom"
+ "$ref": "#/components/schemas/Server"
}
]
},
- "knowledgeBaseId": {
- "type": "string",
- "description": "This is the ID of the knowledge base the model will use."
- },
- "provider": {
- "type": "string",
- "enum": [
- "anyscale"
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
]
- },
- "model": {
- "type": "string",
- "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b"
- },
- "temperature": {
- "type": "number",
- "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.",
- "minimum": 0,
- "maximum": 2
- },
- "maxTokens": {
- "type": "number",
- "description": "This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.",
- "minimum": 50,
- "maximum": 10000
- },
- "emotionRecognitionEnabled": {
- "type": "boolean",
- "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.\n\n@default false"
- },
- "numFastTurns": {
- "type": "number",
- "description": "This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0",
- "minimum": 0
}
},
"required": [
- "provider",
- "model"
+ "type"
]
},
- "AnthropicThinkingConfig": {
+ "GhlToolMetadata": {
"type": "object",
"properties": {
- "type": {
- "type": "string",
- "enum": [
- "enabled"
- ]
+ "workflowId": {
+ "type": "string"
},
- "budgetTokens": {
- "type": "number",
- "description": "The maximum number of tokens to allocate for thinking.\nMust be between 1024 and 100000 tokens.",
- "minimum": 1024,
- "maximum": 100000
+ "locationId": {
+ "type": "string"
}
- },
- "required": [
- "type",
- "budgetTokens"
- ]
+ }
},
- "AnthropicModel": {
+ "CreateGhlToolDTO": {
"type": "object",
"properties": {
"messages": {
- "description": "This is the starting state for the conversation.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/OpenAIMessage"
- }
- },
- "tools": {
"type": "array",
- "description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/CreateDtmfToolDTO",
- "title": "DtmfTool"
- },
- {
- "$ref": "#/components/schemas/CreateEndCallToolDTO",
- "title": "EndCallTool"
- },
- {
- "$ref": "#/components/schemas/CreateVoicemailToolDTO",
- "title": "VoicemailTool"
- },
- {
- "$ref": "#/components/schemas/CreateFunctionToolDTO",
- "title": "FunctionTool"
- },
- {
- "$ref": "#/components/schemas/CreateGhlToolDTO",
- "title": "GhlTool"
- },
- {
- "$ref": "#/components/schemas/CreateMakeToolDTO",
- "title": "MakeTool"
- },
- {
- "$ref": "#/components/schemas/CreateTransferCallToolDTO",
- "title": "TransferTool"
- },
- {
- "$ref": "#/components/schemas/CreateQueryToolDTO",
- "title": "QueryTool"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
- "title": "GoogleCalendarCreateEventTool"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
},
{
- "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
- "title": "GoogleSheetsRowAppendTool"
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
},
{
- "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
- "title": "GoogleCalendarCheckAvailabilityTool"
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
},
{
- "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
- "title": "SlackSendMessageTool"
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "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"
- }
- },
- "knowledgeBase": {
- "description": "These are the options for the knowledge base.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
- "title": "Custom"
- }
- ]
- },
- "knowledgeBaseId": {
- "type": "string",
- "description": "This is the ID of the knowledge base the model will use."
- },
- "model": {
+ "type": {
"type": "string",
- "description": "The specific Anthropic/Claude model that will be used.",
"enum": [
- "claude-3-opus-20240229",
- "claude-3-sonnet-20240229",
- "claude-3-haiku-20240307",
- "claude-3-5-sonnet-20240620",
- "claude-3-5-sonnet-20241022",
- "claude-3-5-haiku-20241022",
- "claude-3-7-sonnet-20250219"
- ]
+ "ghl"
+ ],
+ "description": "The type of tool. \"ghl\" for GHL tool."
},
- "provider": {
- "type": "string",
- "description": "The provider identifier for Anthropic.",
- "enum": [
- "anthropic"
- ]
+ "metadata": {
+ "$ref": "#/components/schemas/GhlToolMetadata"
},
- "thinking": {
- "description": "Optional configuration for Anthropic's thinking feature.\nOnly applicable for claude-3-7-sonnet-20250219 model.\nIf provided, maxTokens must be greater than thinking.budgetTokens.",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/AnthropicThinkingConfig"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
- },
- "temperature": {
- "type": "number",
- "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.",
- "minimum": 0,
- "maximum": 2
- },
- "maxTokens": {
- "type": "number",
- "description": "This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.",
- "minimum": 50,
- "maximum": 10000
- },
- "emotionRecognitionEnabled": {
- "type": "boolean",
- "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.\n\n@default false"
- },
- "numFastTurns": {
- "type": "number",
- "description": "This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0",
- "minimum": 0
}
},
"required": [
- "model",
- "provider"
+ "type",
+ "metadata"
]
},
- "CerebrasModel": {
+ "MakeToolMetadata": {
"type": "object",
"properties": {
- "messages": {
- "description": "This is the starting state for the conversation.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/OpenAIMessage"
- }
+ "scenarioId": {
+ "type": "number"
},
- "tools": {
+ "triggerHookId": {
+ "type": "number"
+ }
+ }
+ },
+ "CreateMakeToolDTO": {
+ "type": "object",
+ "properties": {
+ "messages": {
"type": "array",
- "description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/CreateDtmfToolDTO",
- "title": "DtmfTool"
- },
- {
- "$ref": "#/components/schemas/CreateEndCallToolDTO",
- "title": "EndCallTool"
- },
- {
- "$ref": "#/components/schemas/CreateVoicemailToolDTO",
- "title": "VoicemailTool"
- },
- {
- "$ref": "#/components/schemas/CreateFunctionToolDTO",
- "title": "FunctionTool"
- },
- {
- "$ref": "#/components/schemas/CreateGhlToolDTO",
- "title": "GhlTool"
- },
- {
- "$ref": "#/components/schemas/CreateMakeToolDTO",
- "title": "MakeTool"
- },
- {
- "$ref": "#/components/schemas/CreateTransferCallToolDTO",
- "title": "TransferTool"
- },
- {
- "$ref": "#/components/schemas/CreateQueryToolDTO",
- "title": "QueryTool"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
- "title": "GoogleCalendarCreateEventTool"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
},
{
- "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
- "title": "GoogleSheetsRowAppendTool"
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
},
{
- "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
- "title": "GoogleCalendarCheckAvailabilityTool"
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
},
{
- "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
- "title": "SlackSendMessageTool"
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "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": {
+ "type": "string",
+ "enum": [
+ "make"
+ ],
+ "description": "The type of tool. \"make\" for Make tool."
+ },
+ "metadata": {
+ "$ref": "#/components/schemas/MakeToolMetadata"
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "metadata"
+ ]
+ },
+ "CustomMessage": {
+ "type": "object",
+ "properties": {
+ "contents": {
"type": "array",
+ "description": "This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.",
"items": {
- "type": "string"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TextContent",
+ "title": "Text"
+ }
+ ]
}
},
- "knowledgeBase": {
- "description": "These are the options for the knowledge base.",
+ "type": {
+ "type": "string",
+ "description": "This is a custom message.",
+ "enum": [
+ "custom-message"
+ ]
+ },
+ "content": {
+ "type": "string",
+ "description": "This is the content that the assistant will say when this message is triggered.",
+ "maxLength": 1000
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "TransferDestinationAssistant": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.",
"oneOf": [
{
- "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
- "title": "Custom"
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/CustomMessage"
}
]
},
- "knowledgeBaseId": {
- "type": "string",
- "description": "This is the ID of the knowledge base the model will use."
- },
- "model": {
+ "type": {
"type": "string",
- "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b",
"enum": [
- "llama3.1-8b",
- "llama-3.3-70b"
+ "assistant"
]
},
- "provider": {
+ "transferMode": {
"type": "string",
+ "description": "This is the mode to use for the transfer. Defaults to `rolling-history`.\n\n- `rolling-history`: This is the default mode. It keeps the entire conversation history and appends the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n system: assistant2 system message\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `swap-system-message-in-history`: This replaces the original system message with the new assistant's system message on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n- `delete-history`: This deletes the entire conversation history on transfer.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant2 first message\n user: Yes, please\n assistant: how can i help?\n user: i need help with my account\n\n- `swap-system-message-in-history-and-remove-transfer-tool-messages`: This replaces the original system message with the new assistant's system message on transfer and removes transfer tool messages from conversation history sent to the LLM.\n\n Example:\n\n Pre-transfer:\n system: assistant1 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n transfer-tool\n transfer-tool-result\n assistant: (destination.message)\n\n Post-transfer:\n system: assistant2 system message\n assistant: assistant1 first message\n user: hey, good morning\n assistant: how can i help?\n user: i need help with my account\n assistant: (destination.message)\n assistant: assistant2 first message (or model generated if firstMessageMode is set to `assistant-speaks-first-with-model-generated-message`)\n\n@default 'rolling-history'",
"enum": [
- "cerebras"
+ "rolling-history",
+ "swap-system-message-in-history",
+ "swap-system-message-in-history-and-remove-transfer-tool-messages",
+ "delete-history"
]
},
- "temperature": {
- "type": "number",
- "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.",
- "minimum": 0,
- "maximum": 2
+ "assistantName": {
+ "type": "string",
+ "description": "This is the assistant to transfer the call to."
},
- "maxTokens": {
- "type": "number",
- "description": "This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.",
- "minimum": 50,
- "maximum": 10000
+ "description": {
+ "type": "string",
+ "description": "This is the description of the destination, used by the AI to choose when and how to transfer the call."
+ }
+ },
+ "required": [
+ "type",
+ "assistantName"
+ ]
+ },
+ "TransferFallbackPlan": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "This is the message the assistant will deliver to the customer if the transfer fails.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/CustomMessage"
+ }
+ ]
},
- "emotionRecognitionEnabled": {
+ "endCallEnabled": {
"type": "boolean",
- "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.\n\n@default false"
- },
- "numFastTurns": {
- "type": "number",
- "description": "This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0",
- "minimum": 0
+ "description": "This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true",
+ "default": true
}
},
"required": [
- "model",
- "provider"
+ "message"
]
},
- "CustomLLMModel": {
+ "SummaryPlan": {
"type": "object",
"properties": {
"messages": {
- "description": "This is the starting state for the conversation.",
+ "description": "These are the messages used to generate the summary.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: The transcript of the call from `call.artifact.transcript` \n- {{systemPrompt}}: The system prompt of the call from `assistant.model.messages[type=system].content` \n- {{endedReason}}: The ended reason of the call from `call.endedReason`",
"type": "array",
"items": {
- "$ref": "#/components/schemas/OpenAIMessage"
+ "type": "object"
}
},
- "tools": {
- "type": "array",
- "description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/CreateDtmfToolDTO",
- "title": "DtmfTool"
- },
- {
- "$ref": "#/components/schemas/CreateEndCallToolDTO",
- "title": "EndCallTool"
- },
- {
- "$ref": "#/components/schemas/CreateVoicemailToolDTO",
- "title": "VoicemailTool"
- },
- {
- "$ref": "#/components/schemas/CreateFunctionToolDTO",
- "title": "FunctionTool"
- },
- {
- "$ref": "#/components/schemas/CreateGhlToolDTO",
- "title": "GhlTool"
- },
- {
- "$ref": "#/components/schemas/CreateMakeToolDTO",
- "title": "MakeTool"
- },
- {
- "$ref": "#/components/schemas/CreateTransferCallToolDTO",
- "title": "TransferTool"
- },
- {
- "$ref": "#/components/schemas/CreateQueryToolDTO",
- "title": "QueryTool"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
- "title": "GoogleCalendarCreateEventTool"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
- "title": "GoogleSheetsRowAppendTool"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
- "title": "GoogleCalendarCheckAvailabilityTool"
- },
- {
- "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
- "title": "SlackSendMessageTool"
- }
- ]
- }
+ "enabled": {
+ "type": "boolean",
+ "description": "This determines whether a summary is generated and stored in `call.analysis.summary`. Defaults to true.\n\nUsage:\n- If you want to disable the summary, set this to false.\n\n@default true"
},
- "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"
- }
+ "timeoutSeconds": {
+ "type": "number",
+ "description": "This is how long the request is tried before giving up. When request times out, `call.analysis.summary` will be empty.\n\nUsage:\n- To guarantee the summary is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds",
+ "minimum": 1,
+ "maximum": 60
+ }
+ }
+ },
+ "TransferPlan": {
+ "type": "object",
+ "properties": {
+ "mode": {
+ "type": "string",
+ "description": "This configures how transfer is executed and the experience of the destination party receiving the call.\n\nUsage:\n- `blind-transfer`: The assistant forwards the call to the destination without any message or summary.\n- `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to the destination and adds a SIP header X-Transfer-Summary to the call to include the summary.\n- `warm-transfer-say-message`: The assistant dials the destination, delivers the `message` to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-say-summary`: The assistant dials the destination, provides a summary of the call to the destination party, connects the customer, and leaves the call.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The assistant dials the destination, waits for the operator to speak, delivers the `message` to the destination party, and then connects the customer.\n- `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The assistant dials the destination, waits for the operator to speak, provides a summary of the call to the destination party, and then connects the customer.\n- `warm-transfer-twiml`: The assistant dials the destination, executes the twiml instructions on the destination call leg, connects the customer, and leaves the call.\n- `warm-transfer-experimental`: The assistant puts the customer on hold, dials the destination, and if the destination answers (and is human), delivers a message or summary before connecting the customer. If the destination is unreachable or not human (e.g., with voicemail detection), the assistant delivers the `fallbackMessage` to the customer and optionally ends the call.\n\n@default 'blind-transfer'",
+ "enum": [
+ "blind-transfer",
+ "blind-transfer-add-summary-to-sip-header",
+ "warm-transfer-say-message",
+ "warm-transfer-say-summary",
+ "warm-transfer-twiml",
+ "warm-transfer-wait-for-operator-to-speak-first-and-then-say-message",
+ "warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary",
+ "warm-transfer-experimental"
+ ]
},
- "knowledgeBase": {
- "description": "These are the options for the knowledge base.",
+ "message": {
+ "description": "This is the message the assistant will deliver to the destination party before connecting the customer.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header`, `warm-transfer-say-message`, `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`, or `warm-transfer-experimental`.",
"oneOf": [
{
- "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
- "title": "Custom"
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/CustomMessage"
}
]
},
- "knowledgeBaseId": {
- "type": "string",
- "description": "This is the ID of the knowledge base the model will use."
+ "timeout": {
+ "type": "number",
+ "description": "This is the timeout in seconds for the warm-transfer-wait-for-operator-to-speak-first-and-then-say-message/summary\n\n@default 60",
+ "minimum": 1,
+ "maximum": 600,
+ "default": 60
},
- "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.",
+ "sipVerb": {
+ "type": "object",
+ "description": "This specifies the SIP verb to use while transferring the call.\n- 'refer': Uses SIP REFER to transfer the call (default)\n- 'bye': Ends current call with SIP BYE\n- 'dial': Uses SIP DIAL to transfer the call",
+ "default": "refer",
"enum": [
- "custom-llm"
+ "refer",
+ "bye",
+ "dial"
]
},
- "metadataSendMode": {
+ "holdAudioUrl": {
"type": "string",
- "description": "This determines whether metadata is sent in requests to the custom provider.\n\n- `off` will not send any metadata. payload will look like `{ messages }`\n- `variable` will send `assistant.metadata` as a variable on the payload. payload will look like `{ messages, metadata }`\n- `destructured` will send `assistant.metadata` fields directly on the payload. payload will look like `{ messages, ...metadata }`\n\nFurther, `variable` and `destructured` will send `call`, `phoneNumber`, and `customer` objects in the payload.\n\nDefault is `variable`.",
- "enum": [
- "off",
- "variable",
- "destructured"
- ]
+ "description": "This is the URL to an audio file played while the customer is on hold during transfer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the customer.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV.\n- If not provided, the default hold audio will be used."
},
- "url": {
+ "transferCompleteAudioUrl": {
"type": "string",
- "description": "These is the URL we'll use for the OpenAI client's `baseURL`. Ex. https://openrouter.ai/api/v1"
- },
- "timeoutSeconds": {
- "type": "number",
- "description": "This sets the timeout for the connection to the custom provider without needing to stream any tokens back. Default is 20 seconds.",
- "minimum": 20,
- "maximum": 600
+ "description": "This is the URL to an audio file played after the warm transfer message or summary is delivered to the destination party.\nIt can be used to play a custom sound like 'beep' to notify that the transfer is complete.\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- Used when transferring calls to play hold audio for the destination party.\n- Must be a publicly accessible URL to an audio file.\n- Supported formats: MP3 and WAV."
},
- "model": {
+ "twiml": {
"type": "string",
- "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b"
- },
- "temperature": {
- "type": "number",
- "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.",
- "minimum": 0,
- "maximum": 2
+ "description": "This is the TwiML instructions to execute on the destination call leg before connecting the customer.\n\nUsage:\n- Used only when `mode` is `warm-transfer-twiml`.\n- Supports only `Play`, `Say`, `Gather`, `Hangup` and `Pause` verbs.\n- Maximum length is 4096 characters.\n\nExample:\n```\nHello, transferring a customer to you.\n\nThey called about billing questions.\n```",
+ "maxLength": 4096
},
- "maxTokens": {
- "type": "number",
- "description": "This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.",
- "minimum": 50,
- "maximum": 10000
+ "summaryPlan": {
+ "description": "This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary` or `warm-transfer-experimental`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SummaryPlan"
+ }
+ ]
},
- "emotionRecognitionEnabled": {
+ "sipHeadersInReferToEnabled": {
"type": "boolean",
- "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.\n\n@default false"
+ "description": "This flag includes the sipHeaders from above in the refer to sip uri as url encoded query params.\n\n@default false"
},
- "numFastTurns": {
- "type": "number",
- "description": "This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0",
- "minimum": 0
+ "fallbackPlan": {
+ "description": "This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human).\n\nUsage:\n- Used only when `mode` is `warm-transfer-experimental`.\n- If not provided when using `warm-transfer-experimental`, a default message will be used.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/TransferFallbackPlan"
+ }
+ ]
}
},
"required": [
- "provider",
- "url",
- "model"
+ "mode"
]
},
- "DeepInfraModel": {
+ "TransferDestinationNumber": {
"type": "object",
"properties": {
- "messages": {
- "description": "This is the starting state for the conversation.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/OpenAIMessage"
- }
+ "message": {
+ "description": "This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/CustomMessage"
+ }
+ ]
},
- "tools": {
- "type": "array",
- "description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/CreateDtmfToolDTO",
- "title": "DtmfTool"
- },
- {
- "$ref": "#/components/schemas/CreateEndCallToolDTO",
- "title": "EndCallTool"
- },
- {
- "$ref": "#/components/schemas/CreateVoicemailToolDTO",
- "title": "VoicemailTool"
- },
- {
- "$ref": "#/components/schemas/CreateFunctionToolDTO",
- "title": "FunctionTool"
- },
- {
- "$ref": "#/components/schemas/CreateGhlToolDTO",
- "title": "GhlTool"
- },
- {
- "$ref": "#/components/schemas/CreateMakeToolDTO",
- "title": "MakeTool"
- },
- {
- "$ref": "#/components/schemas/CreateTransferCallToolDTO",
- "title": "TransferTool"
- },
- {
- "$ref": "#/components/schemas/CreateQueryToolDTO",
- "title": "QueryTool"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
- "title": "GoogleCalendarCreateEventTool"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
- "title": "GoogleSheetsRowAppendTool"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
- "title": "GoogleCalendarCheckAvailabilityTool"
- },
- {
- "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
- "title": "SlackSendMessageTool"
- }
- ]
- }
+ "type": {
+ "type": "string",
+ "enum": [
+ "number"
+ ]
},
- "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"
- }
+ "numberE164CheckEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)",
+ "default": true
},
- "knowledgeBase": {
- "description": "These are the options for the knowledge base.",
- "oneOf": [
+ "number": {
+ "type": "string",
+ "description": "This is the phone number to transfer the call to.",
+ "minLength": 3,
+ "maxLength": 40
+ },
+ "extension": {
+ "type": "string",
+ "description": "This is the extension to dial after transferring the call to the `number`.",
+ "minLength": 1,
+ "maxLength": 10
+ },
+ "callerId": {
+ "type": "string",
+ "description": "This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming from. Example, +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid",
+ "maxLength": 40
+ },
+ "transferPlan": {
+ "description": "This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`",
+ "allOf": [
{
- "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
- "title": "Custom"
+ "$ref": "#/components/schemas/TransferPlan"
}
]
},
- "knowledgeBaseId": {
+ "description": {
"type": "string",
- "description": "This is the ID of the knowledge base the model will use."
+ "description": "This is the description of the destination, used by the AI to choose when and how to transfer the call."
+ }
+ },
+ "required": [
+ "type",
+ "number"
+ ]
+ },
+ "TransferDestinationSip": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "This is spoken to the customer before connecting them to the destination.\n\nUsage:\n- If this is not provided and transfer tool messages is not provided, default is \"Transferring the call now\".\n- If set to \"\", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set `assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message` for the destination assistant.\n\nThis accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.",
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/CustomMessage"
+ }
+ ]
},
- "provider": {
+ "type": {
"type": "string",
"enum": [
- "deepinfra"
+ "sip"
]
},
- "model": {
+ "sipUri": {
"type": "string",
- "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b"
- },
- "temperature": {
- "type": "number",
- "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.",
- "minimum": 0,
- "maximum": 2
+ "description": "This is the SIP URI to transfer the call to."
},
- "maxTokens": {
- "type": "number",
- "description": "This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.",
- "minimum": 50,
- "maximum": 10000
+ "transferPlan": {
+ "description": "This configures how transfer is executed and the experience of the destination party receiving the call. Defaults to `blind-transfer`.\n\n@default `transferPlan.mode='blind-transfer'`",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/TransferPlan"
+ }
+ ]
},
- "emotionRecognitionEnabled": {
- "type": "boolean",
- "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.\n\n@default false"
+ "sipHeaders": {
+ "type": "object",
+ "description": "These are custom headers to be added to SIP refer during transfer call."
},
- "numFastTurns": {
- "type": "number",
- "description": "This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0",
- "minimum": 0
+ "description": {
+ "type": "string",
+ "description": "This is the description of the destination, used by the AI to choose when and how to transfer the call."
}
},
"required": [
- "provider",
- "model"
+ "type",
+ "sipUri"
]
},
- "DeepSeekModel": {
+ "CreateTransferCallToolDTO": {
"type": "object",
"properties": {
"messages": {
- "description": "This is the starting state for the conversation.",
"type": "array",
- "items": {
- "$ref": "#/components/schemas/OpenAIMessage"
- }
- },
- "tools": {
- "type": "array",
- "description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/CreateDtmfToolDTO",
- "title": "DtmfTool"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
},
{
- "$ref": "#/components/schemas/CreateEndCallToolDTO",
- "title": "EndCallTool"
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
},
{
- "$ref": "#/components/schemas/CreateVoicemailToolDTO",
- "title": "VoicemailTool"
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
},
{
- "$ref": "#/components/schemas/CreateFunctionToolDTO",
- "title": "FunctionTool"
- },
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
+ }
+ },
+ "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.",
+ "items": {
+ "oneOf": [
{
- "$ref": "#/components/schemas/CreateGhlToolDTO",
- "title": "GhlTool"
+ "$ref": "#/components/schemas/TransferDestinationAssistant",
+ "title": "Assistant"
},
{
- "$ref": "#/components/schemas/CreateMakeToolDTO",
- "title": "MakeTool"
- },
- {
- "$ref": "#/components/schemas/CreateTransferCallToolDTO",
- "title": "TransferTool"
- },
- {
- "$ref": "#/components/schemas/CreateQueryToolDTO",
- "title": "QueryTool"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
- "title": "GoogleCalendarCreateEventTool"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
- "title": "GoogleSheetsRowAppendTool"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
- "title": "GoogleCalendarCheckAvailabilityTool"
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "Number"
},
{
- "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
- "title": "SlackSendMessageTool"
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "Sip"
}
]
}
},
- "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"
- }
- },
- "knowledgeBase": {
- "description": "These are the options for the knowledge base.",
- "oneOf": [
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
{
- "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
- "title": "Custom"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
- },
- "knowledgeBaseId": {
- "type": "string",
- "description": "This is the ID of the knowledge base the model will use."
- },
- "model": {
- "type": "string",
- "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b",
- "enum": [
- "deepseek-chat",
- "deepseek-reasoner"
- ]
- },
- "provider": {
- "type": "string",
- "enum": [
- "deep-seek"
- ]
- },
- "temperature": {
- "type": "number",
- "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.",
- "minimum": 0,
- "maximum": 2
- },
- "maxTokens": {
- "type": "number",
- "description": "This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.",
- "minimum": 50,
- "maximum": 10000
- },
- "emotionRecognitionEnabled": {
- "type": "boolean",
- "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.\n\n@default false"
- },
- "numFastTurns": {
- "type": "number",
- "description": "This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0",
- "minimum": 0
}
},
"required": [
- "model",
- "provider"
+ "type"
]
},
- "GeminiMultimodalLivePrebuiltVoiceConfig": {
+ "CreateCustomKnowledgeBaseDTO": {
"type": "object",
"properties": {
- "voiceName": {
+ "provider": {
"type": "string",
+ "description": "This knowledge base is bring your own knowledge base implementation.",
"enum": [
- "Puck",
- "Charon",
- "Kore",
- "Fenrir",
- "Aoede"
+ "custom-knowledge-base"
]
- }
- },
- "required": [
- "voiceName"
- ]
- },
- "GeminiMultimodalLiveVoiceConfig": {
- "type": "object",
- "properties": {
- "prebuiltVoiceConfig": {
- "$ref": "#/components/schemas/GeminiMultimodalLivePrebuiltVoiceConfig"
- }
- },
- "required": [
- "prebuiltVoiceConfig"
- ]
- },
- "GeminiMultimodalLiveSpeechConfig": {
- "type": "object",
- "properties": {
- "voiceConfig": {
- "$ref": "#/components/schemas/GeminiMultimodalLiveVoiceConfig"
- }
- },
- "required": [
- "voiceConfig"
- ]
- },
- "GoogleRealtimeConfig": {
- "type": "object",
- "properties": {
- "topP": {
- "type": "number",
- "description": "This is the nucleus sampling parameter that controls the cumulative probability of tokens considered during text generation.\nOnly applicable with the Gemini Flash 2.0 Multimodal Live API."
},
- "topK": {
- "type": "number",
- "description": "This is the top-k sampling parameter that limits the number of highest probability tokens considered during text generation.\nOnly applicable with the Gemini Flash 2.0 Multimodal Live API."
- },
- "presencePenalty": {
- "type": "number",
- "description": "This is the presence penalty parameter that influences the model's likelihood to repeat information by penalizing tokens based on their presence in the text.\nOnly applicable with the Gemini Flash 2.0 Multimodal Live API."
- },
- "frequencyPenalty": {
- "type": "number",
- "description": "This is the frequency penalty parameter that influences the model's likelihood to repeat tokens by penalizing them based on their frequency in the text.\nOnly applicable with the Gemini Flash 2.0 Multimodal Live API."
- },
- "speechConfig": {
- "description": "This is the speech configuration object that defines the voice settings to be used for the model's speech output.\nOnly applicable with the Gemini Flash 2.0 Multimodal Live API.",
+ "server": {
+ "description": "This is where the knowledge base request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"messsage\": {\n \"type\": \"knowledge-base-request\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Why is ocean blue?\"\n }\n ],\n ...other metadata about the call...\n }\n}\n\nResponse Expected:\n```\n{\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The ocean is blue because water absorbs everything but blue.\",\n }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK\n \"documents\": [\n {\n \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",\n \"similarity\": 1\n },\n {\n \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",\n \"similarity\": .5\n }\n ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL\n}\n```",
"allOf": [
{
- "$ref": "#/components/schemas/GeminiMultimodalLiveSpeechConfig"
+ "$ref": "#/components/schemas/Server"
}
]
}
- }
+ },
+ "required": [
+ "provider",
+ "server"
+ ]
},
- "GoogleModel": {
+ "KnowledgeBase": {
"type": "object",
"properties": {
- "messages": {
- "description": "This is the starting state for the conversation.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/OpenAIMessage"
- }
- },
- "tools": {
- "type": "array",
- "description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/CreateDtmfToolDTO",
- "title": "DtmfTool"
- },
- {
- "$ref": "#/components/schemas/CreateEndCallToolDTO",
- "title": "EndCallTool"
- },
- {
- "$ref": "#/components/schemas/CreateVoicemailToolDTO",
- "title": "VoicemailTool"
- },
- {
- "$ref": "#/components/schemas/CreateFunctionToolDTO",
- "title": "FunctionTool"
- },
- {
- "$ref": "#/components/schemas/CreateGhlToolDTO",
- "title": "GhlTool"
- },
- {
- "$ref": "#/components/schemas/CreateMakeToolDTO",
- "title": "MakeTool"
- },
- {
- "$ref": "#/components/schemas/CreateTransferCallToolDTO",
- "title": "TransferTool"
- },
- {
- "$ref": "#/components/schemas/CreateQueryToolDTO",
- "title": "QueryTool"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
- "title": "GoogleCalendarCreateEventTool"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
- "title": "GoogleSheetsRowAppendTool"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
- "title": "GoogleCalendarCheckAvailabilityTool"
- },
- {
- "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
- "title": "SlackSendMessageTool"
- }
- ]
- }
- },
- "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"
- }
- },
- "knowledgeBase": {
- "description": "These are the options for the knowledge base.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
- "title": "Custom"
- }
- ]
+ "name": {
+ "type": "string",
+ "description": "The name of the knowledge base",
+ "example": "My Knowledge Base"
},
- "knowledgeBaseId": {
+ "provider": {
"type": "string",
- "description": "This is the ID of the knowledge base the model will use."
+ "description": "The provider of the knowledge base",
+ "enum": [
+ "google"
+ ],
+ "example": "google"
},
"model": {
"type": "string",
- "description": "This is the Google model that will be used.",
+ "description": "The model to use for the knowledge base",
"enum": [
+ "gemini-2.5-pro-preview-05-06",
+ "gemini-2.5-flash-preview-05-20",
+ "gemini-2.5-flash-preview-04-17",
"gemini-2.0-flash-thinking-exp",
"gemini-2.0-pro-exp-02-05",
"gemini-2.0-flash",
@@ -9911,542 +10717,527 @@
"gemini-1.0-pro"
]
},
- "provider": {
+ "description": {
"type": "string",
- "enum": [
- "google"
- ]
- },
- "realtimeConfig": {
- "description": "This is the session configuration for the Gemini Flash 2.0 Multimodal Live API.\nOnly applicable if the model `gemini-2.0-flash-realtime-exp` is selected.",
- "allOf": [
- {
- "$ref": "#/components/schemas/GoogleRealtimeConfig"
- }
- ]
- },
- "temperature": {
- "type": "number",
- "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.",
- "minimum": 0,
- "maximum": 2
- },
- "maxTokens": {
- "type": "number",
- "description": "This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.",
- "minimum": 50,
- "maximum": 10000
- },
- "emotionRecognitionEnabled": {
- "type": "boolean",
- "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.\n\n@default false"
+ "description": "A description of the knowledge base"
},
- "numFastTurns": {
- "type": "number",
- "description": "This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0",
- "minimum": 0
+ "fileIds": {
+ "description": "The file IDs associated with this knowledge base",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
"required": [
- "model",
- "provider"
+ "name",
+ "provider",
+ "description",
+ "fileIds"
]
},
- "GroqModel": {
+ "CreateQueryToolDTO": {
"type": "object",
"properties": {
"messages": {
- "description": "This is the starting state for the conversation.",
"type": "array",
- "items": {
- "$ref": "#/components/schemas/OpenAIMessage"
- }
- },
- "tools": {
- "type": "array",
- "description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/CreateDtmfToolDTO",
- "title": "DtmfTool"
- },
- {
- "$ref": "#/components/schemas/CreateEndCallToolDTO",
- "title": "EndCallTool"
- },
- {
- "$ref": "#/components/schemas/CreateVoicemailToolDTO",
- "title": "VoicemailTool"
- },
- {
- "$ref": "#/components/schemas/CreateFunctionToolDTO",
- "title": "FunctionTool"
- },
- {
- "$ref": "#/components/schemas/CreateGhlToolDTO",
- "title": "GhlTool"
- },
- {
- "$ref": "#/components/schemas/CreateMakeToolDTO",
- "title": "MakeTool"
- },
- {
- "$ref": "#/components/schemas/CreateTransferCallToolDTO",
- "title": "TransferTool"
- },
- {
- "$ref": "#/components/schemas/CreateQueryToolDTO",
- "title": "QueryTool"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
- "title": "GoogleCalendarCreateEventTool"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
},
{
- "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
- "title": "GoogleSheetsRowAppendTool"
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
},
{
- "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
- "title": "GoogleCalendarCheckAvailabilityTool"
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
},
{
- "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
- "title": "SlackSendMessageTool"
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "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": {
+ "type": "string",
+ "enum": [
+ "query"
+ ],
+ "description": "The type of tool. \"query\" for Query tool."
+ },
+ "knowledgeBases": {
+ "description": "The knowledge bases to query",
"type": "array",
"items": {
- "type": "string"
+ "$ref": "#/components/schemas/KnowledgeBase"
}
},
- "knowledgeBase": {
- "description": "These are the options for the knowledge base.",
- "oneOf": [
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
{
- "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
- "title": "Custom"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
- },
- "knowledgeBaseId": {
- "type": "string",
- "description": "This is the ID of the knowledge base the model will use."
- },
- "model": {
- "type": "string",
- "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b",
- "enum": [
- "deepseek-r1-distill-llama-70b",
- "llama-3.3-70b-versatile",
- "llama-3.1-405b-reasoning",
- "llama-3.1-70b-versatile",
- "llama-3.1-8b-instant",
- "mixtral-8x7b-32768",
- "llama3-8b-8192",
- "llama3-70b-8192",
- "gemma2-9b-it"
- ]
- },
- "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.",
- "minimum": 0,
- "maximum": 2
- },
- "maxTokens": {
- "type": "number",
- "description": "This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.",
- "minimum": 50,
- "maximum": 10000
- },
- "emotionRecognitionEnabled": {
- "type": "boolean",
- "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.\n\n@default false"
- },
- "numFastTurns": {
- "type": "number",
- "description": "This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0",
- "minimum": 0
}
},
"required": [
- "model",
- "provider"
+ "type"
]
},
- "InflectionAIModel": {
+ "CreateGoogleCalendarCreateEventToolDTO": {
"type": "object",
"properties": {
"messages": {
- "description": "This is the starting state for the conversation.",
"type": "array",
- "items": {
- "$ref": "#/components/schemas/OpenAIMessage"
- }
- },
- "tools": {
- "type": "array",
- "description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/CreateDtmfToolDTO",
- "title": "DtmfTool"
- },
- {
- "$ref": "#/components/schemas/CreateEndCallToolDTO",
- "title": "EndCallTool"
- },
- {
- "$ref": "#/components/schemas/CreateVoicemailToolDTO",
- "title": "VoicemailTool"
- },
- {
- "$ref": "#/components/schemas/CreateFunctionToolDTO",
- "title": "FunctionTool"
- },
- {
- "$ref": "#/components/schemas/CreateGhlToolDTO",
- "title": "GhlTool"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
},
{
- "$ref": "#/components/schemas/CreateMakeToolDTO",
- "title": "MakeTool"
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
},
{
- "$ref": "#/components/schemas/CreateTransferCallToolDTO",
- "title": "TransferTool"
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
},
{
- "$ref": "#/components/schemas/CreateQueryToolDTO",
- "title": "QueryTool"
- },
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
+ }
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "google.calendar.event.create"
+ ],
+ "description": "The type of tool. \"google.calendar.event.create\" for Google Calendar tool."
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "CreateGoogleSheetsRowAppendToolDTO": {
+ "type": "object",
+ "properties": {
+ "messages": {
+ "type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "items": {
+ "oneOf": [
{
- "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
- "title": "GoogleCalendarCreateEventTool"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
},
{
- "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
- "title": "GoogleSheetsRowAppendTool"
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
},
{
- "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
- "title": "GoogleCalendarCheckAvailabilityTool"
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
},
{
- "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
- "title": "SlackSendMessageTool"
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "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"
- }
+ "type": {
+ "type": "string",
+ "enum": [
+ "google.sheets.row.append"
+ ],
+ "description": "The type of tool. \"google.sheets.row.append\" for Google Sheets tool."
},
- "knowledgeBase": {
- "description": "These are the options for the knowledge base.",
- "oneOf": [
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
{
- "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
- "title": "Custom"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "CreateGoogleCalendarCheckAvailabilityToolDTO": {
+ "type": "object",
+ "properties": {
+ "messages": {
+ "type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
+ }
},
- "knowledgeBaseId": {
- "type": "string",
- "description": "This is the ID of the knowledge base the model will use."
- },
- "model": {
+ "type": {
"type": "string",
- "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b",
"enum": [
- "inflection_3_pi"
- ]
+ "google.calendar.availability.check"
+ ],
+ "description": "The type of tool. \"google.calendar.availability.check\" for Google Calendar availability check tool."
},
- "provider": {
- "type": "string",
- "enum": [
- "inflection-ai"
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
]
- },
- "temperature": {
- "type": "number",
- "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.",
- "minimum": 0,
- "maximum": 2
- },
- "maxTokens": {
- "type": "number",
- "description": "This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.",
- "minimum": 50,
- "maximum": 10000
- },
- "emotionRecognitionEnabled": {
- "type": "boolean",
- "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.\n\n@default false"
- },
- "numFastTurns": {
- "type": "number",
- "description": "This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0",
- "minimum": 0
}
},
"required": [
- "model",
- "provider"
+ "type"
]
},
- "OpenAIModel": {
+ "CreateSlackSendMessageToolDTO": {
"type": "object",
"properties": {
"messages": {
- "description": "This is the starting state for the conversation.",
"type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
- "$ref": "#/components/schemas/OpenAIMessage"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
}
},
- "tools": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "slack.message.send"
+ ],
+ "description": "The type of tool. \"slack.message.send\" for Slack send message tool."
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "McpToolMetadata": {
+ "type": "object",
+ "properties": {
+ "protocol": {
+ "type": "string",
+ "enum": [
+ "sse",
+ "shttp"
+ ],
+ "description": "This is the protocol used for MCP communication. Defaults to Streamable HTTP."
+ }
+ }
+ },
+ "CreateMcpToolDTO": {
+ "type": "object",
+ "properties": {
+ "messages": {
"type": "array",
- "description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/CreateDtmfToolDTO",
- "title": "DtmfTool"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
},
{
- "$ref": "#/components/schemas/CreateEndCallToolDTO",
- "title": "EndCallTool"
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
},
{
- "$ref": "#/components/schemas/CreateVoicemailToolDTO",
- "title": "VoicemailTool"
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
},
{
- "$ref": "#/components/schemas/CreateFunctionToolDTO",
- "title": "FunctionTool"
- },
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
+ }
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "mcp"
+ ],
+ "description": "The type of tool. \"mcp\" for MCP tool."
+ },
+ "server": {
+ "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
+ },
+ "metadata": {
+ "$ref": "#/components/schemas/McpToolMetadata"
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "CreateGoHighLevelCalendarAvailabilityToolDTO": {
+ "type": "object",
+ "properties": {
+ "messages": {
+ "type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "items": {
+ "oneOf": [
{
- "$ref": "#/components/schemas/CreateGhlToolDTO",
- "title": "GhlTool"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
},
{
- "$ref": "#/components/schemas/CreateMakeToolDTO",
- "title": "MakeTool"
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
},
{
- "$ref": "#/components/schemas/CreateTransferCallToolDTO",
- "title": "TransferTool"
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
},
{
- "$ref": "#/components/schemas/CreateQueryToolDTO",
- "title": "QueryTool"
- },
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
+ }
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "gohighlevel.calendar.availability.check"
+ ],
+ "description": "The type of tool. \"gohighlevel.calendar.availability.check\" for GoHighLevel Calendar availability check tool."
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "CreateGoHighLevelCalendarEventCreateToolDTO": {
+ "type": "object",
+ "properties": {
+ "messages": {
+ "type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "items": {
+ "oneOf": [
{
- "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
- "title": "GoogleCalendarCreateEventTool"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
},
{
- "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
- "title": "GoogleSheetsRowAppendTool"
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
},
{
- "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
- "title": "GoogleCalendarCheckAvailabilityTool"
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
},
{
- "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
- "title": "SlackSendMessageTool"
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "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"
- }
+ "type": {
+ "type": "string",
+ "enum": [
+ "gohighlevel.calendar.event.create"
+ ],
+ "description": "The type of tool. \"gohighlevel.calendar.event.create\" for GoHighLevel Calendar event create tool."
},
- "knowledgeBase": {
- "description": "These are the options for the knowledge base.",
- "oneOf": [
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
{
- "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
- "title": "Custom"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "CreateGoHighLevelContactCreateToolDTO": {
+ "type": "object",
+ "properties": {
+ "messages": {
+ "type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
+ }
},
- "knowledgeBaseId": {
- "type": "string",
- "description": "This is the ID of the knowledge base the model will use."
- },
- "provider": {
+ "type": {
"type": "string",
- "description": "This is the provider that will be used for the model.",
"enum": [
- "openai"
- ]
+ "gohighlevel.contact.create"
+ ],
+ "description": "The type of tool. \"gohighlevel.contact.create\" for GoHighLevel contact create tool."
},
- "model": {
- "type": "string",
- "description": "This is the OpenAI model that will be used.",
- "enum": [
- "gpt-4.1",
- "gpt-4.1-mini",
- "gpt-4.1-nano",
- "gpt-4.5-preview",
- "chatgpt-4o-latest",
- "o3-mini",
- "o1-preview",
- "o1-preview-2024-09-12",
- "o1-mini",
- "o1-mini-2024-09-12",
- "gpt-4o-realtime-preview-2024-10-01",
- "gpt-4o-realtime-preview-2024-12-17",
- "gpt-4o-mini-realtime-preview-2024-12-17",
- "gpt-4o-mini-2024-07-18",
- "gpt-4o-mini",
- "gpt-4o",
- "gpt-4o-2024-05-13",
- "gpt-4o-2024-08-06",
- "gpt-4o-2024-11-20",
- "gpt-4-turbo",
- "gpt-4-turbo-2024-04-09",
- "gpt-4-turbo-preview",
- "gpt-4-0125-preview",
- "gpt-4-1106-preview",
- "gpt-4",
- "gpt-4-0613",
- "gpt-3.5-turbo",
- "gpt-3.5-turbo-0125",
- "gpt-3.5-turbo-1106",
- "gpt-3.5-turbo-16k",
- "gpt-3.5-turbo-0613"
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
]
- },
- "fallbackModels": {
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "CreateGoHighLevelContactGetToolDTO": {
+ "type": "object",
+ "properties": {
+ "messages": {
"type": "array",
- "description": "These are the fallback models that will be used if the primary model fails. This shouldn't be specified unless you have a specific reason to do so. Vapi will automatically find the fastest fallbacks that make sense.",
- "enum": [
- "gpt-4.1",
- "gpt-4.1-mini",
- "gpt-4.1-nano",
- "gpt-4.5-preview",
- "chatgpt-4o-latest",
- "o3-mini",
- "o1-preview",
- "o1-preview-2024-09-12",
- "o1-mini",
- "o1-mini-2024-09-12",
- "gpt-4o-realtime-preview-2024-10-01",
- "gpt-4o-realtime-preview-2024-12-17",
- "gpt-4o-mini-realtime-preview-2024-12-17",
- "gpt-4o-mini-2024-07-18",
- "gpt-4o-mini",
- "gpt-4o",
- "gpt-4o-2024-05-13",
- "gpt-4o-2024-08-06",
- "gpt-4o-2024-11-20",
- "gpt-4-turbo",
- "gpt-4-turbo-2024-04-09",
- "gpt-4-turbo-preview",
- "gpt-4-0125-preview",
- "gpt-4-1106-preview",
- "gpt-4",
- "gpt-4-0613",
- "gpt-3.5-turbo",
- "gpt-3.5-turbo-0125",
- "gpt-3.5-turbo-1106",
- "gpt-3.5-turbo-16k",
- "gpt-3.5-turbo-0613"
- ],
- "example": [
- "gpt-4-0125-preview",
- "gpt-4-0613"
- ],
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
- "type": "string",
- "enum": [
- "gpt-4.1",
- "gpt-4.1-mini",
- "gpt-4.1-nano",
- "gpt-4.5-preview",
- "chatgpt-4o-latest",
- "o3-mini",
- "o1-preview",
- "o1-preview-2024-09-12",
- "o1-mini",
- "o1-mini-2024-09-12",
- "gpt-4o-realtime-preview-2024-10-01",
- "gpt-4o-realtime-preview-2024-12-17",
- "gpt-4o-mini-realtime-preview-2024-12-17",
- "gpt-4o-mini-2024-07-18",
- "gpt-4o-mini",
- "gpt-4o",
- "gpt-4o-2024-05-13",
- "gpt-4o-2024-08-06",
- "gpt-4o-2024-11-20",
- "gpt-4-turbo",
- "gpt-4-turbo-2024-04-09",
- "gpt-4-turbo-preview",
- "gpt-4-0125-preview",
- "gpt-4-1106-preview",
- "gpt-4",
- "gpt-4-0613",
- "gpt-3.5-turbo",
- "gpt-3.5-turbo-0125",
- "gpt-3.5-turbo-1106",
- "gpt-3.5-turbo-16k",
- "gpt-3.5-turbo-0613"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
]
}
},
- "temperature": {
- "type": "number",
- "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.",
- "minimum": 0,
- "maximum": 2
- },
- "maxTokens": {
- "type": "number",
- "description": "This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.",
- "minimum": 50,
- "maximum": 10000
- },
- "emotionRecognitionEnabled": {
- "type": "boolean",
- "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.\n\n@default false"
+ "type": {
+ "type": "string",
+ "enum": [
+ "gohighlevel.contact.get"
+ ],
+ "description": "The type of tool. \"gohighlevel.contact.get\" for GoHighLevel contact get tool."
},
- "numFastTurns": {
- "type": "number",
- "description": "This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0",
- "minimum": 0
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
}
},
"required": [
- "provider",
- "model"
+ "type"
]
},
- "OpenRouterModel": {
+ "AnyscaleModel": {
"type": "object",
"properties": {
"messages": {
@@ -10461,6 +11252,18 @@
"description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
"items": {
"oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateApiRequestToolDTO",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateBashToolDTO",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateComputerToolDTO",
+ "title": "ComputerTool"
+ },
{
"$ref": "#/components/schemas/CreateDtmfToolDTO",
"title": "DtmfTool"
@@ -10469,29 +11272,29 @@
"$ref": "#/components/schemas/CreateEndCallToolDTO",
"title": "EndCallTool"
},
- {
- "$ref": "#/components/schemas/CreateVoicemailToolDTO",
- "title": "VoicemailTool"
- },
{
"$ref": "#/components/schemas/CreateFunctionToolDTO",
"title": "FunctionTool"
},
{
- "$ref": "#/components/schemas/CreateGhlToolDTO",
- "title": "GhlTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
},
{
- "$ref": "#/components/schemas/CreateMakeToolDTO",
- "title": "MakeTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
},
{
- "$ref": "#/components/schemas/CreateTransferCallToolDTO",
- "title": "TransferTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
},
{
- "$ref": "#/components/schemas/CreateQueryToolDTO",
- "title": "QueryTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
},
{
"$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
@@ -10502,12 +11305,28 @@
"title": "GoogleSheetsRowAppendTool"
},
{
- "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
- "title": "GoogleCalendarCheckAvailabilityTool"
+ "$ref": "#/components/schemas/CreateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateQueryToolDTO",
+ "title": "QueryTool"
},
{
"$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
"title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmsToolDTO",
+ "title": "SmsTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTextEditorToolDTO",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTransferCallToolDTO",
+ "title": "TransferCallTool"
}
]
}
@@ -10535,7 +11354,7 @@
"provider": {
"type": "string",
"enum": [
- "openrouter"
+ "anyscale"
]
},
"model": {
@@ -10569,10 +11388,31 @@
"model"
]
},
- "PerplexityAIModel": {
+ "AnthropicThinkingConfig": {
"type": "object",
"properties": {
- "messages": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "enabled"
+ ]
+ },
+ "budgetTokens": {
+ "type": "number",
+ "description": "The maximum number of tokens to allocate for thinking.\nMust be between 1024 and 100000 tokens.",
+ "minimum": 1024,
+ "maximum": 100000
+ }
+ },
+ "required": [
+ "type",
+ "budgetTokens"
+ ]
+ },
+ "AnthropicModel": {
+ "type": "object",
+ "properties": {
+ "messages": {
"description": "This is the starting state for the conversation.",
"type": "array",
"items": {
@@ -10584,6 +11424,18 @@
"description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
"items": {
"oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateApiRequestToolDTO",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateBashToolDTO",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateComputerToolDTO",
+ "title": "ComputerTool"
+ },
{
"$ref": "#/components/schemas/CreateDtmfToolDTO",
"title": "DtmfTool"
@@ -10592,29 +11444,29 @@
"$ref": "#/components/schemas/CreateEndCallToolDTO",
"title": "EndCallTool"
},
- {
- "$ref": "#/components/schemas/CreateVoicemailToolDTO",
- "title": "VoicemailTool"
- },
{
"$ref": "#/components/schemas/CreateFunctionToolDTO",
"title": "FunctionTool"
},
{
- "$ref": "#/components/schemas/CreateGhlToolDTO",
- "title": "GhlTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
},
{
- "$ref": "#/components/schemas/CreateMakeToolDTO",
- "title": "MakeTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
},
{
- "$ref": "#/components/schemas/CreateTransferCallToolDTO",
- "title": "TransferTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
},
{
- "$ref": "#/components/schemas/CreateQueryToolDTO",
- "title": "QueryTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
},
{
"$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
@@ -10625,12 +11477,28 @@
"title": "GoogleSheetsRowAppendTool"
},
{
- "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
- "title": "GoogleCalendarCheckAvailabilityTool"
+ "$ref": "#/components/schemas/CreateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateQueryToolDTO",
+ "title": "QueryTool"
},
{
"$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
"title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmsToolDTO",
+ "title": "SmsTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTextEditorToolDTO",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTransferCallToolDTO",
+ "title": "TransferCallTool"
}
]
}
@@ -10655,15 +11523,35 @@
"type": "string",
"description": "This is the ID of the knowledge base the model will use."
},
- "provider": {
+ "model": {
"type": "string",
+ "description": "The specific Anthropic/Claude model that will be used.",
"enum": [
- "perplexity-ai"
+ "claude-3-opus-20240229",
+ "claude-3-sonnet-20240229",
+ "claude-3-haiku-20240307",
+ "claude-3-5-sonnet-20240620",
+ "claude-3-5-sonnet-20241022",
+ "claude-3-5-haiku-20241022",
+ "claude-3-7-sonnet-20250219",
+ "claude-opus-4-20250514",
+ "claude-sonnet-4-20250514"
]
},
- "model": {
+ "provider": {
"type": "string",
- "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b"
+ "description": "The provider identifier for Anthropic.",
+ "enum": [
+ "anthropic"
+ ]
+ },
+ "thinking": {
+ "description": "Optional configuration for Anthropic's thinking feature.\nOnly applicable for claude-3-7-sonnet-20250219 model.\nIf provided, maxTokens must be greater than thinking.budgetTokens.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AnthropicThinkingConfig"
+ }
+ ]
},
"temperature": {
"type": "number",
@@ -10688,11 +11576,11 @@
}
},
"required": [
- "provider",
- "model"
+ "model",
+ "provider"
]
},
- "TogetherAIModel": {
+ "CerebrasModel": {
"type": "object",
"properties": {
"messages": {
@@ -10707,6 +11595,18 @@
"description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
"items": {
"oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateApiRequestToolDTO",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateBashToolDTO",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateComputerToolDTO",
+ "title": "ComputerTool"
+ },
{
"$ref": "#/components/schemas/CreateDtmfToolDTO",
"title": "DtmfTool"
@@ -10715,29 +11615,29 @@
"$ref": "#/components/schemas/CreateEndCallToolDTO",
"title": "EndCallTool"
},
- {
- "$ref": "#/components/schemas/CreateVoicemailToolDTO",
- "title": "VoicemailTool"
- },
{
"$ref": "#/components/schemas/CreateFunctionToolDTO",
"title": "FunctionTool"
},
{
- "$ref": "#/components/schemas/CreateGhlToolDTO",
- "title": "GhlTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
},
{
- "$ref": "#/components/schemas/CreateMakeToolDTO",
- "title": "MakeTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
},
{
- "$ref": "#/components/schemas/CreateTransferCallToolDTO",
- "title": "TransferTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
},
{
- "$ref": "#/components/schemas/CreateQueryToolDTO",
- "title": "QueryTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
},
{
"$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
@@ -10748,12 +11648,28 @@
"title": "GoogleSheetsRowAppendTool"
},
{
- "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
- "title": "GoogleCalendarCheckAvailabilityTool"
+ "$ref": "#/components/schemas/CreateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateQueryToolDTO",
+ "title": "QueryTool"
},
{
"$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
"title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmsToolDTO",
+ "title": "SmsTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTextEditorToolDTO",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTransferCallToolDTO",
+ "title": "TransferCallTool"
}
]
}
@@ -10778,15 +11694,19 @@
"type": "string",
"description": "This is the ID of the knowledge base the model will use."
},
- "provider": {
+ "model": {
"type": "string",
+ "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b",
"enum": [
- "together-ai"
+ "llama3.1-8b",
+ "llama-3.3-70b"
]
},
- "model": {
+ "provider": {
"type": "string",
- "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b"
+ "enum": [
+ "cerebras"
+ ]
},
"temperature": {
"type": "number",
@@ -10811,227 +11731,183 @@
}
},
"required": [
- "provider",
- "model"
- ]
- },
- "AIEdgeCondition": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "ai"
- ]
- },
- "prompt": {
- "type": "string",
- "description": "This is the prompt for the AI edge condition. It should evaluate to a boolean.",
- "maxLength": 1000
- }
- },
- "required": [
- "type",
- "prompt"
- ]
- },
- "LogicEdgeCondition": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "logic"
- ]
- },
- "liquid": {
- "type": "string",
- "maxLength": 100
- }
- },
- "required": [
- "type",
- "liquid"
- ]
- },
- "FailedEdgeCondition": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "failed"
- ]
- }
- },
- "required": [
- "type"
+ "model",
+ "provider"
]
},
- "Edge": {
+ "CustomLLMModel": {
"type": "object",
"properties": {
- "condition": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/AIEdgeCondition",
- "title": "AIEdgeCondition"
- },
- {
- "$ref": "#/components/schemas/LogicEdgeCondition",
- "title": "LogicEdgeCondition"
- },
- {
- "$ref": "#/components/schemas/FailedEdgeCondition",
- "title": "FailedEdgeCondition"
- }
- ]
- },
- "from": {
- "type": "string",
- "maxLength": 80
- },
- "to": {
- "type": "string",
- "maxLength": 80
+ "messages": {
+ "description": "This is the starting state for the conversation.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OpenAIMessage"
+ }
},
- "metadata": {
- "type": "object",
- "description": "This is for metadata you want to store on the edge."
- }
- },
- "required": [
- "from",
- "to"
- ]
- },
- "Workflow": {
- "type": "object",
- "properties": {
- "nodes": {
+ "tools": {
"type": "array",
+ "description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/Say",
- "title": "Say"
+ "$ref": "#/components/schemas/CreateApiRequestToolDTO",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateBashToolDTO",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateComputerToolDTO",
+ "title": "ComputerTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDtmfToolDTO",
+ "title": "DtmfTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateEndCallToolDTO",
+ "title": "EndCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateFunctionToolDTO",
+ "title": "FunctionTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
+ "title": "GoogleCalendarCreateEventTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
+ "title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateQueryToolDTO",
+ "title": "QueryTool"
},
{
- "$ref": "#/components/schemas/Gather",
- "title": "Gather"
+ "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
+ "title": "SlackSendMessageTool"
},
{
- "$ref": "#/components/schemas/ApiRequest",
- "title": "ApiRequest"
+ "$ref": "#/components/schemas/CreateSmsToolDTO",
+ "title": "SmsTool"
},
{
- "$ref": "#/components/schemas/Hangup",
- "title": "Hangup"
+ "$ref": "#/components/schemas/CreateTextEditorToolDTO",
+ "title": "TextEditorTool"
},
{
- "$ref": "#/components/schemas/Transfer",
- "title": "Transfer"
+ "$ref": "#/components/schemas/CreateTransferCallToolDTO",
+ "title": "TransferCallTool"
}
]
}
},
- "model": {
- "description": "These are the options for the workflow's LLM.",
+ "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"
+ }
+ },
+ "knowledgeBase": {
+ "description": "These are the options for the knowledge base.",
"oneOf": [
{
- "$ref": "#/components/schemas/AnthropicModel",
- "title": "Anthropic"
- },
- {
- "$ref": "#/components/schemas/AnyscaleModel",
- "title": "Anyscale"
- },
- {
- "$ref": "#/components/schemas/CerebrasModel",
- "title": "Cerebras"
- },
- {
- "$ref": "#/components/schemas/CustomLLMModel",
- "title": "CustomLLM"
- },
- {
- "$ref": "#/components/schemas/DeepInfraModel",
- "title": "DeepInfra"
- },
- {
- "$ref": "#/components/schemas/DeepSeekModel",
- "title": "DeepSeek"
- },
- {
- "$ref": "#/components/schemas/GoogleModel",
- "title": "Google"
- },
- {
- "$ref": "#/components/schemas/GroqModel",
- "title": "Groq"
- },
- {
- "$ref": "#/components/schemas/InflectionAIModel",
- "title": "InflectionAI"
- },
- {
- "$ref": "#/components/schemas/OpenAIModel",
- "title": "OpenAI"
- },
- {
- "$ref": "#/components/schemas/OpenRouterModel",
- "title": "OpenRouter"
- },
- {
- "$ref": "#/components/schemas/PerplexityAIModel",
- "title": "PerplexityAI"
- },
- {
- "$ref": "#/components/schemas/TogetherAIModel",
- "title": "Together"
- },
- {
- "$ref": "#/components/schemas/XaiModel",
- "title": "XAI"
+ "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
+ "title": "Custom"
}
]
},
- "id": {
- "type": "string"
+ "knowledgeBaseId": {
+ "type": "string",
+ "description": "This is the ID of the knowledge base the model will use."
},
- "orgId": {
- "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"
+ ]
},
- "createdAt": {
- "format": "date-time",
- "type": "string"
+ "metadataSendMode": {
+ "type": "string",
+ "description": "This determines whether metadata is sent in requests to the custom provider.\n\n- `off` will not send any metadata. payload will look like `{ messages }`\n- `variable` will send `assistant.metadata` as a variable on the payload. payload will look like `{ messages, metadata }`\n- `destructured` will send `assistant.metadata` fields directly on the payload. payload will look like `{ messages, ...metadata }`\n\nFurther, `variable` and `destructured` will send `call`, `phoneNumber`, and `customer` objects in the payload.\n\nDefault is `variable`.",
+ "enum": [
+ "off",
+ "variable",
+ "destructured"
+ ]
},
- "updatedAt": {
- "format": "date-time",
- "type": "string"
+ "url": {
+ "type": "string",
+ "description": "These is the URL we'll use for the OpenAI client's `baseURL`. Ex. https://openrouter.ai/api/v1"
},
- "name": {
+ "timeoutSeconds": {
+ "type": "number",
+ "description": "This sets the timeout for the connection to the custom provider without needing to stream any tokens back. Default is 20 seconds.",
+ "minimum": 20,
+ "maximum": 600
+ },
+ "model": {
"type": "string",
- "maxLength": 80
+ "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b"
},
- "edges": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Edge"
- }
+ "temperature": {
+ "type": "number",
+ "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.",
+ "minimum": 0,
+ "maximum": 2
+ },
+ "maxTokens": {
+ "type": "number",
+ "description": "This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.",
+ "minimum": 50,
+ "maximum": 10000
+ },
+ "emotionRecognitionEnabled": {
+ "type": "boolean",
+ "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.\n\n@default false"
+ },
+ "numFastTurns": {
+ "type": "number",
+ "description": "This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0",
+ "minimum": 0
}
},
"required": [
- "nodes",
- "id",
- "orgId",
- "createdAt",
- "updatedAt",
- "name",
- "edges"
+ "provider",
+ "url",
+ "model"
]
},
- "VapiModel": {
+ "DeepInfraModel": {
"type": "object",
"properties": {
"messages": {
@@ -11046,6 +11922,18 @@
"description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
"items": {
"oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateApiRequestToolDTO",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateBashToolDTO",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateComputerToolDTO",
+ "title": "ComputerTool"
+ },
{
"$ref": "#/components/schemas/CreateDtmfToolDTO",
"title": "DtmfTool"
@@ -11054,29 +11942,29 @@
"$ref": "#/components/schemas/CreateEndCallToolDTO",
"title": "EndCallTool"
},
- {
- "$ref": "#/components/schemas/CreateVoicemailToolDTO",
- "title": "VoicemailTool"
- },
{
"$ref": "#/components/schemas/CreateFunctionToolDTO",
"title": "FunctionTool"
},
{
- "$ref": "#/components/schemas/CreateGhlToolDTO",
- "title": "GhlTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
},
{
- "$ref": "#/components/schemas/CreateMakeToolDTO",
- "title": "MakeTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
},
{
- "$ref": "#/components/schemas/CreateTransferCallToolDTO",
- "title": "TransferTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
},
{
- "$ref": "#/components/schemas/CreateQueryToolDTO",
- "title": "QueryTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
},
{
"$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
@@ -11087,12 +11975,28 @@
"title": "GoogleSheetsRowAppendTool"
},
{
- "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
- "title": "GoogleCalendarCheckAvailabilityTool"
+ "$ref": "#/components/schemas/CreateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateQueryToolDTO",
+ "title": "QueryTool"
},
{
"$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
"title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmsToolDTO",
+ "title": "SmsTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTextEditorToolDTO",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTransferCallToolDTO",
+ "title": "TransferCallTool"
}
]
}
@@ -11120,19 +12024,7 @@
"provider": {
"type": "string",
"enum": [
- "vapi"
- ]
- },
- "workflowId": {
- "type": "string",
- "description": "This is the workflow that will be used for the call. To use a transient workflow, use `workflow` instead."
- },
- "workflow": {
- "description": "This is the workflow that will be used for the call. To use an existing workflow, use `workflowId` instead.",
- "allOf": [
- {
- "$ref": "#/components/schemas/Workflow"
- }
+ "deepinfra"
]
},
"model": {
@@ -11166,7 +12058,7 @@
"model"
]
},
- "XaiModel": {
+ "DeepSeekModel": {
"type": "object",
"properties": {
"messages": {
@@ -11181,6 +12073,18 @@
"description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
"items": {
"oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateApiRequestToolDTO",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateBashToolDTO",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateComputerToolDTO",
+ "title": "ComputerTool"
+ },
{
"$ref": "#/components/schemas/CreateDtmfToolDTO",
"title": "DtmfTool"
@@ -11189,29 +12093,29 @@
"$ref": "#/components/schemas/CreateEndCallToolDTO",
"title": "EndCallTool"
},
- {
- "$ref": "#/components/schemas/CreateVoicemailToolDTO",
- "title": "VoicemailTool"
- },
{
"$ref": "#/components/schemas/CreateFunctionToolDTO",
"title": "FunctionTool"
},
{
- "$ref": "#/components/schemas/CreateGhlToolDTO",
- "title": "GhlTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
},
{
- "$ref": "#/components/schemas/CreateMakeToolDTO",
- "title": "MakeTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
},
{
- "$ref": "#/components/schemas/CreateTransferCallToolDTO",
- "title": "TransferTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
},
{
- "$ref": "#/components/schemas/CreateQueryToolDTO",
- "title": "QueryTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
},
{
"$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
@@ -11222,12 +12126,28 @@
"title": "GoogleSheetsRowAppendTool"
},
{
- "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
- "title": "GoogleCalendarCheckAvailabilityTool"
+ "$ref": "#/components/schemas/CreateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateQueryToolDTO",
+ "title": "QueryTool"
},
{
"$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
"title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmsToolDTO",
+ "title": "SmsTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTextEditorToolDTO",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTransferCallToolDTO",
+ "title": "TransferCallTool"
}
]
}
@@ -11256,15 +12176,14 @@
"type": "string",
"description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b",
"enum": [
- "grok-beta",
- "grok-2",
- "grok-3"
+ "deepseek-chat",
+ "deepseek-reasoner"
]
},
"provider": {
"type": "string",
"enum": [
- "xai"
+ "deep-seek"
]
},
"temperature": {
@@ -11294,7026 +12213,12032 @@
"provider"
]
},
- "ExactReplacement": {
+ "GeminiMultimodalLivePrebuiltVoiceConfig": {
"type": "object",
"properties": {
- "type": {
+ "voiceName": {
"type": "string",
- "description": "This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'Vapi', value: 'Vappy' }",
"enum": [
- "exact"
+ "Puck",
+ "Charon",
+ "Kore",
+ "Fenrir",
+ "Aoede"
]
- },
- "replaceAllEnabled": {
- "type": "boolean",
- "description": "This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false",
- "default": false
- },
- "key": {
- "type": "string",
- "description": "This is the key to replace."
- },
- "value": {
- "type": "string",
- "description": "This is the value that will replace the match.",
- "maxLength": 1000
}
},
"required": [
- "type",
- "key",
- "value"
+ "voiceName"
]
},
- "RegexOption": {
+ "GeminiMultimodalLiveVoiceConfig": {
"type": "object",
"properties": {
- "type": {
- "type": "string",
- "description": "This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.",
- "enum": [
- "ignore-case",
- "whole-word",
- "multi-line"
- ]
- },
- "enabled": {
- "type": "boolean",
- "description": "This is whether to enable the option.\n\n@default false"
+ "prebuiltVoiceConfig": {
+ "$ref": "#/components/schemas/GeminiMultimodalLivePrebuiltVoiceConfig"
}
},
"required": [
- "type",
- "enabled"
+ "prebuiltVoiceConfig"
]
},
- "RegexReplacement": {
+ "GeminiMultimodalLiveSpeechConfig": {
"type": "object",
"properties": {
- "type": {
- "type": "string",
- "description": "This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?<=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }",
- "enum": [
- "regex"
- ]
- },
- "regex": {
- "type": "string",
- "description": "This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead."
- },
- "options": {
- "description": "These are the options for the regex replacement. Defaults to all disabled.\n\n@default []",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RegexOption"
- }
- },
- "value": {
- "type": "string",
- "description": "This is the value that will replace the match.",
- "maxLength": 1000
+ "voiceConfig": {
+ "$ref": "#/components/schemas/GeminiMultimodalLiveVoiceConfig"
}
},
"required": [
- "type",
- "regex",
- "value"
+ "voiceConfig"
]
},
- "FormatPlan": {
+ "GoogleRealtimeConfig": {
"type": "object",
"properties": {
- "enabled": {
- "type": "boolean",
- "description": "This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true",
- "example": true
+ "topP": {
+ "type": "number",
+ "description": "This is the nucleus sampling parameter that controls the cumulative probability of tokens considered during text generation.\nOnly applicable with the Gemini Flash 2.0 Multimodal Live API."
},
- "numberToDigitsCutoff": {
+ "topK": {
"type": "number",
- "description": "This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025",
- "minimum": 0,
- "example": 2025
+ "description": "This is the top-k sampling parameter that limits the number of highest probability tokens considered during text generation.\nOnly applicable with the Gemini Flash 2.0 Multimodal Live API."
},
- "replacements": {
+ "presencePenalty": {
+ "type": "number",
+ "description": "This is the presence penalty parameter that influences the model's likelihood to repeat information by penalizing tokens based on their presence in the text.\nOnly applicable with the Gemini Flash 2.0 Multimodal Live API."
+ },
+ "frequencyPenalty": {
+ "type": "number",
+ "description": "This is the frequency penalty parameter that influences the model's likelihood to repeat tokens by penalizing them based on their frequency in the text.\nOnly applicable with the Gemini Flash 2.0 Multimodal Live API."
+ },
+ "speechConfig": {
+ "description": "This is the speech configuration object that defines the voice settings to be used for the model's speech output.\nOnly applicable with the Gemini Flash 2.0 Multimodal Live API.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GeminiMultimodalLiveSpeechConfig"
+ }
+ ]
+ }
+ }
+ },
+ "GoogleModel": {
+ "type": "object",
+ "properties": {
+ "messages": {
+ "description": "This is the starting state for the conversation.",
"type": "array",
- "description": "These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []",
+ "items": {
+ "$ref": "#/components/schemas/OpenAIMessage"
+ }
+ },
+ "tools": {
+ "type": "array",
+ "description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/ExactReplacement",
- "title": "ExactReplacement"
+ "$ref": "#/components/schemas/CreateApiRequestToolDTO",
+ "title": "ApiRequestTool"
},
{
- "$ref": "#/components/schemas/RegexReplacement",
- "title": "RegexReplacement"
+ "$ref": "#/components/schemas/CreateBashToolDTO",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateComputerToolDTO",
+ "title": "ComputerTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDtmfToolDTO",
+ "title": "DtmfTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateEndCallToolDTO",
+ "title": "EndCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateFunctionToolDTO",
+ "title": "FunctionTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
+ "title": "GoogleCalendarCreateEventTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
+ "title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateQueryToolDTO",
+ "title": "QueryTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
+ "title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmsToolDTO",
+ "title": "SmsTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTextEditorToolDTO",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTransferCallToolDTO",
+ "title": "TransferCallTool"
}
]
}
},
- "formattersEnabled": {
+ "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",
- "description": "List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined",
- "enum": [
- "markdown",
- "asterisk",
- "quote",
- "dash",
- "newline",
- "colon",
- "acronym",
- "dollarAmount",
- "email",
- "date",
- "time",
- "distance",
- "unit",
- "percentage",
- "phoneNumber",
- "number"
- ],
"items": {
- "type": "string",
- "enum": [
- "markdown",
- "asterisk",
- "quote",
- "dash",
- "newline",
- "colon",
- "acronym",
- "dollarAmount",
- "email",
- "date",
- "time",
- "distance",
- "unit",
- "percentage",
- "phoneNumber",
- "number"
- ]
+ "type": "string"
}
- }
- }
- },
- "ChunkPlan": {
- "type": "object",
- "properties": {
- "enabled": {
- "type": "boolean",
- "description": "This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, Vapi-provided audio control tokens like will not work.\n\n@default true",
- "example": true
},
- "minCharacters": {
- "type": "number",
- "description": "This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30",
- "minimum": 1,
- "maximum": 80,
- "example": 30
+ "knowledgeBase": {
+ "description": "These are the options for the knowledge base.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
+ "title": "Custom"
+ }
+ ]
},
- "punctuationBoundaries": {
- "type": "array",
- "description": "These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.",
+ "knowledgeBaseId": {
+ "type": "string",
+ "description": "This is the ID of the knowledge base the model will use."
+ },
+ "model": {
+ "type": "string",
+ "description": "This is the Google model that will be used.",
"enum": [
- "。",
- "，",
- ".",
- "!",
- "?",
- ";",
- ")",
- "،",
- "۔",
- "।",
- "॥",
- "|",
- "||",
- ",",
- ":"
- ],
- "example": [
- "。",
- "，",
- ".",
- "!",
- "?",
- ";",
- "،",
- "۔",
- "।",
- "॥",
- "|",
- "||",
- ",",
- ":"
- ],
- "items": {
- "type": "string",
- "enum": [
- "。",
- "，",
- ".",
- "!",
- "?",
- ";",
- ")",
- "،",
- "۔",
- "।",
- "॥",
- "|",
- "||",
- ",",
- ":"
- ]
- }
+ "gemini-2.5-pro-preview-05-06",
+ "gemini-2.5-flash-preview-05-20",
+ "gemini-2.5-flash-preview-04-17",
+ "gemini-2.0-flash-thinking-exp",
+ "gemini-2.0-pro-exp-02-05",
+ "gemini-2.0-flash",
+ "gemini-2.0-flash-lite",
+ "gemini-2.0-flash-lite-preview-02-05",
+ "gemini-2.0-flash-exp",
+ "gemini-2.0-flash-realtime-exp",
+ "gemini-1.5-flash",
+ "gemini-1.5-flash-002",
+ "gemini-1.5-pro",
+ "gemini-1.5-pro-002",
+ "gemini-1.0-pro"
+ ]
},
- "formatPlan": {
- "description": "This is the plan for formatting the chunk before it is sent to the voice provider.",
+ "provider": {
+ "type": "string",
+ "enum": [
+ "google"
+ ]
+ },
+ "realtimeConfig": {
+ "description": "This is the session configuration for the Gemini Flash 2.0 Multimodal Live API.\nOnly applicable if the model `gemini-2.0-flash-realtime-exp` is selected.",
"allOf": [
{
- "$ref": "#/components/schemas/FormatPlan"
+ "$ref": "#/components/schemas/GoogleRealtimeConfig"
}
]
+ },
+ "temperature": {
+ "type": "number",
+ "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.",
+ "minimum": 0,
+ "maximum": 2
+ },
+ "maxTokens": {
+ "type": "number",
+ "description": "This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.",
+ "minimum": 50,
+ "maximum": 10000
+ },
+ "emotionRecognitionEnabled": {
+ "type": "boolean",
+ "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.\n\n@default false"
+ },
+ "numFastTurns": {
+ "type": "number",
+ "description": "This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0",
+ "minimum": 0
}
- }
+ },
+ "required": [
+ "model",
+ "provider"
+ ]
},
- "FallbackPlan": {
+ "GroqModel": {
"type": "object",
"properties": {
- "voices": {
+ "messages": {
+ "description": "This is the starting state for the conversation.",
"type": "array",
- "description": "This is the list of voices to fallback to in the event that the primary voice provider fails.",
+ "items": {
+ "$ref": "#/components/schemas/OpenAIMessage"
+ }
+ },
+ "tools": {
+ "type": "array",
+ "description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/FallbackAzureVoice",
- "title": "Azure"
+ "$ref": "#/components/schemas/CreateApiRequestToolDTO",
+ "title": "ApiRequestTool"
},
{
- "$ref": "#/components/schemas/FallbackCartesiaVoice",
- "title": "Cartesia"
+ "$ref": "#/components/schemas/CreateBashToolDTO",
+ "title": "BashTool"
},
{
- "$ref": "#/components/schemas/FallbackHumeVoice",
- "title": "Hume"
+ "$ref": "#/components/schemas/CreateComputerToolDTO",
+ "title": "ComputerTool"
},
{
- "$ref": "#/components/schemas/FallbackCustomVoice",
- "title": "CustomVoice"
+ "$ref": "#/components/schemas/CreateDtmfToolDTO",
+ "title": "DtmfTool"
},
{
- "$ref": "#/components/schemas/FallbackDeepgramVoice",
- "title": "Deepgram"
+ "$ref": "#/components/schemas/CreateEndCallToolDTO",
+ "title": "EndCallTool"
},
{
- "$ref": "#/components/schemas/FallbackElevenLabsVoice",
- "title": "ElevenLabs"
+ "$ref": "#/components/schemas/CreateFunctionToolDTO",
+ "title": "FunctionTool"
},
{
- "$ref": "#/components/schemas/FallbackVapiVoice",
- "title": "Vapi"
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
},
{
- "$ref": "#/components/schemas/FallbackLMNTVoice",
- "title": "LMNT"
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
},
{
- "$ref": "#/components/schemas/FallbackOpenAIVoice",
- "title": "OpenAI"
+ "$ref": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
},
{
- "$ref": "#/components/schemas/FallbackPlayHTVoice",
- "title": "PlayHT"
+ "$ref": "#/components/schemas/CreateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
},
{
- "$ref": "#/components/schemas/FallbackRimeAIVoice",
- "title": "RimeAI"
+ "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
},
{
- "$ref": "#/components/schemas/FallbackSmallestAIVoice",
- "title": "Smallest AI"
+ "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
+ "title": "GoogleCalendarCreateEventTool"
},
{
- "$ref": "#/components/schemas/FallbackTavusVoice",
- "title": "TavusVoice"
+ "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
+ "title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateQueryToolDTO",
+ "title": "QueryTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
+ "title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmsToolDTO",
+ "title": "SmsTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTextEditorToolDTO",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTransferCallToolDTO",
+ "title": "TransferCallTool"
}
]
}
- }
- },
- "required": [
- "voices"
- ]
- },
- "AzureVoice": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "description": "This is the voice provider that will be used.",
- "enum": [
- "azure"
- ]
},
- "voiceId": {
- "description": "This is the provider-specific ID that will be used.",
+ "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"
+ }
+ },
+ "knowledgeBase": {
+ "description": "These are the options for the knowledge base.",
"oneOf": [
{
- "type": "string",
- "enum": [
- "andrew",
- "brian",
- "emma"
- ],
- "title": "Preset Voice Options"
- },
- {
- "type": "string",
- "title": "Azure Voice ID"
+ "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
+ "title": "Custom"
}
]
},
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
- {
- "$ref": "#/components/schemas/ChunkPlan"
- }
+ "knowledgeBaseId": {
+ "type": "string",
+ "description": "This is the ID of the knowledge base the model will use."
+ },
+ "model": {
+ "type": "string",
+ "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b",
+ "enum": [
+ "deepseek-r1-distill-llama-70b",
+ "llama-3.3-70b-versatile",
+ "llama-3.1-405b-reasoning",
+ "llama-3.1-8b-instant",
+ "llama3-8b-8192",
+ "llama3-70b-8192",
+ "gemma2-9b-it",
+ "meta-llama/llama-4-maverick-17b-128e-instruct",
+ "meta-llama/llama-4-scout-17b-16e-instruct",
+ "mistral-saba-24b",
+ "compound-beta",
+ "compound-beta-mini"
]
},
- "speed": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "groq"
+ ]
+ },
+ "temperature": {
"type": "number",
- "description": "This is the speed multiplier that will be used.",
- "minimum": 0.5,
+ "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.",
+ "minimum": 0,
"maximum": 2
},
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
- "allOf": [
- {
- "$ref": "#/components/schemas/FallbackPlan"
- }
- ]
+ "maxTokens": {
+ "type": "number",
+ "description": "This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.",
+ "minimum": 50,
+ "maximum": 10000
+ },
+ "emotionRecognitionEnabled": {
+ "type": "boolean",
+ "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.\n\n@default false"
+ },
+ "numFastTurns": {
+ "type": "number",
+ "description": "This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0",
+ "minimum": 0
}
},
"required": [
- "provider",
- "voiceId"
+ "model",
+ "provider"
]
},
- "CartesiaExperimentalControls": {
+ "InflectionAIModel": {
"type": "object",
"properties": {
- "speed": {
- "oneOf": [
- {
- "type": "string",
- "enum": [
- "slowest",
- "slow",
- "normal",
- "fast",
- "fastest"
- ],
- "example": "normal"
- },
- {
- "type": "number",
- "minimum": -1,
- "maximum": 1,
- "example": 0.5
- }
- ]
+ "messages": {
+ "description": "This is the starting state for the conversation.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OpenAIMessage"
+ }
},
- "emotion": {
- "type": "string",
- "enum": [
- "anger:lowest",
- "anger:low",
- "anger:high",
- "anger:highest",
- "positivity:lowest",
- "positivity:low",
- "positivity:high",
- "positivity:highest",
- "surprise:lowest",
- "surprise:low",
- "surprise:high",
- "surprise:highest",
- "sadness:lowest",
- "sadness:low",
- "sadness:high",
- "sadness:highest",
- "curiosity:lowest",
- "curiosity:low",
- "curiosity:high",
- "curiosity:highest"
- ],
- "example": [
- "happiness:high"
- ]
- }
- }
- },
- "CartesiaVoice": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "description": "This is the voice provider that will be used.",
- "enum": [
- "cartesia"
+ "tools": {
+ "type": "array",
+ "description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateApiRequestToolDTO",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateBashToolDTO",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateComputerToolDTO",
+ "title": "ComputerTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDtmfToolDTO",
+ "title": "DtmfTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateEndCallToolDTO",
+ "title": "EndCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateFunctionToolDTO",
+ "title": "FunctionTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
+ "title": "GoogleCalendarCreateEventTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
+ "title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateQueryToolDTO",
+ "title": "QueryTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
+ "title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmsToolDTO",
+ "title": "SmsTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTextEditorToolDTO",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTransferCallToolDTO",
+ "title": "TransferCallTool"
+ }
+ ]
+ }
+ },
+ "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"
+ }
+ },
+ "knowledgeBase": {
+ "description": "These are the options for the knowledge base.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
+ "title": "Custom"
+ }
]
},
- "voiceId": {
+ "knowledgeBaseId": {
"type": "string",
- "description": "The ID of the particular voice you want to use."
+ "description": "This is the ID of the knowledge base the model will use."
},
"model": {
"type": "string",
- "description": "This is the model that will be used. This is optional and will default to the correct model for the voiceId.",
+ "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b",
"enum": [
- "sonic-2",
- "sonic-english",
- "sonic-multilingual",
- "sonic-preview",
- "sonic"
- ],
- "example": "sonic-english"
+ "inflection_3_pi"
+ ]
},
- "language": {
+ "provider": {
"type": "string",
- "description": "This is the language that will be used. This is optional and will default to the correct language for the voiceId.",
"enum": [
- "en",
- "de",
- "es",
- "fr",
- "ja",
- "pt",
- "zh",
- "hi",
- "it",
- "ko",
- "nl",
- "pl",
- "ru",
- "sv",
- "tr"
- ],
- "example": "en"
- },
- "experimentalControls": {
- "description": "Experimental controls for Cartesia voice generation",
- "allOf": [
- {
- "$ref": "#/components/schemas/CartesiaExperimentalControls"
- }
+ "inflection-ai"
]
},
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
- {
- "$ref": "#/components/schemas/ChunkPlan"
- }
- ]
+ "temperature": {
+ "type": "number",
+ "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.",
+ "minimum": 0,
+ "maximum": 2
},
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
- "allOf": [
- {
- "$ref": "#/components/schemas/FallbackPlan"
- }
- ]
+ "maxTokens": {
+ "type": "number",
+ "description": "This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.",
+ "minimum": 50,
+ "maximum": 10000
+ },
+ "emotionRecognitionEnabled": {
+ "type": "boolean",
+ "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.\n\n@default false"
+ },
+ "numFastTurns": {
+ "type": "number",
+ "description": "This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0",
+ "minimum": 0
}
},
"required": [
- "provider",
- "voiceId"
+ "model",
+ "provider"
]
},
- "CustomVoice": {
+ "OpenAIModel": {
"type": "object",
"properties": {
- "provider": {
- "type": "string",
- "description": "This is the voice provider that will be used. Use `custom-voice` for providers that are not natively supported.",
- "enum": [
- "custom-voice"
- ]
+ "messages": {
+ "description": "This is the starting state for the conversation.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OpenAIMessage"
+ }
},
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
- {
- "$ref": "#/components/schemas/ChunkPlan"
- }
- ]
+ "tools": {
+ "type": "array",
+ "description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateApiRequestToolDTO",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateBashToolDTO",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateComputerToolDTO",
+ "title": "ComputerTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDtmfToolDTO",
+ "title": "DtmfTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateEndCallToolDTO",
+ "title": "EndCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateFunctionToolDTO",
+ "title": "FunctionTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
+ "title": "GoogleCalendarCreateEventTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
+ "title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateQueryToolDTO",
+ "title": "QueryTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
+ "title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmsToolDTO",
+ "title": "SmsTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTextEditorToolDTO",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTransferCallToolDTO",
+ "title": "TransferCallTool"
+ }
+ ]
+ }
},
- "server": {
- "description": "This is where the voice request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"message\": {\n \"type\": \"voice-request\",\n \"text\": \"Hello, world!\",\n \"sampleRate\": 24000,\n ...other metadata about the call...\n }\n}\n\nResponse Expected: 1-channel 16-bit raw PCM audio at the sample rate specified in the request. Here is how the response will be piped to the transport:\n```\nresponse.on('data', (chunk: Buffer) => {\n outputStream.write(chunk);\n});\n```",
- "allOf": [
- {
- "$ref": "#/components/schemas/Server"
- }
- ]
+ "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"
+ }
},
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
- "allOf": [
+ "knowledgeBase": {
+ "description": "These are the options for the knowledge base.",
+ "oneOf": [
{
- "$ref": "#/components/schemas/FallbackPlan"
+ "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
+ "title": "Custom"
}
]
- }
- },
- "required": [
- "provider",
- "server"
- ]
- },
- "DeepgramVoice": {
- "type": "object",
- "properties": {
+ },
+ "knowledgeBaseId": {
+ "type": "string",
+ "description": "This is the ID of the knowledge base the model will use."
+ },
"provider": {
"type": "string",
- "description": "This is the voice provider that will be used.",
+ "description": "This is the provider that will be used for the model.",
"enum": [
- "deepgram"
+ "openai"
]
},
- "voiceId": {
+ "model": {
"type": "string",
- "description": "This is the provider-specific ID that will be used.",
+ "description": "This is the OpenAI model that will be used.\n\nWhen using Vapi OpenAI or your own Azure Credentials, you have the option to specify the region for the selected model. This shouldn't be specified unless you have a specific reason to do so. Vapi will automatically find the fastest region that make sense.\nThis is helpful when you are required to comply with Data Residency rules. Learn more about Azure regions here https://azure.microsoft.com/en-us/explore/global-infrastructure/data-residency/.\n\n@default undefined",
"enum": [
- "asteria",
- "luna",
- "stella",
- "athena",
- "hera",
- "orion",
- "arcas",
- "perseus",
- "angus",
- "orpheus",
- "helios",
- "zeus",
- "thalia",
- "andromeda",
- "helena",
- "apollo",
- "arcas",
- "aries",
- "amalthea",
- "andromeda",
- "apollo",
- "arcas",
- "aries",
- "asteria",
- "athena",
- "atlas",
- "aurora",
- "callista",
- "cora",
- "cordelia",
- "delia",
- "draco",
- "electra",
- "harmonia",
- "helena",
- "hera",
- "hermes",
- "hyperion",
- "iris",
- "janus",
- "juno",
- "jupiter",
- "luna",
- "mars",
- "minerva",
- "neptune",
- "odysseus",
- "ophelia",
- "orion",
- "orpheus",
- "pandora",
- "phoebe",
- "pluto",
- "saturn",
- "selene",
- "thalia",
- "theia",
- "vesta",
- "zeus"
- ],
- "title": "This is the Deepgram Voice ID"
+ "gpt-4.1-2025-04-14",
+ "gpt-4.1-mini-2025-04-14",
+ "gpt-4.1-nano-2025-04-14",
+ "gpt-4.1",
+ "gpt-4.1-mini",
+ "gpt-4.1-nano",
+ "gpt-4.5-preview",
+ "chatgpt-4o-latest",
+ "o3",
+ "o3-mini",
+ "o4-mini",
+ "o1-preview",
+ "o1-preview-2024-09-12",
+ "o1-mini",
+ "o1-mini-2024-09-12",
+ "gpt-4o-realtime-preview-2024-10-01",
+ "gpt-4o-realtime-preview-2024-12-17",
+ "gpt-4o-mini-realtime-preview-2024-12-17",
+ "gpt-4o-mini-2024-07-18",
+ "gpt-4o-mini",
+ "gpt-4o",
+ "gpt-4o-2024-05-13",
+ "gpt-4o-2024-08-06",
+ "gpt-4o-2024-11-20",
+ "gpt-4-turbo",
+ "gpt-4-turbo-2024-04-09",
+ "gpt-4-turbo-preview",
+ "gpt-4-0125-preview",
+ "gpt-4-1106-preview",
+ "gpt-4",
+ "gpt-4-0613",
+ "gpt-3.5-turbo",
+ "gpt-3.5-turbo-0125",
+ "gpt-3.5-turbo-1106",
+ "gpt-3.5-turbo-16k",
+ "gpt-3.5-turbo-0613",
+ "gpt-4.1-2025-04-14:westus",
+ "gpt-4.1-2025-04-14:eastus2",
+ "gpt-4.1-2025-04-14:eastus",
+ "gpt-4.1-2025-04-14:westus3",
+ "gpt-4.1-2025-04-14:northcentralus",
+ "gpt-4.1-2025-04-14:southcentralus",
+ "gpt-4.1-mini-2025-04-14:westus",
+ "gpt-4.1-mini-2025-04-14:eastus2",
+ "gpt-4.1-mini-2025-04-14:eastus",
+ "gpt-4.1-mini-2025-04-14:westus3",
+ "gpt-4.1-mini-2025-04-14:northcentralus",
+ "gpt-4.1-mini-2025-04-14:southcentralus",
+ "gpt-4.1-nano-2025-04-14:westus",
+ "gpt-4.1-nano-2025-04-14:eastus2",
+ "gpt-4.1-nano-2025-04-14:westus3",
+ "gpt-4.1-nano-2025-04-14:northcentralus",
+ "gpt-4.1-nano-2025-04-14:southcentralus",
+ "gpt-4o-2024-11-20:swedencentral",
+ "gpt-4o-2024-11-20:westus",
+ "gpt-4o-2024-11-20:eastus2",
+ "gpt-4o-2024-11-20:eastus",
+ "gpt-4o-2024-11-20:westus3",
+ "gpt-4o-2024-11-20:southcentralus",
+ "gpt-4o-2024-08-06:westus",
+ "gpt-4o-2024-08-06:westus3",
+ "gpt-4o-2024-08-06:eastus",
+ "gpt-4o-2024-08-06:eastus2",
+ "gpt-4o-2024-08-06:northcentralus",
+ "gpt-4o-2024-08-06:southcentralus",
+ "gpt-4o-mini-2024-07-18:westus",
+ "gpt-4o-mini-2024-07-18:westus3",
+ "gpt-4o-mini-2024-07-18:eastus",
+ "gpt-4o-mini-2024-07-18:eastus2",
+ "gpt-4o-mini-2024-07-18:northcentralus",
+ "gpt-4o-mini-2024-07-18:southcentralus",
+ "gpt-4o-2024-05-13:eastus2",
+ "gpt-4o-2024-05-13:eastus",
+ "gpt-4o-2024-05-13:northcentralus",
+ "gpt-4o-2024-05-13:southcentralus",
+ "gpt-4o-2024-05-13:westus3",
+ "gpt-4o-2024-05-13:westus",
+ "gpt-4-turbo-2024-04-09:eastus2",
+ "gpt-4-0125-preview:eastus",
+ "gpt-4-0125-preview:northcentralus",
+ "gpt-4-0125-preview:southcentralus",
+ "gpt-4-1106-preview:australia",
+ "gpt-4-1106-preview:canadaeast",
+ "gpt-4-1106-preview:france",
+ "gpt-4-1106-preview:india",
+ "gpt-4-1106-preview:norway",
+ "gpt-4-1106-preview:swedencentral",
+ "gpt-4-1106-preview:uk",
+ "gpt-4-1106-preview:westus",
+ "gpt-4-1106-preview:westus3",
+ "gpt-4-0613:canadaeast",
+ "gpt-3.5-turbo-0125:canadaeast",
+ "gpt-3.5-turbo-0125:northcentralus",
+ "gpt-3.5-turbo-0125:southcentralus",
+ "gpt-3.5-turbo-1106:canadaeast",
+ "gpt-3.5-turbo-1106:westus"
+ ]
},
- "model": {
- "type": "string",
- "description": "This is the model that will be used. Defaults to 'aura-2' when not specified.",
+ "fallbackModels": {
+ "type": "array",
+ "description": "These are the fallback models that will be used if the primary model fails. This shouldn't be specified unless you have a specific reason to do so. Vapi will automatically find the fastest fallbacks that make sense.",
"enum": [
- "aura",
- "aura-2"
+ "gpt-4.1-2025-04-14",
+ "gpt-4.1-mini-2025-04-14",
+ "gpt-4.1-nano-2025-04-14",
+ "gpt-4.1",
+ "gpt-4.1-mini",
+ "gpt-4.1-nano",
+ "gpt-4.5-preview",
+ "chatgpt-4o-latest",
+ "o3",
+ "o3-mini",
+ "o4-mini",
+ "o1-preview",
+ "o1-preview-2024-09-12",
+ "o1-mini",
+ "o1-mini-2024-09-12",
+ "gpt-4o-realtime-preview-2024-10-01",
+ "gpt-4o-realtime-preview-2024-12-17",
+ "gpt-4o-mini-realtime-preview-2024-12-17",
+ "gpt-4o-mini-2024-07-18",
+ "gpt-4o-mini",
+ "gpt-4o",
+ "gpt-4o-2024-05-13",
+ "gpt-4o-2024-08-06",
+ "gpt-4o-2024-11-20",
+ "gpt-4-turbo",
+ "gpt-4-turbo-2024-04-09",
+ "gpt-4-turbo-preview",
+ "gpt-4-0125-preview",
+ "gpt-4-1106-preview",
+ "gpt-4",
+ "gpt-4-0613",
+ "gpt-3.5-turbo",
+ "gpt-3.5-turbo-0125",
+ "gpt-3.5-turbo-1106",
+ "gpt-3.5-turbo-16k",
+ "gpt-3.5-turbo-0613",
+ "gpt-4.1-2025-04-14:westus",
+ "gpt-4.1-2025-04-14:eastus2",
+ "gpt-4.1-2025-04-14:eastus",
+ "gpt-4.1-2025-04-14:westus3",
+ "gpt-4.1-2025-04-14:northcentralus",
+ "gpt-4.1-2025-04-14:southcentralus",
+ "gpt-4.1-mini-2025-04-14:westus",
+ "gpt-4.1-mini-2025-04-14:eastus2",
+ "gpt-4.1-mini-2025-04-14:eastus",
+ "gpt-4.1-mini-2025-04-14:westus3",
+ "gpt-4.1-mini-2025-04-14:northcentralus",
+ "gpt-4.1-mini-2025-04-14:southcentralus",
+ "gpt-4.1-nano-2025-04-14:westus",
+ "gpt-4.1-nano-2025-04-14:eastus2",
+ "gpt-4.1-nano-2025-04-14:westus3",
+ "gpt-4.1-nano-2025-04-14:northcentralus",
+ "gpt-4.1-nano-2025-04-14:southcentralus",
+ "gpt-4o-2024-11-20:swedencentral",
+ "gpt-4o-2024-11-20:westus",
+ "gpt-4o-2024-11-20:eastus2",
+ "gpt-4o-2024-11-20:eastus",
+ "gpt-4o-2024-11-20:westus3",
+ "gpt-4o-2024-11-20:southcentralus",
+ "gpt-4o-2024-08-06:westus",
+ "gpt-4o-2024-08-06:westus3",
+ "gpt-4o-2024-08-06:eastus",
+ "gpt-4o-2024-08-06:eastus2",
+ "gpt-4o-2024-08-06:northcentralus",
+ "gpt-4o-2024-08-06:southcentralus",
+ "gpt-4o-mini-2024-07-18:westus",
+ "gpt-4o-mini-2024-07-18:westus3",
+ "gpt-4o-mini-2024-07-18:eastus",
+ "gpt-4o-mini-2024-07-18:eastus2",
+ "gpt-4o-mini-2024-07-18:northcentralus",
+ "gpt-4o-mini-2024-07-18:southcentralus",
+ "gpt-4o-2024-05-13:eastus2",
+ "gpt-4o-2024-05-13:eastus",
+ "gpt-4o-2024-05-13:northcentralus",
+ "gpt-4o-2024-05-13:southcentralus",
+ "gpt-4o-2024-05-13:westus3",
+ "gpt-4o-2024-05-13:westus",
+ "gpt-4-turbo-2024-04-09:eastus2",
+ "gpt-4-0125-preview:eastus",
+ "gpt-4-0125-preview:northcentralus",
+ "gpt-4-0125-preview:southcentralus",
+ "gpt-4-1106-preview:australia",
+ "gpt-4-1106-preview:canadaeast",
+ "gpt-4-1106-preview:france",
+ "gpt-4-1106-preview:india",
+ "gpt-4-1106-preview:norway",
+ "gpt-4-1106-preview:swedencentral",
+ "gpt-4-1106-preview:uk",
+ "gpt-4-1106-preview:westus",
+ "gpt-4-1106-preview:westus3",
+ "gpt-4-0613:canadaeast",
+ "gpt-3.5-turbo-0125:canadaeast",
+ "gpt-3.5-turbo-0125:northcentralus",
+ "gpt-3.5-turbo-0125:southcentralus",
+ "gpt-3.5-turbo-1106:canadaeast",
+ "gpt-3.5-turbo-1106:westus"
],
- "example": "aura-2"
+ "example": [
+ "gpt-4-0125-preview",
+ "gpt-4-0613"
+ ],
+ "items": {
+ "type": "string",
+ "enum": [
+ "gpt-4.1-2025-04-14",
+ "gpt-4.1-mini-2025-04-14",
+ "gpt-4.1-nano-2025-04-14",
+ "gpt-4.1",
+ "gpt-4.1-mini",
+ "gpt-4.1-nano",
+ "gpt-4.5-preview",
+ "chatgpt-4o-latest",
+ "o3",
+ "o3-mini",
+ "o4-mini",
+ "o1-preview",
+ "o1-preview-2024-09-12",
+ "o1-mini",
+ "o1-mini-2024-09-12",
+ "gpt-4o-realtime-preview-2024-10-01",
+ "gpt-4o-realtime-preview-2024-12-17",
+ "gpt-4o-mini-realtime-preview-2024-12-17",
+ "gpt-4o-mini-2024-07-18",
+ "gpt-4o-mini",
+ "gpt-4o",
+ "gpt-4o-2024-05-13",
+ "gpt-4o-2024-08-06",
+ "gpt-4o-2024-11-20",
+ "gpt-4-turbo",
+ "gpt-4-turbo-2024-04-09",
+ "gpt-4-turbo-preview",
+ "gpt-4-0125-preview",
+ "gpt-4-1106-preview",
+ "gpt-4",
+ "gpt-4-0613",
+ "gpt-3.5-turbo",
+ "gpt-3.5-turbo-0125",
+ "gpt-3.5-turbo-1106",
+ "gpt-3.5-turbo-16k",
+ "gpt-3.5-turbo-0613",
+ "gpt-4.1-2025-04-14:westus",
+ "gpt-4.1-2025-04-14:eastus2",
+ "gpt-4.1-2025-04-14:eastus",
+ "gpt-4.1-2025-04-14:westus3",
+ "gpt-4.1-2025-04-14:northcentralus",
+ "gpt-4.1-2025-04-14:southcentralus",
+ "gpt-4.1-mini-2025-04-14:westus",
+ "gpt-4.1-mini-2025-04-14:eastus2",
+ "gpt-4.1-mini-2025-04-14:eastus",
+ "gpt-4.1-mini-2025-04-14:westus3",
+ "gpt-4.1-mini-2025-04-14:northcentralus",
+ "gpt-4.1-mini-2025-04-14:southcentralus",
+ "gpt-4.1-nano-2025-04-14:westus",
+ "gpt-4.1-nano-2025-04-14:eastus2",
+ "gpt-4.1-nano-2025-04-14:westus3",
+ "gpt-4.1-nano-2025-04-14:northcentralus",
+ "gpt-4.1-nano-2025-04-14:southcentralus",
+ "gpt-4o-2024-11-20:swedencentral",
+ "gpt-4o-2024-11-20:westus",
+ "gpt-4o-2024-11-20:eastus2",
+ "gpt-4o-2024-11-20:eastus",
+ "gpt-4o-2024-11-20:westus3",
+ "gpt-4o-2024-11-20:southcentralus",
+ "gpt-4o-2024-08-06:westus",
+ "gpt-4o-2024-08-06:westus3",
+ "gpt-4o-2024-08-06:eastus",
+ "gpt-4o-2024-08-06:eastus2",
+ "gpt-4o-2024-08-06:northcentralus",
+ "gpt-4o-2024-08-06:southcentralus",
+ "gpt-4o-mini-2024-07-18:westus",
+ "gpt-4o-mini-2024-07-18:westus3",
+ "gpt-4o-mini-2024-07-18:eastus",
+ "gpt-4o-mini-2024-07-18:eastus2",
+ "gpt-4o-mini-2024-07-18:northcentralus",
+ "gpt-4o-mini-2024-07-18:southcentralus",
+ "gpt-4o-2024-05-13:eastus2",
+ "gpt-4o-2024-05-13:eastus",
+ "gpt-4o-2024-05-13:northcentralus",
+ "gpt-4o-2024-05-13:southcentralus",
+ "gpt-4o-2024-05-13:westus3",
+ "gpt-4o-2024-05-13:westus",
+ "gpt-4-turbo-2024-04-09:eastus2",
+ "gpt-4-0125-preview:eastus",
+ "gpt-4-0125-preview:northcentralus",
+ "gpt-4-0125-preview:southcentralus",
+ "gpt-4-1106-preview:australia",
+ "gpt-4-1106-preview:canadaeast",
+ "gpt-4-1106-preview:france",
+ "gpt-4-1106-preview:india",
+ "gpt-4-1106-preview:norway",
+ "gpt-4-1106-preview:swedencentral",
+ "gpt-4-1106-preview:uk",
+ "gpt-4-1106-preview:westus",
+ "gpt-4-1106-preview:westus3",
+ "gpt-4-0613:canadaeast",
+ "gpt-3.5-turbo-0125:canadaeast",
+ "gpt-3.5-turbo-0125:northcentralus",
+ "gpt-3.5-turbo-0125:southcentralus",
+ "gpt-3.5-turbo-1106:canadaeast",
+ "gpt-3.5-turbo-1106:westus"
+ ]
+ }
},
- "mipOptOut": {
- "type": "boolean",
- "description": "If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false",
- "example": false,
- "default": false
+ "toolStrictCompatibilityMode": {
+ "type": "string",
+ "description": "Azure OpenAI doesn't support `maxLength` right now https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/structured-outputs?tabs=python-secure%2Cdotnet-entra-id&pivots=programming-language-csharp#unsupported-type-specific-keywords. Need to strip.\n\n- `strip-parameters-with-unsupported-validation` will strip parameters with unsupported validation.\n- `strip-unsupported-validation` will keep the parameters but strip unsupported validation.\n\n@default `strip-unsupported-validation`",
+ "enum": [
+ "strip-parameters-with-unsupported-validation",
+ "strip-unsupported-validation"
+ ]
},
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
- {
- "$ref": "#/components/schemas/ChunkPlan"
- }
- ]
+ "temperature": {
+ "type": "number",
+ "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.",
+ "minimum": 0,
+ "maximum": 2
},
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
- "allOf": [
- {
- "$ref": "#/components/schemas/FallbackPlan"
- }
- ]
+ "maxTokens": {
+ "type": "number",
+ "description": "This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.",
+ "minimum": 50,
+ "maximum": 10000
+ },
+ "emotionRecognitionEnabled": {
+ "type": "boolean",
+ "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.\n\n@default false"
+ },
+ "numFastTurns": {
+ "type": "number",
+ "description": "This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0",
+ "minimum": 0
}
},
"required": [
"provider",
- "voiceId"
+ "model"
]
},
- "ElevenLabsVoice": {
+ "OpenRouterModel": {
"type": "object",
"properties": {
- "provider": {
- "type": "string",
- "description": "This is the voice provider that will be used.",
- "enum": [
- "11labs"
- ]
- },
- "voiceId": {
- "description": "This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.",
- "oneOf": [
- {
- "type": "string",
- "enum": [
- "burt",
- "marissa",
- "andrea",
- "sarah",
- "phillip",
- "steve",
- "joseph",
- "myra",
- "paula",
- "ryan",
- "drew",
- "paul",
- "mrb",
- "matilda",
- "mark"
- ],
- "title": "Preset Voice Options"
- },
- {
- "type": "string",
- "title": "11Labs Voice ID"
- }
- ]
- },
- "stability": {
- "type": "number",
- "description": "Defines the stability for voice settings.",
- "minimum": 0,
- "maximum": 1,
- "example": 0.5
- },
- "similarityBoost": {
- "type": "number",
- "description": "Defines the similarity boost for voice settings.",
- "minimum": 0,
- "maximum": 1,
- "example": 0.75
- },
- "style": {
- "type": "number",
- "description": "Defines the style for voice settings.",
- "minimum": 0,
- "maximum": 1,
- "example": 0
- },
- "useSpeakerBoost": {
- "type": "boolean",
- "description": "Defines the use speaker boost for voice settings.",
- "example": false
- },
- "speed": {
- "type": "number",
- "description": "Defines the speed for voice settings.",
- "minimum": 0.7,
- "maximum": 1.2,
- "example": 0.9
- },
- "optimizeStreamingLatency": {
- "type": "number",
- "description": "Defines the optimize streaming latency for voice settings. Defaults to 3.",
- "minimum": 0,
- "maximum": 4,
- "example": 3
- },
- "enableSsmlParsing": {
- "type": "boolean",
- "description": "This enables the use of https://elevenlabs.io/docs/speech-synthesis/prompting#pronunciation. Defaults to false to save latency.\n\n@default false",
- "example": false
+ "messages": {
+ "description": "This is the starting state for the conversation.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OpenAIMessage"
+ }
},
- "autoMode": {
- "type": "boolean",
- "description": "Defines the auto mode for voice settings. Defaults to false.",
- "example": false
+ "tools": {
+ "type": "array",
+ "description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateApiRequestToolDTO",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateBashToolDTO",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateComputerToolDTO",
+ "title": "ComputerTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDtmfToolDTO",
+ "title": "DtmfTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateEndCallToolDTO",
+ "title": "EndCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateFunctionToolDTO",
+ "title": "FunctionTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
+ "title": "GoogleCalendarCreateEventTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
+ "title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateQueryToolDTO",
+ "title": "QueryTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
+ "title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmsToolDTO",
+ "title": "SmsTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTextEditorToolDTO",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTransferCallToolDTO",
+ "title": "TransferCallTool"
+ }
+ ]
+ }
},
- "model": {
- "type": "string",
- "description": "This is the model that will be used. Defaults to 'eleven_turbo_v2' if not specified.",
- "enum": [
- "eleven_multilingual_v2",
- "eleven_turbo_v2",
- "eleven_turbo_v2_5",
- "eleven_flash_v2",
- "eleven_flash_v2_5",
- "eleven_monolingual_v1"
- ],
- "example": "eleven_turbo_v2_5"
+ "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"
+ }
},
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
+ "knowledgeBase": {
+ "description": "These are the options for the knowledge base.",
+ "oneOf": [
{
- "$ref": "#/components/schemas/ChunkPlan"
+ "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
+ "title": "Custom"
}
]
},
- "language": {
+ "knowledgeBaseId": {
"type": "string",
- "description": "This is the language (ISO 639-1) that is enforced for the model. Currently only Turbo v2.5 supports language enforcement. For other models, an error will be returned if language code is provided."
+ "description": "This is the ID of the knowledge base the model will use."
},
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
- "allOf": [
- {
- "$ref": "#/components/schemas/FallbackPlan"
- }
- ]
- }
- },
- "required": [
- "provider",
- "voiceId"
- ]
- },
- "HumeVoice": {
- "type": "object",
- "properties": {
"provider": {
"type": "string",
- "description": "This is the voice provider that will be used.",
"enum": [
- "hume"
+ "openrouter"
]
},
"model": {
"type": "string",
- "description": "This is the model that will be used.",
- "enum": [
- "octave"
- ],
- "example": "octave"
- },
- "voiceId": {
- "type": "string",
- "description": "The ID of the particular voice you want to use."
+ "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b"
},
- "isCustomHumeVoice": {
- "type": "boolean",
- "description": "Indicates whether the chosen voice is a preset Hume AI voice or a custom voice.",
- "example": false
+ "temperature": {
+ "type": "number",
+ "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.",
+ "minimum": 0,
+ "maximum": 2
},
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
- {
- "$ref": "#/components/schemas/ChunkPlan"
- }
- ]
+ "maxTokens": {
+ "type": "number",
+ "description": "This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.",
+ "minimum": 50,
+ "maximum": 10000
},
- "description": {
- "type": "string",
- "description": "Natural language instructions describing how the synthesized speech should sound, including but not limited to tone, intonation, pacing, and accent (e.g., 'a soft, gentle voice with a strong British accent').\n\nIf a Voice is specified in the request, this description serves as acting instructions.\nIf no Voice is specified, a new voice is generated based on this description."
+ "emotionRecognitionEnabled": {
+ "type": "boolean",
+ "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.\n\n@default false"
},
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
- "allOf": [
- {
- "$ref": "#/components/schemas/FallbackPlan"
- }
- ]
+ "numFastTurns": {
+ "type": "number",
+ "description": "This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0",
+ "minimum": 0
}
},
"required": [
"provider",
- "voiceId"
+ "model"
]
},
- "LMNTVoice": {
+ "PerplexityAIModel": {
"type": "object",
"properties": {
- "provider": {
- "type": "string",
- "description": "This is the voice provider that will be used.",
- "enum": [
- "lmnt"
- ]
+ "messages": {
+ "description": "This is the starting state for the conversation.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OpenAIMessage"
+ }
},
- "voiceId": {
- "description": "This is the provider-specific ID that will be used.",
- "oneOf": [
- {
- "type": "string",
- "enum": [
- "lily",
- "daniel"
- ],
- "title": "Preset Voice Options"
- },
- {
- "type": "string",
- "title": "LMNT Voice ID"
- }
- ]
+ "tools": {
+ "type": "array",
+ "description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateApiRequestToolDTO",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateBashToolDTO",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateComputerToolDTO",
+ "title": "ComputerTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDtmfToolDTO",
+ "title": "DtmfTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateEndCallToolDTO",
+ "title": "EndCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateFunctionToolDTO",
+ "title": "FunctionTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
+ "title": "GoogleCalendarCreateEventTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
+ "title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateQueryToolDTO",
+ "title": "QueryTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
+ "title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmsToolDTO",
+ "title": "SmsTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTextEditorToolDTO",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTransferCallToolDTO",
+ "title": "TransferCallTool"
+ }
+ ]
+ }
},
- "speed": {
- "type": "number",
- "description": "This is the speed multiplier that will be used.",
- "minimum": 0.25,
- "maximum": 2,
- "example": null
+ "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"
+ }
},
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
+ "knowledgeBase": {
+ "description": "These are the options for the knowledge base.",
+ "oneOf": [
{
- "$ref": "#/components/schemas/ChunkPlan"
+ "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
+ "title": "Custom"
}
]
},
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
- "allOf": [
- {
- "$ref": "#/components/schemas/FallbackPlan"
- }
- ]
- }
- },
- "required": [
- "provider",
- "voiceId"
- ]
- },
- "NeuphonicVoice": {
- "type": "object",
- "properties": {
+ "knowledgeBaseId": {
+ "type": "string",
+ "description": "This is the ID of the knowledge base the model will use."
+ },
"provider": {
"type": "string",
- "description": "This is the voice provider that will be used.",
"enum": [
- "neuphonic"
- ]
- },
- "voiceId": {
- "description": "This is the provider-specific ID that will be used.",
- "oneOf": [
- {
- "type": "string",
- "enum": [],
- "title": "Preset Voice Options"
- },
- {
- "type": "string",
- "title": "Neuphonic Voice ID"
- }
+ "perplexity-ai"
]
},
"model": {
"type": "string",
- "description": "This is the model that will be used. Defaults to 'neu_fast' if not specified.",
- "enum": [
- "neu_hq",
- "neu_fast"
- ],
- "example": "neu_fast"
+ "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b"
},
- "language": {
- "type": "object",
- "description": "This is the language (ISO 639-1) that is enforced for the model.",
- "example": "en"
+ "temperature": {
+ "type": "number",
+ "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.",
+ "minimum": 0,
+ "maximum": 2
},
- "speed": {
+ "maxTokens": {
"type": "number",
- "description": "This is the speed multiplier that will be used.",
- "minimum": 0.25,
- "maximum": 2,
- "example": null
+ "description": "This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.",
+ "minimum": 50,
+ "maximum": 10000
},
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
- {
- "$ref": "#/components/schemas/ChunkPlan"
- }
- ]
+ "emotionRecognitionEnabled": {
+ "type": "boolean",
+ "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.\n\n@default false"
},
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
- "allOf": [
- {
- "$ref": "#/components/schemas/FallbackPlan"
- }
- ]
+ "numFastTurns": {
+ "type": "number",
+ "description": "This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0",
+ "minimum": 0
}
},
"required": [
"provider",
- "voiceId",
- "language"
+ "model"
]
},
- "OpenAIVoice": {
+ "TogetherAIModel": {
"type": "object",
"properties": {
- "provider": {
- "type": "string",
- "description": "This is the voice provider that will be used.",
- "enum": [
- "openai"
- ]
+ "messages": {
+ "description": "This is the starting state for the conversation.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OpenAIMessage"
+ }
},
- "voiceId": {
- "description": "This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.",
- "oneOf": [
- {
- "type": "string",
- "enum": [
- "alloy",
- "echo",
- "fable",
- "onyx",
- "nova",
- "shimmer"
- ],
- "title": "Preset Voice Options"
- },
+ "tools": {
+ "type": "array",
+ "description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateApiRequestToolDTO",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateBashToolDTO",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateComputerToolDTO",
+ "title": "ComputerTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDtmfToolDTO",
+ "title": "DtmfTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateEndCallToolDTO",
+ "title": "EndCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateFunctionToolDTO",
+ "title": "FunctionTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
+ "title": "GoogleCalendarCreateEventTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
+ "title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateQueryToolDTO",
+ "title": "QueryTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
+ "title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmsToolDTO",
+ "title": "SmsTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTextEditorToolDTO",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTransferCallToolDTO",
+ "title": "TransferCallTool"
+ }
+ ]
+ }
+ },
+ "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"
+ }
+ },
+ "knowledgeBase": {
+ "description": "These are the options for the knowledge base.",
+ "oneOf": [
{
- "type": "string",
- "title": "OpenAI Voice ID"
+ "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
+ "title": "Custom"
}
]
},
- "model": {
+ "knowledgeBaseId": {
+ "type": "string",
+ "description": "This is the ID of the knowledge base the model will use."
+ },
+ "provider": {
"type": "string",
- "description": "This is the model that will be used for text-to-speech.",
"enum": [
- "tts-1",
- "tts-1-hd",
- "gpt-4o-mini-tts"
+ "together-ai"
]
},
- "instructions": {
+ "model": {
"type": "string",
- "description": "This is a prompt that allows you to control the voice of your generated audio.\nDoes not work with 'tts-1' or 'tts-1-hd' models.",
- "maxLength": 10000
+ "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b"
},
- "speed": {
+ "temperature": {
"type": "number",
- "description": "This is the speed multiplier that will be used.",
- "minimum": 0.25,
- "maximum": 4,
- "example": null
+ "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.",
+ "minimum": 0,
+ "maximum": 2
},
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
- {
- "$ref": "#/components/schemas/ChunkPlan"
- }
- ]
+ "maxTokens": {
+ "type": "number",
+ "description": "This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.",
+ "minimum": 50,
+ "maximum": 10000
},
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
- "allOf": [
- {
- "$ref": "#/components/schemas/FallbackPlan"
- }
- ]
+ "emotionRecognitionEnabled": {
+ "type": "boolean",
+ "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.\n\n@default false"
+ },
+ "numFastTurns": {
+ "type": "number",
+ "description": "This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0",
+ "minimum": 0
}
},
"required": [
"provider",
- "voiceId"
+ "model"
]
},
- "PlayHTVoice": {
+ "HangupNode": {
"type": "object",
"properties": {
- "provider": {
+ "type": {
"type": "string",
- "description": "This is the voice provider that will be used.",
"enum": [
- "playht"
- ]
- },
- "voiceId": {
- "description": "This is the provider-specific ID that will be used.",
- "oneOf": [
- {
- "type": "string",
- "enum": [
- "jennifer",
- "melissa",
- "will",
- "chris",
- "matt",
- "jack",
- "ruby",
- "davis",
- "donna",
- "michael"
- ],
- "title": "Preset Voice Options"
- },
- {
- "type": "string",
- "title": "PlayHT Voice ID"
- }
+ "hangup"
]
},
- "speed": {
- "type": "number",
- "description": "This is the speed multiplier that will be used.",
- "minimum": 0.1,
- "maximum": 5,
- "example": null
- },
- "temperature": {
- "type": "number",
- "description": "A floating point number between 0, exclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used. The temperature parameter controls variance. Lower temperatures result in more predictable results, higher temperatures allow each run to vary more, so the voice may sound less like the baseline voice.",
- "minimum": 0.1,
- "maximum": 2,
- "example": null
- },
- "emotion": {
+ "name": {
"type": "string",
- "description": "An emotion to be applied to the speech.",
- "enum": [
- "female_happy",
- "female_sad",
- "female_angry",
- "female_fearful",
- "female_disgust",
- "female_surprised",
- "male_happy",
- "male_sad",
- "male_angry",
- "male_fearful",
- "male_disgust",
- "male_surprised"
- ],
- "example": null
- },
- "voiceGuidance": {
- "type": "number",
- "description": "A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.",
- "minimum": 1,
- "maximum": 6,
- "example": null
- },
- "styleGuidance": {
- "type": "number",
- "description": "A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.",
- "minimum": 1,
- "maximum": 30,
- "example": null
+ "maxLength": 80
},
- "textGuidance": {
- "type": "number",
- "description": "A number between 1 and 2. This number influences how closely the generated speech adheres to the input text. Use lower values to create more fluid speech, but with a higher chance of deviating from the input text. Higher numbers will make the generated speech more accurate to the input text, ensuring that the words spoken align closely with the provided text.",
- "minimum": 1,
- "maximum": 2,
- "example": null
+ "isStart": {
+ "type": "boolean",
+ "description": "This is whether or not the node is the start of the workflow."
},
- "model": {
+ "metadata": {
+ "type": "object",
+ "description": "This is for metadata you want to store on the task."
+ }
+ },
+ "required": [
+ "type",
+ "name"
+ ]
+ },
+ "WorkflowOpenAIModel": {
+ "type": "object",
+ "properties": {
+ "provider": {
"type": "string",
- "description": "Playht voice model/engine to use.",
+ "description": "This is the provider of the model (`openai`).",
"enum": [
- "PlayHT2.0",
- "PlayHT2.0-turbo",
- "Play3.0-mini",
- "PlayDialog"
+ "openai"
]
},
- "language": {
+ "model": {
"type": "string",
- "description": "The language to use for the speech.",
+ "description": "This is the OpenAI model that will be used.\n\nWhen using Vapi OpenAI or your own Azure Credentials, you have the option to specify the region for the selected model. This shouldn't be specified unless you have a specific reason to do so. Vapi will automatically find the fastest region that make sense.\nThis is helpful when you are required to comply with Data Residency rules. Learn more about Azure regions here https://azure.microsoft.com/en-us/explore/global-infrastructure/data-residency/.",
+ "maxLength": 100,
"enum": [
- "afrikaans",
- "albanian",
- "amharic",
- "arabic",
- "bengali",
- "bulgarian",
- "catalan",
- "croatian",
- "czech",
- "danish",
- "dutch",
- "english",
- "french",
- "galician",
- "german",
- "greek",
- "hebrew",
- "hindi",
- "hungarian",
- "indonesian",
- "italian",
- "japanese",
- "korean",
- "malay",
- "mandarin",
- "polish",
- "portuguese",
- "russian",
- "serbian",
- "spanish",
- "swedish",
- "tagalog",
- "thai",
- "turkish",
- "ukrainian",
- "urdu",
- "xhosa"
+ "gpt-4.1-2025-04-14",
+ "gpt-4.1-mini-2025-04-14",
+ "gpt-4.1-nano-2025-04-14",
+ "gpt-4.1",
+ "gpt-4.1-mini",
+ "gpt-4.1-nano",
+ "gpt-4.5-preview",
+ "chatgpt-4o-latest",
+ "o3",
+ "o3-mini",
+ "o4-mini",
+ "o1-preview",
+ "o1-preview-2024-09-12",
+ "o1-mini",
+ "o1-mini-2024-09-12",
+ "gpt-4o-mini-2024-07-18",
+ "gpt-4o-mini",
+ "gpt-4o",
+ "gpt-4o-2024-05-13",
+ "gpt-4o-2024-08-06",
+ "gpt-4o-2024-11-20",
+ "gpt-4-turbo",
+ "gpt-4-turbo-2024-04-09",
+ "gpt-4-turbo-preview",
+ "gpt-4-0125-preview",
+ "gpt-4-1106-preview",
+ "gpt-4",
+ "gpt-4-0613",
+ "gpt-3.5-turbo",
+ "gpt-3.5-turbo-0125",
+ "gpt-3.5-turbo-1106",
+ "gpt-3.5-turbo-16k",
+ "gpt-3.5-turbo-0613",
+ "gpt-4.1-2025-04-14:westus",
+ "gpt-4.1-2025-04-14:eastus2",
+ "gpt-4.1-2025-04-14:eastus",
+ "gpt-4.1-2025-04-14:westus3",
+ "gpt-4.1-2025-04-14:northcentralus",
+ "gpt-4.1-2025-04-14:southcentralus",
+ "gpt-4.1-mini-2025-04-14:westus",
+ "gpt-4.1-mini-2025-04-14:eastus2",
+ "gpt-4.1-mini-2025-04-14:eastus",
+ "gpt-4.1-mini-2025-04-14:westus3",
+ "gpt-4.1-mini-2025-04-14:northcentralus",
+ "gpt-4.1-mini-2025-04-14:southcentralus",
+ "gpt-4.1-nano-2025-04-14:westus",
+ "gpt-4.1-nano-2025-04-14:eastus2",
+ "gpt-4.1-nano-2025-04-14:westus3",
+ "gpt-4.1-nano-2025-04-14:northcentralus",
+ "gpt-4.1-nano-2025-04-14:southcentralus",
+ "gpt-4o-2024-11-20:swedencentral",
+ "gpt-4o-2024-11-20:westus",
+ "gpt-4o-2024-11-20:eastus2",
+ "gpt-4o-2024-11-20:eastus",
+ "gpt-4o-2024-11-20:westus3",
+ "gpt-4o-2024-11-20:southcentralus",
+ "gpt-4o-2024-08-06:westus",
+ "gpt-4o-2024-08-06:westus3",
+ "gpt-4o-2024-08-06:eastus",
+ "gpt-4o-2024-08-06:eastus2",
+ "gpt-4o-2024-08-06:northcentralus",
+ "gpt-4o-2024-08-06:southcentralus",
+ "gpt-4o-mini-2024-07-18:westus",
+ "gpt-4o-mini-2024-07-18:westus3",
+ "gpt-4o-mini-2024-07-18:eastus",
+ "gpt-4o-mini-2024-07-18:eastus2",
+ "gpt-4o-mini-2024-07-18:northcentralus",
+ "gpt-4o-mini-2024-07-18:southcentralus",
+ "gpt-4o-2024-05-13:eastus2",
+ "gpt-4o-2024-05-13:eastus",
+ "gpt-4o-2024-05-13:northcentralus",
+ "gpt-4o-2024-05-13:southcentralus",
+ "gpt-4o-2024-05-13:westus3",
+ "gpt-4o-2024-05-13:westus",
+ "gpt-4-turbo-2024-04-09:eastus2",
+ "gpt-4-0125-preview:eastus",
+ "gpt-4-0125-preview:northcentralus",
+ "gpt-4-0125-preview:southcentralus",
+ "gpt-4-1106-preview:australia",
+ "gpt-4-1106-preview:canadaeast",
+ "gpt-4-1106-preview:france",
+ "gpt-4-1106-preview:india",
+ "gpt-4-1106-preview:norway",
+ "gpt-4-1106-preview:swedencentral",
+ "gpt-4-1106-preview:uk",
+ "gpt-4-1106-preview:westus",
+ "gpt-4-1106-preview:westus3",
+ "gpt-4-0613:canadaeast",
+ "gpt-3.5-turbo-0125:canadaeast",
+ "gpt-3.5-turbo-0125:northcentralus",
+ "gpt-3.5-turbo-0125:southcentralus",
+ "gpt-3.5-turbo-1106:canadaeast",
+ "gpt-3.5-turbo-1106:westus"
]
},
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
- {
- "$ref": "#/components/schemas/ChunkPlan"
- }
- ]
+ "temperature": {
+ "type": "number",
+ "description": "This is the temperature of the model.",
+ "minimum": 0,
+ "maximum": 2
},
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
- "allOf": [
- {
- "$ref": "#/components/schemas/FallbackPlan"
- }
- ]
+ "maxTokens": {
+ "type": "number",
+ "description": "This is the max tokens of the model.",
+ "minimum": 50,
+ "maximum": 10000
}
},
"required": [
"provider",
- "voiceId"
+ "model"
]
},
- "RimeAIVoice": {
+ "WorkflowAnthropicModel": {
"type": "object",
"properties": {
"provider": {
"type": "string",
- "description": "This is the voice provider that will be used.",
+ "description": "This is the provider of the model (`anthropic`).",
"enum": [
- "rime-ai"
- ]
- },
- "voiceId": {
- "description": "This is the provider-specific ID that will be used.",
- "oneOf": [
- {
- "type": "string",
- "enum": [
- "abbie",
- "allison",
- "ally",
- "alona",
- "amber",
- "ana",
- "antoine",
- "armon",
- "brenda",
- "brittany",
- "carol",
- "colin",
- "courtney",
- "elena",
- "elliot",
- "eva",
- "geoff",
- "gerald",
- "hank",
- "helen",
- "hera",
- "jen",
- "joe",
- "joy",
- "juan",
- "kendra",
- "kendrick",
- "kenneth",
- "kevin",
- "kris",
- "linda",
- "madison",
- "marge",
- "marina",
- "marissa",
- "marta",
- "maya",
- "nicholas",
- "nyles",
- "phil",
- "reba",
- "rex",
- "rick",
- "ritu",
- "rob",
- "rodney",
- "rohan",
- "rosco",
- "samantha",
- "sandy",
- "selena",
- "seth",
- "sharon",
- "stan",
- "tamra",
- "tanya",
- "tibur",
- "tj",
- "tyler",
- "viv",
- "yadira",
- "marsh",
- "bayou",
- "creek",
- "brook",
- "flower",
- "spore",
- "glacier",
- "gulch",
- "alpine",
- "cove",
- "lagoon",
- "tundra",
- "steppe",
- "mesa",
- "grove",
- "rainforest",
- "moraine",
- "wildflower",
- "peak",
- "boulder",
- "gypsum",
- "zest"
- ],
- "title": "Preset Voice Options"
- },
- {
- "type": "string",
- "title": "RimeAI Voice ID"
- }
+ "anthropic"
]
},
"model": {
"type": "string",
- "description": "This is the model that will be used. Defaults to 'v1' when not specified.",
+ "description": "This is the specific model that will be used.",
+ "maxLength": 100,
"enum": [
- "v1",
- "mist",
- "mistv2"
- ],
- "example": "mistv2"
- },
- "speed": {
- "type": "number",
- "description": "This is the speed multiplier that will be used.",
- "minimum": 0.1,
- "example": null
- },
- "pauseBetweenBrackets": {
- "type": "boolean",
- "description": "This is a flag that controls whether to add slight pauses using angle brackets. Example: “Hi. <200> I’d love to have a conversation with you.” adds a 200ms pause between the first and second sentences.",
- "example": false
- },
- "phonemizeBetweenBrackets": {
- "type": "boolean",
- "description": "This is a flag that controls whether text inside brackets should be phonemized (converted to phonetic pronunciation) - Example: \"{h'El.o} World\" will pronounce \"Hello\" as expected.",
- "example": false
- },
- "reduceLatency": {
- "type": "boolean",
- "description": "This is a flag that controls whether to optimize for reduced latency in streaming. https://docs.rime.ai/api-reference/endpoint/websockets#param-reduce-latency",
- "example": false
- },
- "inlineSpeedAlpha": {
- "type": "string",
- "description": "This is a string that allows inline speed control using alpha notation. https://docs.rime.ai/api-reference/endpoint/websockets#param-inline-speed-alpha",
- "example": null
- },
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
- {
- "$ref": "#/components/schemas/ChunkPlan"
- }
+ "claude-3-opus-20240229",
+ "claude-3-sonnet-20240229",
+ "claude-3-haiku-20240307",
+ "claude-3-5-sonnet-20240620",
+ "claude-3-5-sonnet-20241022",
+ "claude-3-5-haiku-20241022",
+ "claude-3-7-sonnet-20250219",
+ "claude-opus-4-20250514",
+ "claude-sonnet-4-20250514"
]
},
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "thinking": {
+ "description": "This is the optional configuration for Anthropic's thinking feature.\n\n- Only applicable for `claude-3-7-sonnet-20250219` model.\n- If provided, `maxTokens` must be greater than `thinking.budgetTokens`.",
"allOf": [
{
- "$ref": "#/components/schemas/FallbackPlan"
+ "$ref": "#/components/schemas/AnthropicThinkingConfig"
}
]
+ },
+ "temperature": {
+ "type": "number",
+ "description": "This is the temperature of the model.",
+ "minimum": 0,
+ "maximum": 2
+ },
+ "maxTokens": {
+ "type": "number",
+ "description": "This is the max tokens of the model.",
+ "minimum": 50,
+ "maximum": 10000
}
},
"required": [
"provider",
- "voiceId"
+ "model"
]
},
- "SmallestAIVoice": {
+ "WorkflowGoogleModel": {
"type": "object",
"properties": {
"provider": {
"type": "string",
- "description": "This is the voice provider that will be used.",
+ "description": "This is the provider of the model (`google`).",
"enum": [
- "smallest-ai"
- ]
- },
- "voiceId": {
- "description": "This is the provider-specific ID that will be used.",
- "oneOf": [
- {
- "type": "string",
- "enum": [
- "emily",
- "jasmine",
- "arman",
- "james",
- "mithali",
- "aravind",
- "raj",
- "diya",
- "raman",
- "ananya",
- "isha",
- "william",
- "aarav",
- "monika",
- "niharika",
- "deepika",
- "raghav",
- "kajal",
- "radhika",
- "mansi",
- "nisha",
- "saurabh",
- "pooja",
- "saina",
- "sanya"
- ],
- "title": "Preset Voice Options"
- },
- {
- "type": "string",
- "title": "Smallest AI Voice ID"
- }
+ "google"
]
},
"model": {
"type": "string",
- "description": "Smallest AI voice model to use. Defaults to 'lightning' when not specified.",
+ "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b",
+ "maxLength": 100,
"enum": [
- "lightning"
+ "gemini-2.5-pro-preview-05-06",
+ "gemini-2.5-flash-preview-05-20",
+ "gemini-2.5-flash-preview-04-17",
+ "gemini-2.0-flash-thinking-exp",
+ "gemini-2.0-pro-exp-02-05",
+ "gemini-2.0-flash",
+ "gemini-2.0-flash-lite",
+ "gemini-2.0-flash-lite-preview-02-05",
+ "gemini-2.0-flash-exp",
+ "gemini-2.0-flash-realtime-exp",
+ "gemini-1.5-flash",
+ "gemini-1.5-flash-002",
+ "gemini-1.5-pro",
+ "gemini-1.5-pro-002",
+ "gemini-1.0-pro"
]
},
- "speed": {
+ "temperature": {
"type": "number",
- "description": "This is the speed multiplier that will be used.",
- "example": null
- },
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
- {
- "$ref": "#/components/schemas/ChunkPlan"
- }
- ]
+ "description": "This is the temperature of the model.",
+ "minimum": 0,
+ "maximum": 2
},
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
- "allOf": [
- {
- "$ref": "#/components/schemas/FallbackPlan"
- }
- ]
+ "maxTokens": {
+ "type": "number",
+ "description": "This is the max tokens of the model.",
+ "minimum": 50,
+ "maximum": 10000
}
},
"required": [
"provider",
- "voiceId"
+ "model"
]
},
- "TavusConversationProperties": {
+ "WorkflowCustomModel": {
"type": "object",
"properties": {
- "maxCallDuration": {
- "type": "number",
- "description": "The maximum duration of the call in seconds. The default `maxCallDuration` is 3600 seconds (1 hour).\nOnce the time limit specified by this parameter has been reached, the conversation will automatically shut down."
- },
- "participantLeftTimeout": {
- "type": "number",
- "description": "The duration in seconds after which the call will be automatically shut down once the last participant leaves."
- },
- "participantAbsentTimeout": {
- "type": "number",
- "description": "Starting from conversation creation, the duration in seconds after which the call will be automatically shut down if no participant joins the call.\nDefault is 300 seconds (5 minutes)."
+ "provider": {
+ "type": "string",
+ "description": "This is the provider of the model (`custom-llm`).",
+ "enum": [
+ "custom-llm"
+ ]
},
- "enableRecording": {
- "type": "boolean",
- "description": "If true, the user will be able to record the conversation."
+ "metadataSendMode": {
+ "type": "string",
+ "description": "This determines whether metadata is sent in requests to the custom provider.\n\n- `off` will not send any metadata. payload will look like `{ messages }`\n- `variable` will send `assistant.metadata` as a variable on the payload. payload will look like `{ messages, metadata }`\n- `destructured` will send `assistant.metadata` fields directly on the payload. payload will look like `{ messages, ...metadata }`\n\nFurther, `variable` and `destructured` will send `call`, `phoneNumber`, and `customer` objects in the payload.\n\nDefault is `variable`.",
+ "enum": [
+ "off",
+ "variable",
+ "destructured"
+ ]
},
- "enableTranscription": {
- "type": "boolean",
- "description": "If true, the user will be able to transcribe the conversation.\nYou can find more instructions on displaying transcriptions if you are using your custom DailyJS components here.\nYou need to have an event listener on Daily that listens for `app-messages`."
+ "url": {
+ "type": "string",
+ "description": "These is the URL we'll use for the OpenAI client's `baseURL`. Ex. https://openrouter.ai/api/v1"
},
- "applyGreenscreen": {
- "type": "boolean",
- "description": "If true, the background will be replaced with a greenscreen (RGB values: `[0, 255, 155]`).\nYou can use WebGL on the frontend to make the greenscreen transparent or change its color."
+ "timeoutSeconds": {
+ "type": "number",
+ "description": "This sets the timeout for the connection to the custom provider without needing to stream any tokens back. Default is 20 seconds.",
+ "minimum": 20,
+ "maximum": 600
},
- "language": {
+ "model": {
"type": "string",
- "description": "The language of the conversation. Please provide the **full language name**, not the two-letter code.\nIf you are using your own TTS voice, please ensure it supports the language you provide.\nIf you are using a stock replica or default persona, please note that only ElevenLabs and Cartesia supported languages are available.\nYou can find a full list of supported languages for Cartesia here, for ElevenLabs here, and for PlayHT here."
+ "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b",
+ "maxLength": 100
},
- "recordingS3BucketName": {
- "type": "string",
- "description": "The name of the S3 bucket where the recording will be stored."
+ "temperature": {
+ "type": "number",
+ "description": "This is the temperature of the model.",
+ "minimum": 0,
+ "maximum": 2
},
- "recordingS3BucketRegion": {
- "type": "string",
- "description": "The region of the S3 bucket where the recording will be stored."
+ "maxTokens": {
+ "type": "number",
+ "description": "This is the max tokens of the model.",
+ "minimum": 50,
+ "maximum": 10000
+ }
+ },
+ "required": [
+ "provider",
+ "url",
+ "model"
+ ]
+ },
+ "GlobalNodePlan": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "This is the flag to determine if this node is a global node\n\n@default false",
+ "default": false
},
- "awsAssumeRoleArn": {
+ "enterCondition": {
"type": "string",
- "description": "The ARN of the role that will be assumed to access the S3 bucket."
+ "description": "This is the condition that will be checked to determine if the global node should be executed.\n\n@default ''",
+ "maxLength": 1000,
+ "default": ""
}
}
},
- "TavusVoice": {
+ "VariableExtractionPlan": {
"type": "object",
"properties": {
- "provider": {
+ "schema": {
+ "description": "This is the schema of parameters we want to extract from the response",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/JsonSchema"
+ }
+ ]
+ }
+ }
+ },
+ "ConversationNode": {
+ "type": "object",
+ "properties": {
+ "type": {
"type": "string",
- "description": "This is the voice provider that will be used.",
+ "description": "This is the Conversation node. This can be used to start a conversation with the customer.\n\nThe flow is:\n- Workflow starts the conversation node\n- Model is active with the `prompt` and global context.\n- Model will call a tool to exit this node.\n- Workflow will extract variables from the conversation.\n- Workflow continues.",
"enum": [
- "tavus"
+ "conversation"
]
},
- "voiceId": {
- "description": "This is the provider-specific ID that will be used.",
+ "model": {
+ "description": "This is the model for the node.\n\nThis overrides `workflow.model`.",
"oneOf": [
{
- "type": "string",
- "enum": [
- "r52da2535a"
- ],
- "title": "Preset Voice Options"
+ "$ref": "#/components/schemas/WorkflowOpenAIModel",
+ "title": "WorkflowOpenAIModel"
},
{
- "type": "string",
- "title": "Tavus Voice ID"
+ "$ref": "#/components/schemas/WorkflowAnthropicModel",
+ "title": "WorkflowAnthropicModel"
+ },
+ {
+ "$ref": "#/components/schemas/WorkflowGoogleModel",
+ "title": "WorkflowGoogleModel"
+ },
+ {
+ "$ref": "#/components/schemas/WorkflowCustomModel",
+ "title": "WorkflowCustomModel"
}
]
},
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
+ "transcriber": {
+ "description": "This is the transcriber for the node.\n\nThis overrides `workflow.transcriber`.",
+ "oneOf": [
{
- "$ref": "#/components/schemas/ChunkPlan"
+ "$ref": "#/components/schemas/AssemblyAITranscriber",
+ "title": "AssemblyAITranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/AzureSpeechTranscriber",
+ "title": "AzureSpeechTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/CustomTranscriber",
+ "title": "CustomTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/DeepgramTranscriber",
+ "title": "DeepgramTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/ElevenLabsTranscriber",
+ "title": "ElevenLabsTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/GladiaTranscriber",
+ "title": "GladiaTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleTranscriber",
+ "title": "GoogleTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/SpeechmaticsTranscriber",
+ "title": "SpeechmaticsTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/TalkscriberTranscriber",
+ "title": "TalkscriberTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAITranscriber",
+ "title": "OpenAITranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/CartesiaTranscriber",
+ "title": "CartesiaTranscriber"
}
]
},
- "personaId": {
- "type": "string",
- "description": "This is the unique identifier for the persona that the replica will use in the conversation."
- },
- "callbackUrl": {
- "type": "string",
- "description": "This is the url that will receive webhooks with updates regarding the conversation state."
- },
- "conversationName": {
- "type": "string",
- "description": "This is the name for the conversation."
- },
- "conversationalContext": {
- "type": "string",
- "description": "This is the context that will be appended to any context provided in the persona, if one is provided."
+ "voice": {
+ "description": "This is the voice for the node.\n\nThis overrides `workflow.voice`.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AzureVoice",
+ "title": "AzureVoice"
+ },
+ {
+ "$ref": "#/components/schemas/CartesiaVoice",
+ "title": "CartesiaVoice"
+ },
+ {
+ "$ref": "#/components/schemas/CustomVoice",
+ "title": "CustomVoice"
+ },
+ {
+ "$ref": "#/components/schemas/DeepgramVoice",
+ "title": "DeepgramVoice"
+ },
+ {
+ "$ref": "#/components/schemas/ElevenLabsVoice",
+ "title": "ElevenLabsVoice"
+ },
+ {
+ "$ref": "#/components/schemas/HumeVoice",
+ "title": "HumeVoice"
+ },
+ {
+ "$ref": "#/components/schemas/LMNTVoice",
+ "title": "LMNTVoice"
+ },
+ {
+ "$ref": "#/components/schemas/NeuphonicVoice",
+ "title": "NeuphonicVoice"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAIVoice",
+ "title": "OpenAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/PlayHTVoice",
+ "title": "PlayHTVoice"
+ },
+ {
+ "$ref": "#/components/schemas/RimeAIVoice",
+ "title": "RimeAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/SmallestAIVoice",
+ "title": "SmallestAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/TavusVoice",
+ "title": "TavusVoice"
+ },
+ {
+ "$ref": "#/components/schemas/VapiVoice",
+ "title": "VapiVoice"
+ },
+ {
+ "$ref": "#/components/schemas/SesameVoice",
+ "title": "SesameVoice"
+ }
+ ]
},
- "customGreeting": {
+ "prompt": {
"type": "string",
- "description": "This is the custom greeting that the replica will give once a participant joines the conversation."
+ "maxLength": 5000
},
- "properties": {
- "description": "These are optional properties used to customize the conversation.",
+ "globalNodePlan": {
+ "description": "This is the plan for the global node.",
"allOf": [
{
- "$ref": "#/components/schemas/TavusConversationProperties"
+ "$ref": "#/components/schemas/GlobalNodePlan"
}
]
},
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "variableExtractionPlan": {
+ "description": "This is the plan that controls the variable extraction from the user's response.",
"allOf": [
{
- "$ref": "#/components/schemas/FallbackPlan"
+ "$ref": "#/components/schemas/VariableExtractionPlan"
}
]
+ },
+ "name": {
+ "type": "string",
+ "maxLength": 80
+ },
+ "isStart": {
+ "type": "boolean",
+ "description": "This is whether or not the node is the start of the workflow."
+ },
+ "metadata": {
+ "type": "object",
+ "description": "This is for metadata you want to store on the task."
}
},
"required": [
- "provider",
- "voiceId"
+ "type",
+ "name"
]
},
- "VapiVoice": {
+ "ToolNode": {
"type": "object",
"properties": {
- "provider": {
+ "type": {
"type": "string",
- "description": "This is the voice provider that will be used.",
+ "description": "This is the Tool node. This can be used to call a tool in your workflow.\n\nThe flow is:\n- Workflow starts the tool node\n- Model is called to extract parameters needed by the tool from the conversation history\n- Tool is called with the parameters\n- Server returns a response\n- Workflow continues with the response",
"enum": [
- "vapi"
+ "tool"
]
},
- "voiceId": {
- "type": "string",
- "description": "The voices provided by Vapi",
- "enum": [
- "Elliot",
- "Rohan",
- "Lily",
- "Savannah",
- "Hana",
- "Neha",
- "Cole",
- "Harry",
- "Paige",
- "Spencer"
+ "tool": {
+ "description": "This is the tool to call. To use an existing tool, send `toolId` instead.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateApiRequestToolDTO",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateBashToolDTO",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateComputerToolDTO",
+ "title": "ComputerTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDtmfToolDTO",
+ "title": "DtmfTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateEndCallToolDTO",
+ "title": "EndCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateFunctionToolDTO",
+ "title": "FunctionTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
+ "title": "GoogleCalendarCreateEventTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
+ "title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateQueryToolDTO",
+ "title": "QueryTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
+ "title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmsToolDTO",
+ "title": "SmsTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTextEditorToolDTO",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTransferCallToolDTO",
+ "title": "TransferCallTool"
+ }
]
},
- "speed": {
- "type": "number",
- "description": "This is the speed multiplier that will be used.\n\n@default 1",
- "minimum": 0.25,
- "maximum": 2,
- "default": 1
+ "toolId": {
+ "type": "string",
+ "description": "This is the tool to call. To use a transient tool, send `tool` instead."
},
- "language": {
+ "name": {
"type": "string",
- "description": "This is the language code (ISO 639-1) that will be used.\n\n@default 'en-US'",
- "enum": [
- "en-US",
- "en-GB",
- "en-AU",
- "en-CA",
- "ja",
- "zh",
- "de",
- "hi",
- "fr-FR",
- "fr-CA",
- "ko",
- "pt-BR",
- "pt-PT",
- "it",
- "es-ES",
- "es-MX",
- "id",
- "nl",
- "tr",
- "fil",
- "pl",
- "sv",
- "bg",
- "ro",
- "ar-SA",
- "ar-AE",
- "cs",
- "el",
- "fi",
- "hr",
- "ms",
- "sk",
- "da",
- "ta",
- "uk",
- "ru",
- "hu",
- "no",
- "vi"
- ],
- "default": "en-US"
+ "maxLength": 80
},
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
- {
- "$ref": "#/components/schemas/ChunkPlan"
- }
- ]
+ "isStart": {
+ "type": "boolean",
+ "description": "This is whether or not the node is the start of the workflow."
},
- "fallbackPlan": {
- "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
- "allOf": [
- {
- "$ref": "#/components/schemas/FallbackPlan"
- }
- ]
+ "metadata": {
+ "type": "object",
+ "description": "This is for metadata you want to store on the task."
}
},
"required": [
- "provider",
- "voiceId"
+ "type",
+ "name"
]
},
- "FallbackAzureVoice": {
+ "AIEdgeCondition": {
"type": "object",
"properties": {
- "provider": {
+ "type": {
"type": "string",
- "description": "This is the voice provider that will be used.",
"enum": [
- "azure"
+ "ai"
]
},
- "voiceId": {
- "description": "This is the provider-specific ID that will be used.",
+ "prompt": {
+ "type": "string",
+ "description": "This is the prompt for the AI edge condition. It should evaluate to a boolean.",
+ "maxLength": 1000
+ }
+ },
+ "required": [
+ "type",
+ "prompt"
+ ]
+ },
+ "Edge": {
+ "type": "object",
+ "properties": {
+ "condition": {
"oneOf": [
{
- "type": "string",
- "enum": [
- "andrew",
- "brian",
- "emma"
- ],
- "title": "Preset Voice Options"
- },
- {
- "type": "string",
- "title": "Azure Voice ID"
+ "$ref": "#/components/schemas/AIEdgeCondition",
+ "title": "AIEdgeCondition"
}
]
},
- "speed": {
- "type": "number",
- "description": "This is the speed multiplier that will be used.",
- "minimum": 0.5,
- "maximum": 2
+ "from": {
+ "type": "string",
+ "maxLength": 80
},
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
- {
- "$ref": "#/components/schemas/ChunkPlan"
- }
- ]
+ "to": {
+ "type": "string",
+ "maxLength": 80
+ },
+ "metadata": {
+ "type": "object",
+ "description": "This is for metadata you want to store on the edge."
}
},
"required": [
- "provider",
- "voiceId"
+ "from",
+ "to"
]
},
- "FallbackCartesiaVoice": {
+ "CompliancePlan": {
"type": "object",
"properties": {
- "provider": {
- "type": "string",
- "description": "This is the voice provider that will be used.",
- "enum": [
- "cartesia"
- ]
- },
- "voiceId": {
- "type": "string",
- "description": "The ID of the particular voice you want to use."
+ "hipaaEnabled": {
+ "type": "boolean",
+ "description": "When this is enabled, no logs, recordings, or transcriptions will be stored.\nAt the end of the call, you will still receive an end-of-call-report message to store on your server. Defaults to false.",
+ "example": {
+ "hipaaEnabled": false
+ }
},
- "model": {
- "type": "string",
- "description": "This is the model that will be used. This is optional and will default to the correct model for the voiceId.",
- "enum": [
- "sonic-2",
- "sonic-english",
- "sonic-multilingual",
- "sonic-preview",
- "sonic"
- ],
- "example": "sonic-english"
+ "pciEnabled": {
+ "type": "boolean",
+ "description": "When this is enabled, the user will be restricted to use PCI-compliant providers, and no logs or transcripts are stored.\nAt the end of the call, you will receive an end-of-call-report message to store on your server. Defaults to false.",
+ "example": {
+ "pciEnabled": false
+ }
+ }
+ }
+ },
+ "StructuredDataPlan": {
+ "type": "object",
+ "properties": {
+ "messages": {
+ "description": "These are the messages used to generate the structured data.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert data extractor. You will be given a transcript of a call. Extract structured data per the JSON Schema. DO NOT return anything except the structured data.\\n\\nJson Schema:\\\\n{{schema}}\\n\\nOnly respond with the JSON.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: the transcript of the call from `call.artifact.transcript`- {{systemPrompt}}: the system prompt of the call from `assistant.model.messages[type=system].content`- {{schema}}: the schema of the structured data from `structuredDataPlan.schema`- {{endedReason}}: the ended reason of the call from `call.endedReason`",
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
},
- "language": {
- "type": "string",
- "description": "This is the language that will be used. This is optional and will default to the correct language for the voiceId.",
- "enum": [
- "en",
- "de",
- "es",
- "fr",
- "ja",
- "pt",
- "zh",
- "hi",
- "it",
- "ko",
- "nl",
- "pl",
- "ru",
- "sv",
- "tr"
- ],
- "example": "en"
+ "enabled": {
+ "type": "boolean",
+ "description": "This determines whether structured data is generated and stored in `call.analysis.structuredData`. Defaults to false.\n\nUsage:\n- If you want to extract structured data, set this to true and provide a `schema`.\n\n@default false"
},
- "experimentalControls": {
- "description": "Experimental controls for Cartesia voice generation",
+ "schema": {
+ "description": "This is the schema of the structured data. The 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).",
"allOf": [
{
- "$ref": "#/components/schemas/CartesiaExperimentalControls"
+ "$ref": "#/components/schemas/JsonSchema"
}
]
},
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "timeoutSeconds": {
+ "type": "number",
+ "description": "This is how long the request is tried before giving up. When request times out, `call.analysis.structuredData` will be empty.\n\nUsage:\n- To guarantee the structured data is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds",
+ "minimum": 1,
+ "maximum": 60
+ }
+ }
+ },
+ "StructuredDataMultiPlan": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "This is the key of the structured data plan in the catalog."
+ },
+ "plan": {
+ "description": "This is an individual structured data plan in the catalog.",
"allOf": [
{
- "$ref": "#/components/schemas/ChunkPlan"
+ "$ref": "#/components/schemas/StructuredDataPlan"
}
]
}
},
"required": [
- "provider",
- "voiceId"
+ "key",
+ "plan"
]
},
- "FallbackCustomVoice": {
+ "SuccessEvaluationPlan": {
"type": "object",
"properties": {
- "provider": {
+ "rubric": {
"type": "string",
- "description": "This is the voice provider that will be used. Use `custom-voice` for providers that are not natively supported.",
"enum": [
- "custom-voice"
+ "NumericScale",
+ "DescriptiveScale",
+ "Checklist",
+ "Matrix",
+ "PercentageScale",
+ "LikertScale",
+ "AutomaticRubric",
+ "PassFail"
+ ],
+ "description": "This enforces the rubric of the evaluation. The output is stored in `call.analysis.successEvaluation`.\n\nOptions include:\n- 'NumericScale': A scale of 1 to 10.\n- 'DescriptiveScale': A scale of Excellent, Good, Fair, Poor.\n- 'Checklist': A checklist of criteria and their status.\n- 'Matrix': A grid that evaluates multiple criteria across different performance levels.\n- 'PercentageScale': A scale of 0% to 100%.\n- 'LikertScale': A scale of Strongly Agree, Agree, Neutral, Disagree, Strongly Disagree.\n- 'AutomaticRubric': Automatically break down evaluation into several criteria, each with its own score.\n- 'PassFail': A simple 'true' if call passed, 'false' if not.\n\nDefault is 'PassFail'."
+ },
+ "messages": {
+ "description": "These are the messages used to generate the success evaluation.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert call evaluator. You will be given a transcript of a call and the system prompt of the AI participant. Determine if the call was successful based on the objectives inferred from the system prompt. DO NOT return anything except the result.\\n\\nRubric:\\\\n{{rubric}}\\n\\nOnly respond with the result.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here was the system prompt of the call:\\n\\n{{systemPrompt}}\\n\\n. Here is the ended reason of the call:\\n\\n{{endedReason}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: the transcript of the call from `call.artifact.transcript`- {{systemPrompt}}: the system prompt of the call from `assistant.model.messages[type=system].content`- {{rubric}}: the rubric of the success evaluation from `successEvaluationPlan.rubric`- {{endedReason}}: the ended reason of the call from `call.endedReason`",
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ },
+ "enabled": {
+ "type": "boolean",
+ "description": "This determines whether a success evaluation is generated and stored in `call.analysis.successEvaluation`. Defaults to true.\n\nUsage:\n- If you want to disable the success evaluation, set this to false.\n\n@default true"
+ },
+ "timeoutSeconds": {
+ "type": "number",
+ "description": "This is how long the request is tried before giving up. When request times out, `call.analysis.successEvaluation` will be empty.\n\nUsage:\n- To guarantee the success evaluation is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds",
+ "minimum": 1,
+ "maximum": 60
+ }
+ }
+ },
+ "AnalysisPlan": {
+ "type": "object",
+ "properties": {
+ "minMessagesThreshold": {
+ "type": "number",
+ "description": "The minimum number of messages required to run the analysis plan.\nIf the number of messages is less than this, analysis will be skipped.\n@default 2",
+ "minimum": 0
+ },
+ "summaryPlan": {
+ "description": "This is the plan for generating the summary of the call. This outputs to `call.analysis.summary`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SummaryPlan"
+ }
]
},
- "server": {
- "description": "This is where the voice request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"message\": {\n \"type\": \"voice-request\",\n \"text\": \"Hello, world!\",\n \"sampleRate\": 24000,\n ...other metadata about the call...\n }\n}\n\nResponse Expected: 1-channel 16-bit raw PCM audio at the sample rate specified in the request. Here is how the response will be piped to the transport:\n```\nresponse.on('data', (chunk: Buffer) => {\n outputStream.write(chunk);\n});\n```",
+ "structuredDataPlan": {
+ "description": "This is the plan for generating the structured data from the call. This outputs to `call.analysis.structuredData`.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/StructuredDataPlan"
}
]
},
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "structuredDataMultiPlan": {
+ "description": "This is an array of structured data plan catalogs. Each entry includes a `key` and a `plan` for generating the structured data from the call. This outputs to `call.analysis.structuredDataMulti`.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/StructuredDataMultiPlan"
+ }
+ },
+ "successEvaluationPlan": {
+ "description": "This is the plan for generating the success evaluation of the call. This outputs to `call.analysis.successEvaluation`.",
"allOf": [
{
- "$ref": "#/components/schemas/ChunkPlan"
+ "$ref": "#/components/schemas/SuccessEvaluationPlan"
}
]
}
- },
- "required": [
- "provider",
- "server"
- ]
+ }
},
- "FallbackDeepgramVoice": {
+ "RegexOption": {
"type": "object",
"properties": {
- "provider": {
+ "type": {
"type": "string",
- "description": "This is the voice provider that will be used.",
+ "description": "This is the type of the regex option. Options are:\n- `ignore-case`: Ignores the case of the text being matched. Add\n- `whole-word`: Matches whole words only.\n- `multi-line`: Matches across multiple lines.",
"enum": [
- "deepgram"
+ "ignore-case",
+ "whole-word",
+ "multi-line"
]
},
- "voiceId": {
+ "enabled": {
+ "type": "boolean",
+ "description": "This is whether to enable the option.\n\n@default false"
+ }
+ },
+ "required": [
+ "type",
+ "enabled"
+ ]
+ },
+ "AssistantCustomEndpointingRule": {
+ "type": "object",
+ "properties": {
+ "type": {
"type": "string",
- "description": "This is the provider-specific ID that will be used.",
+ "description": "This endpointing rule is based on the last assistant message before customer started speaking.\n\nFlow:\n- Assistant speaks\n- Customer starts speaking\n- Customer transcription comes in\n- This rule is evaluated on the last assistant message\n- If a match is found based on `regex`, the endpointing timeout is set to `timeoutSeconds`\n\nUsage:\n- If you have yes/no questions in your use case like \"are you interested in a loan?\", you can set a shorter timeout.\n- If you have questions where the customer may pause to look up information like \"what's my account number?\", you can set a longer timeout.",
"enum": [
- "asteria",
- "luna",
- "stella",
- "athena",
- "hera",
- "orion",
- "arcas",
- "perseus",
- "angus",
- "orpheus",
- "helios",
- "zeus",
- "thalia",
- "andromeda",
- "helena",
- "apollo",
- "arcas",
- "aries",
- "amalthea",
- "andromeda",
- "apollo",
- "arcas",
- "aries",
- "asteria",
- "athena",
- "atlas",
- "aurora",
- "callista",
- "cora",
- "cordelia",
- "delia",
- "draco",
- "electra",
- "harmonia",
- "helena",
- "hera",
- "hermes",
- "hyperion",
- "iris",
- "janus",
- "juno",
- "jupiter",
- "luna",
- "mars",
- "minerva",
- "neptune",
- "odysseus",
- "ophelia",
- "orion",
- "orpheus",
- "pandora",
- "phoebe",
- "pluto",
- "saturn",
- "selene",
- "thalia",
- "theia",
- "vesta",
- "zeus"
- ],
- "title": "This is the Deepgram Voice ID"
+ "assistant"
+ ]
},
- "model": {
+ "regex": {
"type": "string",
- "description": "This is the model that will be used. Defaults to 'aura-2' when not specified.",
- "enum": [
- "aura",
- "aura-2"
- ],
- "example": "aura-2"
+ "description": "This is the regex pattern to match.\n\nNote:\n- This works by using the `RegExp.test` method in Node.JS. Eg. `/hello/.test(\"hello there\")` will return `true`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.\n- `RegExp.test` does substring matching, so `/cat/.test(\"I love cats\")` will return `true`. To do full string matching, send \"^cat$\"."
},
- "mipOptOut": {
- "type": "boolean",
- "description": "If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false",
- "example": false,
- "default": false
+ "regexOptions": {
+ "description": "These are the options for the regex match. Defaults to all disabled.\n\n@default []",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RegexOption"
+ }
},
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
- {
- "$ref": "#/components/schemas/ChunkPlan"
- }
- ]
+ "timeoutSeconds": {
+ "type": "number",
+ "description": "This is the endpointing timeout in seconds, if the rule is matched.",
+ "minimum": 0,
+ "maximum": 15
}
},
"required": [
- "provider",
- "voiceId"
+ "type",
+ "regex",
+ "timeoutSeconds"
]
},
- "FallbackElevenLabsVoice": {
+ "CustomerCustomEndpointingRule": {
"type": "object",
"properties": {
- "provider": {
+ "type": {
"type": "string",
- "description": "This is the voice provider that will be used.",
+ "description": "This endpointing rule is based on current customer message as they are speaking.\n\nFlow:\n- Assistant speaks\n- Customer starts speaking\n- Customer transcription comes in\n- This rule is evaluated on the current customer transcription\n- If a match is found based on `regex`, the endpointing timeout is set to `timeoutSeconds`\n\nUsage:\n- If you want to wait longer while customer is speaking numbers, you can set a longer timeout.",
"enum": [
- "11labs"
+ "customer"
]
},
- "voiceId": {
- "description": "This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.",
- "oneOf": [
- {
- "type": "string",
- "enum": [
- "burt",
- "marissa",
- "andrea",
- "sarah",
- "phillip",
- "steve",
- "joseph",
- "myra",
- "paula",
- "ryan",
- "drew",
- "paul",
- "mrb",
- "matilda",
- "mark"
- ],
- "title": "Preset Voice Options"
- },
- {
- "type": "string",
- "title": "11Labs Voice ID"
- }
- ]
+ "regex": {
+ "type": "string",
+ "description": "This is the regex pattern to match.\n\nNote:\n- This works by using the `RegExp.test` method in Node.JS. Eg. `/hello/.test(\"hello there\")` will return `true`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.\n- `RegExp.test` does substring matching, so `/cat/.test(\"I love cats\")` will return `true`. To do full string matching, send \"^cat$\"."
},
- "stability": {
- "type": "number",
- "description": "Defines the stability for voice settings.",
- "minimum": 0,
- "maximum": 1,
- "example": 0.5
+ "regexOptions": {
+ "description": "These are the options for the regex match. Defaults to all disabled.\n\n@default []",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RegexOption"
+ }
},
- "similarityBoost": {
+ "timeoutSeconds": {
"type": "number",
- "description": "Defines the similarity boost for voice settings.",
+ "description": "This is the endpointing timeout in seconds, if the rule is matched.",
"minimum": 0,
- "maximum": 1,
- "example": 0.75
+ "maximum": 15
+ }
+ },
+ "required": [
+ "type",
+ "regex",
+ "timeoutSeconds"
+ ]
+ },
+ "BothCustomEndpointingRule": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "This endpointing rule is based on both the last assistant message and the current customer message as they are speaking.\n\nFlow:\n- Assistant speaks\n- Customer starts speaking\n- Customer transcription comes in\n- This rule is evaluated on the last assistant message and the current customer transcription\n- If assistant message matches `assistantRegex` AND customer message matches `customerRegex`, the endpointing timeout is set to `timeoutSeconds`\n\nUsage:\n- If you want to wait longer while customer is speaking numbers, you can set a longer timeout.",
+ "enum": [
+ "both"
+ ]
},
- "style": {
- "type": "number",
- "description": "Defines the style for voice settings.",
- "minimum": 0,
- "maximum": 1,
- "example": 0
+ "assistantRegex": {
+ "type": "string",
+ "description": "This is the regex pattern to match the assistant's message.\n\nNote:\n- This works by using the `RegExp.test` method in Node.JS. Eg. `/hello/.test(\"hello there\")` will return `true`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.\n- `RegExp.test` does substring matching, so `/cat/.test(\"I love cats\")` will return `true`. To do full string matching, send \"^cat$\"."
},
- "useSpeakerBoost": {
- "type": "boolean",
- "description": "Defines the use speaker boost for voice settings.",
- "example": false
+ "assistantRegexOptions": {
+ "description": "These are the options for the assistant's message regex match. Defaults to all disabled.\n\n@default []",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RegexOption"
+ }
},
- "speed": {
- "type": "number",
- "description": "Defines the speed for voice settings.",
- "minimum": 0.7,
- "maximum": 1.2,
- "example": 0.9
+ "customerRegex": {
+ "type": "string"
},
- "optimizeStreamingLatency": {
+ "customerRegexOptions": {
+ "description": "These are the options for the customer's message regex match. Defaults to all disabled.\n\n@default []",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RegexOption"
+ }
+ },
+ "timeoutSeconds": {
"type": "number",
- "description": "Defines the optimize streaming latency for voice settings. Defaults to 3.",
+ "description": "This is the endpointing timeout in seconds, if the rule is matched.",
"minimum": 0,
- "maximum": 4,
- "example": 3
- },
- "enableSsmlParsing": {
- "type": "boolean",
- "description": "This enables the use of https://elevenlabs.io/docs/speech-synthesis/prompting#pronunciation. Defaults to false to save latency.\n\n@default false",
- "example": false
- },
- "autoMode": {
- "type": "boolean",
- "description": "Defines the auto mode for voice settings. Defaults to false.",
- "example": false
- },
- "model": {
+ "maximum": 15
+ }
+ },
+ "required": [
+ "type",
+ "assistantRegex",
+ "customerRegex",
+ "timeoutSeconds"
+ ]
+ },
+ "VapiSmartEndpointingPlan": {
+ "type": "object",
+ "properties": {
+ "provider": {
"type": "string",
- "description": "This is the model that will be used. Defaults to 'eleven_turbo_v2' if not specified.",
+ "description": "This is the provider for the smart endpointing plan.",
"enum": [
- "eleven_multilingual_v2",
- "eleven_turbo_v2",
- "eleven_turbo_v2_5",
- "eleven_flash_v2",
- "eleven_flash_v2_5",
- "eleven_monolingual_v1"
+ "vapi",
+ "livekit"
],
- "example": "eleven_turbo_v2_5"
- },
- "language": {
- "type": "string",
- "description": "This is the language (ISO 639-1) that is enforced for the model. Currently only Turbo v2.5 supports language enforcement. For other models, an error will be returned if language code is provided."
- },
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
- {
- "$ref": "#/components/schemas/ChunkPlan"
- }
- ]
+ "example": "vapi"
}
},
"required": [
- "provider",
- "voiceId"
+ "provider"
]
},
- "FallbackHumeVoice": {
+ "LivekitSmartEndpointingPlan": {
"type": "object",
"properties": {
"provider": {
"type": "string",
- "description": "This is the voice provider that will be used.",
- "enum": [
- "hume"
- ]
- },
- "model": {
- "type": "string",
- "description": "This is the model that will be used.",
+ "description": "This is the provider for the smart endpointing plan.",
"enum": [
- "octave"
+ "vapi",
+ "livekit"
],
- "example": "octave"
- },
- "voiceId": {
- "type": "string",
- "description": "The ID of the particular voice you want to use."
- },
- "isCustomHumeVoice": {
- "type": "boolean",
- "description": "Indicates whether the chosen voice is a preset Hume AI voice or a custom voice.",
- "example": false
+ "example": "livekit"
},
- "description": {
+ "waitFunction": {
"type": "string",
- "description": "Natural language instructions describing how the synthesized speech should sound, including but not limited to tone, intonation, pacing, and accent (e.g., 'a soft, gentle voice with a strong British accent').\n\nIf a Voice is specified in the request, this description serves as acting instructions.\nIf no Voice is specified, a new voice is generated based on this description."
- },
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
- {
- "$ref": "#/components/schemas/ChunkPlan"
- }
+ "description": "This expression describes how long the bot will wait to start speaking based on the likelihood that the user has reached an endpoint.\n\nThis is a millisecond valued function. It maps probabilities (real numbers on [0,1]) to milliseconds that the bot should wait before speaking ([0, \\infty]). Any negative values that are returned are set to zero (the bot can't start talking in the past).\n\nA probability of zero represents very high confidence that the caller has stopped speaking, and would like the bot to speak to them. A probability of one represents very high confidence that the caller is still speaking.\n\nUnder the hood, this is parsed into a mathjs expression. Whatever you use to write your expression needs to be valid with respect to mathjs\n\n@default \"20 + 500 * sqrt(x) + 2500 * x^3\"",
+ "examples": [
+ "70 + 4000 * x",
+ "200 + 8000 * x",
+ "4000 * (1 - cos(pi * x))"
]
}
},
"required": [
- "provider",
- "voiceId"
+ "provider"
]
},
- "FallbackLMNTVoice": {
+ "TranscriptionEndpointingPlan": {
"type": "object",
"properties": {
- "provider": {
- "type": "string",
- "description": "This is the voice provider that will be used.",
- "enum": [
- "lmnt"
- ]
- },
- "voiceId": {
- "description": "This is the provider-specific ID that will be used.",
- "oneOf": [
- {
- "type": "string",
- "enum": [
- "lily",
- "daniel"
- ],
- "title": "Preset Voice Options"
- },
- {
- "type": "string",
- "title": "LMNT Voice ID"
- }
- ]
+ "onPunctuationSeconds": {
+ "type": "number",
+ "description": "The minimum number of seconds to wait after transcription ending with punctuation before sending a request to the model. Defaults to 0.1.\n\nThis setting exists because the transcriber punctuates the transcription when it's more confident that customer has completed a thought.\n\n@default 0.1",
+ "minimum": 0,
+ "maximum": 3,
+ "example": 0.1
},
- "speed": {
+ "onNoPunctuationSeconds": {
"type": "number",
- "description": "This is the speed multiplier that will be used.",
- "minimum": 0.25,
- "maximum": 2,
- "example": null
+ "description": "The minimum number of seconds to wait after transcription ending without punctuation before sending a request to the model. Defaults to 1.5.\n\nThis setting exists to catch the cases where the transcriber was not confident enough to punctuate the transcription, but the customer is done and has been silent for a long time.\n\n@default 1.5",
+ "minimum": 0,
+ "maximum": 3,
+ "example": 1.5
},
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
- {
- "$ref": "#/components/schemas/ChunkPlan"
- }
- ]
+ "onNumberSeconds": {
+ "type": "number",
+ "description": "The minimum number of seconds to wait after transcription ending with a number before sending a request to the model. Defaults to 0.4.\n\nThis setting exists because the transcriber will sometimes punctuate the transcription ending with a number, even though the customer hasn't uttered the full number. This happens commonly for long numbers when the customer reads the number in chunks.\n\n@default 0.5",
+ "minimum": 0,
+ "maximum": 3,
+ "example": 0.5
}
- },
- "required": [
- "provider",
- "voiceId"
- ]
+ }
},
- "FallbackNeuphonicVoice": {
+ "StartSpeakingPlan": {
"type": "object",
"properties": {
- "provider": {
- "type": "string",
- "description": "This is the voice provider that will be used.",
- "enum": [
- "neuphonic"
- ]
+ "waitSeconds": {
+ "type": "number",
+ "description": "This is how long assistant waits before speaking. Defaults to 0.4.\n\nThis is the minimum it will wait but if there is latency is the pipeline, this minimum will be exceeded. This is intended as a stopgap in case the pipeline is moving too fast.\n\nExample:\n- If model generates tokens and voice generates bytes within 100ms, the pipeline still waits 300ms before outputting speech.\n\nUsage:\n- If the customer is taking long pauses, set this to a higher value.\n- If the assistant is accidentally jumping in too much, set this to a higher value.\n\n@default 0.4",
+ "minimum": 0,
+ "maximum": 5,
+ "example": 0.4
},
- "voiceId": {
- "description": "This is the provider-specific ID that will be used.",
+ "smartEndpointingEnabled": {
+ "example": false,
+ "deprecated": true,
"oneOf": [
{
- "type": "string",
- "enum": [],
- "title": "Preset Voice Options"
+ "type": "boolean"
},
{
"type": "string",
- "title": "Neuphonic Voice ID"
- }
- ]
- },
- "model": {
- "type": "string",
- "description": "This is the model that will be used. Defaults to 'neu_fast' if not specified.",
- "enum": [
- "neu_hq",
- "neu_fast"
- ],
- "example": "neu_fast"
- },
- "language": {
- "type": "object",
- "description": "This is the language (ISO 639-1) that is enforced for the model.",
- "example": "en"
- },
- "speed": {
- "type": "number",
- "description": "This is the speed multiplier that will be used.",
- "minimum": 0.25,
- "maximum": 2,
- "example": null
- },
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
- {
- "$ref": "#/components/schemas/ChunkPlan"
+ "enum": [
+ "livekit"
+ ]
}
]
- }
- },
- "required": [
- "provider",
- "voiceId",
- "language"
- ]
- },
- "FallbackOpenAIVoice": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "description": "This is the voice provider that will be used.",
- "enum": [
- "openai"
- ]
},
- "voiceId": {
- "description": "This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.",
+ "smartEndpointingPlan": {
+ "description": "This is the plan for smart endpointing. Pick between Vapi smart endpointing or LiveKit smart endpointing (or nothing). We strongly recommend using livekit endpointing when working in English. LiveKit endpointing is not supported in other languages, yet.\n\nIf this is set, it will override and take precedence over `transcriptionEndpointingPlan`.\nThis plan will still be overridden by any matching `customEndpointingRules`.",
"oneOf": [
{
- "type": "string",
- "enum": [
- "alloy",
- "echo",
- "fable",
- "onyx",
- "nova",
- "shimmer"
- ],
- "title": "Preset Voice Options"
+ "$ref": "#/components/schemas/VapiSmartEndpointingPlan",
+ "title": "Vapi"
},
{
- "type": "string",
- "title": "OpenAI Voice ID"
+ "$ref": "#/components/schemas/LivekitSmartEndpointingPlan",
+ "title": "Livekit"
}
]
},
- "model": {
- "type": "string",
- "description": "This is the model that will be used for text-to-speech.",
- "enum": [
- "tts-1",
- "tts-1-hd",
- "gpt-4o-mini-tts"
- ]
- },
- "instructions": {
- "type": "string",
- "description": "This is a prompt that allows you to control the voice of your generated audio.\nDoes not work with 'tts-1' or 'tts-1-hd' models.",
- "maxLength": 10000
- },
- "speed": {
- "type": "number",
- "description": "This is the speed multiplier that will be used.",
- "minimum": 0.25,
- "maximum": 4,
- "example": null
+ "customEndpointingRules": {
+ "type": "array",
+ "description": "These are the custom endpointing rules to set an endpointing timeout based on a regex on the customer's speech or the assistant's last message.\n\nUsage:\n- If you have yes/no questions like \"are you interested in a loan?\", you can set a shorter timeout.\n- If you have questions where the customer may pause to look up information like \"what's my account number?\", you can set a longer timeout.\n- If you want to wait longer while customer is enumerating a list of numbers, you can set a longer timeout.\n\nThese rules have the highest precedence and will override both `smartEndpointingPlan` and `transcriptionEndpointingPlan` when a rule is matched.\n\nThe rules are evaluated in order and the first one that matches will be used.\n\nOrder of precedence for endpointing:\n1. customEndpointingRules (if any match)\n2. smartEndpointingPlan (if set)\n3. transcriptionEndpointingPlan\n\n@default []",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AssistantCustomEndpointingRule",
+ "title": "Assistant"
+ },
+ {
+ "$ref": "#/components/schemas/CustomerCustomEndpointingRule",
+ "title": "Customer"
+ },
+ {
+ "$ref": "#/components/schemas/BothCustomEndpointingRule",
+ "title": "Both"
+ }
+ ]
+ }
},
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "transcriptionEndpointingPlan": {
+ "description": "This determines how a customer speech is considered done (endpointing) using the transcription of customer's speech.\n\nOnce an endpoint is triggered, the request is sent to `assistant.model`.\n\nNote: This plan is only used if `smartEndpointingPlan` is not set. If both are provided, `smartEndpointingPlan` takes precedence.\nThis plan will also be overridden by any matching `customEndpointingRules`.",
"allOf": [
{
- "$ref": "#/components/schemas/ChunkPlan"
+ "$ref": "#/components/schemas/TranscriptionEndpointingPlan"
}
]
}
- },
- "required": [
- "provider",
- "voiceId"
- ]
+ }
},
- "FallbackPlayHTVoice": {
+ "StopSpeakingPlan": {
"type": "object",
"properties": {
- "provider": {
- "type": "string",
- "description": "This is the voice provider that will be used.",
- "enum": [
- "playht"
- ]
- },
- "voiceId": {
- "description": "This is the provider-specific ID that will be used.",
- "oneOf": [
- {
- "type": "string",
- "enum": [
- "jennifer",
- "melissa",
- "will",
- "chris",
- "matt",
- "jack",
- "ruby",
- "davis",
- "donna",
- "michael"
- ],
- "title": "Preset Voice Options"
- },
- {
- "type": "string",
- "title": "PlayHT Voice ID"
- }
- ]
+ "numWords": {
+ "type": "number",
+ "description": "This is the number of words that the customer has to say before the assistant will stop talking.\n\nWords like \"stop\", \"actually\", \"no\", etc. will always interrupt immediately regardless of this value.\n\nWords like \"okay\", \"yeah\", \"right\" will never interrupt.\n\nWhen set to 0, `voiceSeconds` is used in addition to the transcriptions to determine the customer has started speaking.\n\nDefaults to 0.\n\n@default 0",
+ "minimum": 0,
+ "maximum": 10,
+ "example": 0
},
- "speed": {
+ "voiceSeconds": {
"type": "number",
- "description": "This is the speed multiplier that will be used.",
- "minimum": 0.1,
- "maximum": 5,
- "example": null
+ "description": "This is the seconds customer has to speak before the assistant stops talking. This uses the VAD (Voice Activity Detection) spike to determine if the customer has started speaking.\n\nConsiderations:\n- A lower value might be more responsive but could potentially pick up non-speech sounds.\n- A higher value reduces false positives but might slightly delay the detection of speech onset.\n\nThis is only used if `numWords` is set to 0.\n\nDefaults to 0.2\n\n@default 0.2",
+ "minimum": 0,
+ "maximum": 0.5,
+ "example": 0.2
},
- "temperature": {
+ "backoffSeconds": {
"type": "number",
- "description": "A floating point number between 0, exclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used. The temperature parameter controls variance. Lower temperatures result in more predictable results, higher temperatures allow each run to vary more, so the voice may sound less like the baseline voice.",
- "minimum": 0.1,
- "maximum": 2,
- "example": null
+ "description": "This is the seconds to wait before the assistant will start talking again after being interrupted.\n\nDefaults to 1.\n\n@default 1",
+ "minimum": 0,
+ "maximum": 10,
+ "example": 1
},
- "emotion": {
- "type": "string",
- "description": "An emotion to be applied to the speech.",
- "enum": [
- "female_happy",
- "female_sad",
- "female_angry",
- "female_fearful",
- "female_disgust",
- "female_surprised",
- "male_happy",
- "male_sad",
- "male_angry",
- "male_fearful",
- "male_disgust",
- "male_surprised"
+ "acknowledgementPhrases": {
+ "description": "These are the phrases that will never interrupt the assistant, even if numWords threshold is met.\nThese are typically acknowledgement or backchanneling phrases.",
+ "example": [
+ "i understand",
+ "i see",
+ "i got it",
+ "i hear you",
+ "im listening",
+ "im with you",
+ "right",
+ "okay",
+ "ok",
+ "sure",
+ "alright",
+ "got it",
+ "understood",
+ "yeah",
+ "yes",
+ "uh-huh",
+ "mm-hmm",
+ "gotcha",
+ "mhmm",
+ "ah",
+ "yeah okay",
+ "yeah sure"
],
- "example": null
+ "default": [
+ "i understand",
+ "i see",
+ "i got it",
+ "i hear you",
+ "im listening",
+ "im with you",
+ "right",
+ "okay",
+ "ok",
+ "sure",
+ "alright",
+ "got it",
+ "understood",
+ "yeah",
+ "yes",
+ "uh-huh",
+ "mm-hmm",
+ "gotcha",
+ "mhmm",
+ "ah",
+ "yeah okay",
+ "yeah sure"
+ ],
+ "type": "array",
+ "items": {
+ "type": "string",
+ "maxLength": 240
+ }
},
- "voiceGuidance": {
- "type": "number",
- "description": "A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.",
- "minimum": 1,
- "maximum": 6,
- "example": null
+ "interruptionPhrases": {
+ "description": "These are the phrases that will always interrupt the assistant immediately, regardless of numWords.\nThese are typically phrases indicating disagreement or desire to stop.",
+ "example": [
+ "stop",
+ "shut",
+ "up",
+ "enough",
+ "quiet",
+ "silence",
+ "but",
+ "dont",
+ "not",
+ "no",
+ "hold",
+ "wait",
+ "cut",
+ "pause",
+ "nope",
+ "nah",
+ "nevermind",
+ "never",
+ "bad",
+ "actually"
+ ],
+ "default": [
+ "stop",
+ "shut",
+ "up",
+ "enough",
+ "quiet",
+ "silence",
+ "but",
+ "dont",
+ "not",
+ "no",
+ "hold",
+ "wait",
+ "cut",
+ "pause",
+ "nope",
+ "nah",
+ "nevermind",
+ "never",
+ "bad",
+ "actually"
+ ],
+ "type": "array",
+ "items": {
+ "type": "string",
+ "maxLength": 240
+ }
+ }
+ }
+ },
+ "MonitorPlan": {
+ "type": "object",
+ "properties": {
+ "listenEnabled": {
+ "type": "boolean",
+ "description": "This determines whether the assistant's calls allow live listening. Defaults to true.\n\nFetch `call.monitor.listenUrl` to get the live listening URL.\n\n@default true",
+ "example": false
},
- "styleGuidance": {
+ "listenAuthenticationEnabled": {
+ "type": "boolean",
+ "description": "This enables authentication on the `call.monitor.listenUrl`.\n\nIf `listenAuthenticationEnabled` is `true`, the `call.monitor.listenUrl` will require an `Authorization: Bearer ` header.\n\n@default false",
+ "example": false
+ },
+ "controlEnabled": {
+ "type": "boolean",
+ "description": "This determines whether the assistant's calls allow live control. Defaults to true.\n\nFetch `call.monitor.controlUrl` to get the live control URL.\n\nTo use, send any control message via a POST request to `call.monitor.controlUrl`. Here are the types of controls supported: https://docs.vapi.ai/api-reference/messages/client-inbound-message\n\n@default true",
+ "example": false
+ },
+ "controlAuthenticationEnabled": {
+ "type": "boolean",
+ "description": "This enables authentication on the `call.monitor.controlUrl`.\n\nIf `controlAuthenticationEnabled` is `true`, the `call.monitor.controlUrl` will require an `Authorization: Bearer ` header.\n\n@default false",
+ "example": false
+ }
+ }
+ },
+ "SmartDenoisingPlan": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether smart denoising using Krisp is enabled.",
+ "default": false
+ }
+ }
+ },
+ "FourierDenoisingPlan": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether Fourier denoising is enabled. Note that this is experimental and may not work as expected.",
+ "default": false
+ },
+ "mediaDetectionEnabled": {
+ "type": "boolean",
+ "description": "Whether automatic media detection is enabled. When enabled, the filter will automatically\ndetect consistent background TV/music/radio and switch to more aggressive filtering settings.\nOnly applies when enabled is true.",
+ "example": true,
+ "default": true
+ },
+ "staticThreshold": {
"type": "number",
- "description": "A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.",
- "minimum": 1,
- "maximum": 30,
- "example": null
+ "description": "Static threshold in dB used as fallback when no baseline is established.",
+ "example": -35,
+ "minimum": -80,
+ "maximum": 0,
+ "default": -35
},
- "textGuidance": {
+ "baselineOffsetDb": {
"type": "number",
- "description": "A number between 1 and 2. This number influences how closely the generated speech adheres to the input text. Use lower values to create more fluid speech, but with a higher chance of deviating from the input text. Higher numbers will make the generated speech more accurate to the input text, ensuring that the words spoken align closely with the provided text.",
- "minimum": 1,
- "maximum": 2,
- "example": null
+ "description": "How far below the rolling baseline to filter audio, in dB.\nLower values (e.g., -10) are more aggressive, higher values (e.g., -20) are more conservative.",
+ "example": -15,
+ "minimum": -30,
+ "maximum": -5,
+ "default": -15
},
- "model": {
- "type": "string",
- "description": "Playht voice model/engine to use.",
- "enum": [
- "PlayHT2.0",
- "PlayHT2.0-turbo",
- "Play3.0-mini",
- "PlayDialog"
- ]
+ "windowSizeMs": {
+ "type": "number",
+ "description": "Rolling window size in milliseconds for calculating the audio baseline.\nLarger windows adapt more slowly but are more stable.",
+ "example": 3000,
+ "minimum": 1000,
+ "maximum": 30000,
+ "default": 3000
},
- "language": {
- "type": "string",
- "description": "The language to use for the speech.",
- "enum": [
- "afrikaans",
- "albanian",
- "amharic",
- "arabic",
- "bengali",
- "bulgarian",
- "catalan",
- "croatian",
- "czech",
- "danish",
- "dutch",
- "english",
- "french",
- "galician",
- "german",
- "greek",
- "hebrew",
- "hindi",
- "hungarian",
- "indonesian",
- "italian",
- "japanese",
- "korean",
- "malay",
- "mandarin",
- "polish",
- "portuguese",
- "russian",
- "serbian",
- "spanish",
- "swedish",
- "tagalog",
- "thai",
- "turkish",
- "ukrainian",
- "urdu",
- "xhosa"
+ "baselinePercentile": {
+ "type": "number",
+ "description": "Percentile to use for baseline calculation (1-99).\nHigher percentiles (e.g., 85) focus on louder speech, lower percentiles (e.g., 50) include quieter speech.",
+ "example": 85,
+ "minimum": 1,
+ "maximum": 99,
+ "default": 85
+ }
+ }
+ },
+ "BackgroundSpeechDenoisingPlan": {
+ "type": "object",
+ "properties": {
+ "smartDenoisingPlan": {
+ "description": "Whether smart denoising using Krisp is enabled.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SmartDenoisingPlan"
+ }
]
},
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "fourierDenoisingPlan": {
+ "description": "Whether Fourier denoising is enabled. Note that this is experimental and may not work as expected.\n\nThis can be combined with smart denoising, and will be run afterwards.",
"allOf": [
{
- "$ref": "#/components/schemas/ChunkPlan"
+ "$ref": "#/components/schemas/FourierDenoisingPlan"
}
]
}
- },
- "required": [
- "provider",
- "voiceId"
- ]
+ }
},
- "FallbackRimeAIVoice": {
+ "WorkflowUserEditable": {
"type": "object",
"properties": {
- "provider": {
- "type": "string",
- "description": "This is the voice provider that will be used.",
- "enum": [
- "rime-ai"
- ]
- },
- "voiceId": {
- "description": "This is the provider-specific ID that will be used.",
+ "nodes": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ConversationNode",
+ "title": "ConversationNode"
+ },
+ {
+ "$ref": "#/components/schemas/ToolNode",
+ "title": "ToolNode"
+ }
+ ]
+ }
+ },
+ "transcriber": {
+ "description": "This is the transcriber for the workflow.\n\nThis can be overridden at node level using `nodes[n].transcriber`.",
"oneOf": [
{
- "type": "string",
- "enum": [
- "abbie",
- "allison",
- "ally",
- "alona",
- "amber",
- "ana",
- "antoine",
- "armon",
- "brenda",
- "brittany",
- "carol",
- "colin",
- "courtney",
- "elena",
- "elliot",
- "eva",
- "geoff",
- "gerald",
- "hank",
- "helen",
- "hera",
- "jen",
- "joe",
- "joy",
- "juan",
- "kendra",
- "kendrick",
- "kenneth",
- "kevin",
- "kris",
- "linda",
- "madison",
- "marge",
- "marina",
- "marissa",
- "marta",
- "maya",
- "nicholas",
- "nyles",
- "phil",
- "reba",
- "rex",
- "rick",
- "ritu",
- "rob",
- "rodney",
- "rohan",
- "rosco",
- "samantha",
- "sandy",
- "selena",
- "seth",
- "sharon",
- "stan",
- "tamra",
- "tanya",
- "tibur",
- "tj",
- "tyler",
- "viv",
- "yadira",
- "marsh",
- "bayou",
- "creek",
- "brook",
- "flower",
- "spore",
- "glacier",
- "gulch",
- "alpine",
- "cove",
- "lagoon",
- "tundra",
- "steppe",
- "mesa",
- "grove",
- "rainforest",
- "moraine",
- "wildflower",
- "peak",
- "boulder",
- "gypsum",
- "zest"
- ],
- "title": "Preset Voice Options"
+ "$ref": "#/components/schemas/AssemblyAITranscriber",
+ "title": "AssemblyAITranscriber"
},
{
- "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",
- "mistv2"
- ],
- "example": "mistv2"
- },
- "speed": {
- "type": "number",
- "description": "This is the speed multiplier that will be used.",
- "minimum": 0.1,
- "example": null
- },
- "pauseBetweenBrackets": {
- "type": "boolean",
- "description": "This is a flag that controls whether to add slight pauses using angle brackets. Example: “Hi. <200> I’d love to have a conversation with you.” adds a 200ms pause between the first and second sentences.",
- "example": false
- },
- "phonemizeBetweenBrackets": {
- "type": "boolean",
- "description": "This is a flag that controls whether text inside brackets should be phonemized (converted to phonetic pronunciation) - Example: \"{h'El.o} World\" will pronounce \"Hello\" as expected.",
- "example": false
- },
- "reduceLatency": {
- "type": "boolean",
- "description": "This is a flag that controls whether to optimize for reduced latency in streaming. https://docs.rime.ai/api-reference/endpoint/websockets#param-reduce-latency",
- "example": false
- },
- "inlineSpeedAlpha": {
- "type": "string",
- "description": "This is a string that allows inline speed control using alpha notation. https://docs.rime.ai/api-reference/endpoint/websockets#param-inline-speed-alpha",
- "example": null
- },
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
+ "$ref": "#/components/schemas/AzureSpeechTranscriber",
+ "title": "AzureSpeechTranscriber"
+ },
{
- "$ref": "#/components/schemas/ChunkPlan"
- }
- ]
- }
- },
- "required": [
- "provider",
- "voiceId"
- ]
- },
- "FallbackSmallestAIVoice": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "description": "This is the voice provider that will be used.",
- "enum": [
- "smallest-ai"
- ]
- },
- "voiceId": {
- "description": "This is the provider-specific ID that will be used.",
- "oneOf": [
+ "$ref": "#/components/schemas/CustomTranscriber",
+ "title": "CustomTranscriber"
+ },
{
- "type": "string",
- "enum": [
- "emily",
- "jasmine",
- "arman",
- "james",
- "mithali",
- "aravind",
- "raj",
- "diya",
- "raman",
- "ananya",
- "isha",
- "william",
- "aarav",
- "monika",
- "niharika",
- "deepika",
- "raghav",
- "kajal",
- "radhika",
- "mansi",
- "nisha",
- "saurabh",
- "pooja",
- "saina",
- "sanya"
- ],
- "title": "Preset Voice Options"
+ "$ref": "#/components/schemas/DeepgramTranscriber",
+ "title": "DeepgramTranscriber"
},
{
- "type": "string",
- "title": "Smallest AI Voice ID"
- }
- ]
- },
- "model": {
- "type": "string",
- "description": "Smallest AI voice model to use. Defaults to 'lightning' when not specified.",
- "enum": [
- "lightning"
- ]
- },
- "speed": {
- "type": "number",
- "description": "This is the speed multiplier that will be used.",
- "example": null
- },
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
+ "$ref": "#/components/schemas/ElevenLabsTranscriber",
+ "title": "ElevenLabsTranscriber"
+ },
{
- "$ref": "#/components/schemas/ChunkPlan"
+ "$ref": "#/components/schemas/GladiaTranscriber",
+ "title": "GladiaTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleTranscriber",
+ "title": "GoogleTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/SpeechmaticsTranscriber",
+ "title": "SpeechmaticsTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/TalkscriberTranscriber",
+ "title": "TalkscriberTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAITranscriber",
+ "title": "OpenAITranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/CartesiaTranscriber",
+ "title": "CartesiaTranscriber"
}
]
- }
- },
- "required": [
- "provider",
- "voiceId"
- ]
- },
- "FallbackTavusVoice": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "description": "This is the voice provider that will be used.",
- "enum": [
- "tavus"
- ]
},
- "voiceId": {
- "description": "This is the provider-specific ID that will be used.",
+ "voice": {
+ "description": "This is the voice for the workflow.\n\nThis can be overridden at node level using `nodes[n].voice`.",
"oneOf": [
{
- "type": "string",
- "enum": [
- "r52da2535a"
- ],
- "title": "Preset Voice Options"
+ "$ref": "#/components/schemas/AzureVoice",
+ "title": "AzureVoice"
},
{
- "type": "string",
- "title": "Tavus Voice ID"
- }
- ]
- },
- "personaId": {
- "type": "string",
- "description": "This is the unique identifier for the persona that the replica will use in the conversation."
- },
- "callbackUrl": {
- "type": "string",
- "description": "This is the url that will receive webhooks with updates regarding the conversation state."
- },
- "conversationName": {
- "type": "string",
- "description": "This is the name for the conversation."
- },
- "conversationalContext": {
- "type": "string",
- "description": "This is the context that will be appended to any context provided in the persona, if one is provided."
- },
- "customGreeting": {
- "type": "string",
- "description": "This is the custom greeting that the replica will give once a participant joines the conversation."
- },
- "properties": {
- "description": "These are optional properties used to customize the conversation.",
- "allOf": [
+ "$ref": "#/components/schemas/CartesiaVoice",
+ "title": "CartesiaVoice"
+ },
{
- "$ref": "#/components/schemas/TavusConversationProperties"
+ "$ref": "#/components/schemas/CustomVoice",
+ "title": "CustomVoice"
+ },
+ {
+ "$ref": "#/components/schemas/DeepgramVoice",
+ "title": "DeepgramVoice"
+ },
+ {
+ "$ref": "#/components/schemas/ElevenLabsVoice",
+ "title": "ElevenLabsVoice"
+ },
+ {
+ "$ref": "#/components/schemas/HumeVoice",
+ "title": "HumeVoice"
+ },
+ {
+ "$ref": "#/components/schemas/LMNTVoice",
+ "title": "LMNTVoice"
+ },
+ {
+ "$ref": "#/components/schemas/NeuphonicVoice",
+ "title": "NeuphonicVoice"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAIVoice",
+ "title": "OpenAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/PlayHTVoice",
+ "title": "PlayHTVoice"
+ },
+ {
+ "$ref": "#/components/schemas/RimeAIVoice",
+ "title": "RimeAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/SmallestAIVoice",
+ "title": "SmallestAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/TavusVoice",
+ "title": "TavusVoice"
+ },
+ {
+ "$ref": "#/components/schemas/VapiVoice",
+ "title": "VapiVoice"
+ },
+ {
+ "$ref": "#/components/schemas/SesameVoice",
+ "title": "SesameVoice"
}
]
},
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
- "allOf": [
+ "observabilityPlan": {
+ "description": "This is the plan for observability of workflow's calls.\n\nCurrently, only Langfuse is supported.",
+ "oneOf": [
{
- "$ref": "#/components/schemas/ChunkPlan"
+ "$ref": "#/components/schemas/LangfuseObservabilityPlan",
+ "title": "Langfuse"
}
- ]
- }
- },
- "required": [
- "provider",
- "voiceId"
- ]
- },
- "FallbackVapiVoice": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "description": "This is the voice provider that will be used.",
- "enum": [
- "vapi"
- ]
- },
- "voiceId": {
- "type": "string",
- "description": "The voices provided by Vapi",
- "enum": [
- "Elliot",
- "Rohan",
- "Lily",
- "Savannah",
- "Hana",
- "Neha",
- "Cole",
- "Harry",
- "Paige",
- "Spencer"
- ]
- },
- "speed": {
- "type": "number",
- "description": "This is the speed multiplier that will be used.\n\n@default 1",
- "minimum": 0.25,
- "maximum": 2,
- "default": 1
- },
- "language": {
- "type": "string",
- "description": "This is the language code (ISO 639-1) that will be used.\n\n@default 'en-US'",
- "enum": [
- "en-US",
- "en-GB",
- "en-AU",
- "en-CA",
- "ja",
- "zh",
- "de",
- "hi",
- "fr-FR",
- "fr-CA",
- "ko",
- "pt-BR",
- "pt-PT",
- "it",
- "es-ES",
- "es-MX",
- "id",
- "nl",
- "tr",
- "fil",
- "pl",
- "sv",
- "bg",
- "ro",
- "ar-SA",
- "ar-AE",
- "cs",
- "el",
- "fi",
- "hr",
- "ms",
- "sk",
- "da",
- "ta",
- "uk",
- "ru",
- "hu",
- "no",
- "vi"
],
- "default": "en-US"
- },
- "chunkPlan": {
- "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
"allOf": [
{
- "$ref": "#/components/schemas/ChunkPlan"
+ "$ref": "#/components/schemas/LangfuseObservabilityPlan"
}
]
- }
- },
- "required": [
- "provider",
- "voiceId"
- ]
- },
- "TransportConfigurationTwilio": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "enum": [
- "twilio"
- ]
- },
- "timeout": {
- "type": "number",
- "description": "The integer number of seconds that we should allow the phone to ring before assuming there is no answer.\nThe default is `60` seconds and the maximum is `600` seconds.\nFor some call flows, we will add a 5-second buffer to the timeout value you provide.\nFor this reason, a timeout value of 10 seconds could result in an actual timeout closer to 15 seconds.\nYou can set this to a short time, such as `15` seconds, to hang up before reaching an answering machine or voicemail.\n\n@default 60",
- "minimum": 1,
- "maximum": 600,
- "example": 60
- },
- "record": {
- "type": "boolean",
- "description": "Whether to record the call.\nCan be `true` to record the phone call, or `false` to not.\nThe default is `false`.\n\n@default false",
- "example": false
- },
- "recordingChannels": {
- "type": "string",
- "description": "The number of channels in the final recording.\nCan be: `mono` or `dual`.\nThe default is `mono`.\n`mono` records both legs of the call in a single channel of the recording file.\n`dual` records each leg to a separate channel of the recording file.\nThe first channel of a dual-channel recording contains the parent call and the second channel contains the child call.\n\n@default 'mono'",
- "enum": [
- "mono",
- "dual"
- ],
- "example": "mono"
- }
- },
- "required": [
- "provider"
- ]
- },
- "CreateAnthropicCredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "enum": [
- "anthropic"
- ]
- },
- "apiKey": {
- "type": "string",
- "maxLength": 10000,
- "description": "This is not returned in the API."
- },
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "provider",
- "apiKey"
- ]
- },
- "CreateAnyscaleCredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "enum": [
- "anyscale"
- ]
- },
- "apiKey": {
- "type": "string",
- "maxLength": 10000,
- "description": "This is not returned in the API."
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "provider",
- "apiKey"
- ]
- },
- "CreateAssemblyAICredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "enum": [
- "assembly-ai"
- ]
- },
- "apiKey": {
- "type": "string",
- "description": "This is not returned in the API."
+ "credentials": {
+ "type": "array",
+ "description": "These are dynamic credentials that will be used for the workflow calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateAnthropicCredentialDTO",
+ "title": "AnthropicCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAnyscaleCredentialDTO",
+ "title": "AnyscaleCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAssemblyAICredentialDTO",
+ "title": "AssemblyAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAzureCredentialDTO",
+ "title": "AzureCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAzureOpenAICredentialDTO",
+ "title": "AzureOpenAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
+ "title": "ByoSipTrunkCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCartesiaCredentialDTO",
+ "title": "CartesiaCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCerebrasCredentialDTO",
+ "title": "CerebrasCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCloudflareCredentialDTO",
+ "title": "CloudflareCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCustomLLMCredentialDTO",
+ "title": "CustomLLMCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepgramCredentialDTO",
+ "title": "DeepgramCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepInfraCredentialDTO",
+ "title": "DeepInfraCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepSeekCredentialDTO",
+ "title": "DeepSeekCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateElevenLabsCredentialDTO",
+ "title": "ElevenLabsCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGcpCredentialDTO",
+ "title": "GcpCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGladiaCredentialDTO",
+ "title": "GladiaCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCredentialDTO",
+ "title": "GhlCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCredentialDTO",
+ "title": "GoogleCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGroqCredentialDTO",
+ "title": "GroqCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateHumeCredentialDTO",
+ "title": "HumeCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateInflectionAICredentialDTO",
+ "title": "InflectionAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateLangfuseCredentialDTO",
+ "title": "LangfuseCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateLmntCredentialDTO",
+ "title": "LmntCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMakeCredentialDTO",
+ "title": "MakeCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMistralCredentialDTO",
+ "title": "MistralCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateNeuphonicCredentialDTO",
+ "title": "NeuphonicCredential"
+ },
+ {
+ "$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/CreateS3CredentialDTO",
+ "title": "S3Credential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmallestAICredentialDTO",
+ "title": "SmallestAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
+ "title": "SpeechmaticsCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSupabaseCredentialDTO",
+ "title": "SupabaseCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTavusCredentialDTO",
+ "title": "TavusCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTogetherAICredentialDTO",
+ "title": "TogetherAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTrieveCredentialDTO",
+ "title": "TrieveCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioCredentialDTO",
+ "title": "TwilioCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonageCredentialDTO",
+ "title": "VonageCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateWebhookCredentialDTO",
+ "title": "WebhookCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateXAiCredentialDTO",
+ "title": "XAiCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
+ "title": "GoogleCalendarOAuth2ClientCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
+ "title": "GoogleCalendarOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
+ "title": "GoogleSheetsOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO",
+ "title": "SlackOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelMCPCredentialDTO",
+ "title": "GoHighLevelMCPCredential"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "provider",
+ "mapping": {
+ "11labs": "#/components/schemas/CreateElevenLabsCredentialDTO",
+ "anthropic": "#/components/schemas/CreateAnthropicCredentialDTO",
+ "anyscale": "#/components/schemas/CreateAnyscaleCredentialDTO",
+ "assembly-ai": "#/components/schemas/CreateAssemblyAICredentialDTO",
+ "azure-openai": "#/components/schemas/CreateAzureOpenAICredentialDTO",
+ "azure": "#/components/schemas/CreateAzureCredentialDTO",
+ "byo-sip-trunk": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
+ "cartesia": "#/components/schemas/CreateCartesiaCredentialDTO",
+ "cerebras": "#/components/schemas/CreateCerebrasCredentialDTO",
+ "cloudflare": "#/components/schemas/CreateCloudflareCredentialDTO",
+ "custom-llm": "#/components/schemas/CreateCustomLLMCredentialDTO",
+ "deepgram": "#/components/schemas/CreateDeepgramCredentialDTO",
+ "deepinfra": "#/components/schemas/CreateDeepInfraCredentialDTO",
+ "deep-seek": "#/components/schemas/CreateDeepSeekCredentialDTO",
+ "gcp": "#/components/schemas/CreateGcpCredentialDTO",
+ "gladia": "#/components/schemas/CreateGladiaCredentialDTO",
+ "gohighlevel": "#/components/schemas/CreateGoHighLevelCredentialDTO",
+ "google": "#/components/schemas/CreateGoogleCredentialDTO",
+ "groq": "#/components/schemas/CreateGroqCredentialDTO",
+ "inflection-ai": "#/components/schemas/CreateInflectionAICredentialDTO",
+ "langfuse": "#/components/schemas/CreateLangfuseCredentialDTO",
+ "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",
+ "s3": "#/components/schemas/CreateS3CredentialDTO",
+ "supabase": "#/components/schemas/CreateSupabaseCredentialDTO",
+ "smallest-ai": "#/components/schemas/CreateSmallestAICredentialDTO",
+ "tavus": "#/components/schemas/CreateTavusCredentialDTO",
+ "together-ai": "#/components/schemas/CreateTogetherAICredentialDTO",
+ "twilio": "#/components/schemas/CreateTwilioCredentialDTO",
+ "vonage": "#/components/schemas/CreateVonageCredentialDTO",
+ "webhook": "#/components/schemas/CreateWebhookCredentialDTO",
+ "xai": "#/components/schemas/CreateXAiCredentialDTO",
+ "neuphonic": "#/components/schemas/CreateNeuphonicCredentialDTO",
+ "hume": "#/components/schemas/CreateHumeCredentialDTO",
+ "mistral": "#/components/schemas/CreateMistralCredentialDTO",
+ "speechmatics": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
+ "trieve": "#/components/schemas/CreateTrieveCredentialDTO",
+ "google.calendar.oauth2-client": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
+ "google.calendar.oauth2-authorization": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
+ "google.sheets.oauth2-authorization": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
+ "slack.oauth2-authorization": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO",
+ "ghl.oauth2-authorization": "#/components/schemas/CreateGoHighLevelMCPCredentialDTO"
+ }
+ }
+ }
},
"name": {
"type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "provider",
- "apiKey"
- ]
- },
- "AzureBlobStorageBucketPlan": {
- "type": "object",
- "properties": {
- "connectionString": {
- "type": "string",
- "description": "This is the blob storage connection string for the Azure resource."
+ "maxLength": 80
},
- "containerName": {
- "type": "string",
- "description": "This is the container name for the Azure blob storage."
+ "edges": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Edge"
+ }
},
- "path": {
- "type": "string",
- "description": "This is the path where call artifacts will be stored.\n\nUsage:\n- To store call artifacts in a specific folder, set this to the full path. Eg. \"/folder-name1/folder-name2\".\n- To store call artifacts in the root of the bucket, leave this blank.\n\n@default \"/\""
- }
- },
- "required": [
- "connectionString",
- "containerName"
- ]
- },
- "CreateAzureCredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
+ "globalPrompt": {
"type": "string",
- "enum": [
- "azure"
+ "maxLength": 5000
+ },
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. tool.server\n2. workflow.server / assistant.server\n3. phoneNumber.server\n4. org.server",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
]
},
- "service": {
- "type": "string",
- "description": "This is the service being used in Azure.",
- "enum": [
- "speech",
- "blob_storage"
- ],
- "default": "speech"
+ "compliancePlan": {
+ "description": "This is the compliance plan for the workflow. It allows you to configure HIPAA and other compliance settings.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CompliancePlan"
+ }
+ ]
},
- "region": {
- "type": "string",
- "description": "This is the region of the Azure resource.",
- "enum": [
- "australia",
- "canadaeast",
- "canadacentral",
- "eastus2",
- "eastus",
- "france",
- "india",
- "japaneast",
- "japanwest",
- "uaenorth",
- "northcentralus",
- "norway",
- "southcentralus",
- "swedencentral",
- "switzerland",
- "uk",
- "westus",
- "westus3"
+ "analysisPlan": {
+ "description": "This is the plan for analysis of workflow's calls. Stored in `call.analysis`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AnalysisPlan"
+ }
]
},
- "apiKey": {
- "type": "string",
- "description": "This is not returned in the API.",
- "maxLength": 10000
+ "artifactPlan": {
+ "description": "This is the plan for artifacts generated during workflow's calls. Stored in `call.artifact`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ArtifactPlan"
+ }
+ ]
},
- "bucketPlan": {
- "description": "This is the bucket plan that can be provided to store call artifacts in Azure Blob Storage.",
+ "startSpeakingPlan": {
+ "description": "This is the plan for when the workflow nodes should start talking.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to start talking after the customer is done speaking.\n- The assistant is too fast to start talking after the customer is done speaking.\n- The assistant is so fast that it's actually interrupting the customer.",
"allOf": [
{
- "$ref": "#/components/schemas/AzureBlobStorageBucketPlan"
+ "$ref": "#/components/schemas/StartSpeakingPlan"
}
]
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "provider",
- "service"
- ]
- },
- "CreateAzureOpenAICredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "enum": [
- "azure-openai"
+ "stopSpeakingPlan": {
+ "description": "This is the plan for when workflow nodes should stop talking on customer interruption.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to recognize customer's interruption.\n- The assistant is too fast to recognize customer's interruption.\n- The assistant is getting interrupted by phrases that are just acknowledgments.\n- The assistant is getting interrupted by background noises.\n- The assistant is not properly stopping -- it starts talking right after getting interrupted.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/StopSpeakingPlan"
+ }
]
},
- "region": {
- "type": "string",
- "enum": [
- "australia",
- "canadaeast",
- "canadacentral",
- "eastus2",
- "eastus",
- "france",
- "india",
- "japaneast",
- "japanwest",
- "uaenorth",
- "northcentralus",
- "norway",
- "southcentralus",
- "swedencentral",
- "switzerland",
- "uk",
- "westus",
- "westus3"
+ "monitorPlan": {
+ "description": "This is the plan for real-time monitoring of the workflow's calls.\n\nUsage:\n- To enable live listening of the workflow's calls, set `monitorPlan.listenEnabled` to `true`.\n- To enable live control of the workflow's calls, set `monitorPlan.controlEnabled` to `true`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MonitorPlan"
+ }
]
},
- "models": {
+ "backgroundSpeechDenoisingPlan": {
+ "description": "This enables filtering of noise and background speech while the user is talking.\n\nFeatures:\n- Smart denoising using Krisp\n- Fourier denoising\n\nBoth can be used together. Order of precedence:\n- Smart denoising\n- Fourier denoising",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BackgroundSpeechDenoisingPlan"
+ }
+ ]
+ },
+ "credentialIds": {
+ "description": "These are the credentials that will be used for the workflow calls. By default, all the credentials are available for use in the call but you can provide a subset using this.",
"type": "array",
- "enum": [
- "gpt-4o-2024-11-20",
- "gpt-4o-2024-08-06",
- "gpt-4o-mini-2024-07-18",
- "gpt-4o-2024-05-13",
- "gpt-4-turbo-2024-04-09",
- "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"
- ],
"items": {
- "type": "string",
- "enum": [
- "gpt-4o-2024-11-20",
- "gpt-4o-2024-08-06",
- "gpt-4o-mini-2024-07-18",
- "gpt-4o-2024-05-13",
- "gpt-4-turbo-2024-04-09",
- "gpt-4-0125-preview",
- "gpt-4-1106-preview",
- "gpt-4-0613",
- "gpt-35-turbo-0125",
- "gpt-35-turbo-1106"
- ]
+ "type": "string"
}
- },
- "openAIKey": {
- "type": "string",
- "maxLength": 10000,
- "description": "This is not returned in the API."
- },
- "ocpApimSubscriptionKey": {
- "type": "string",
- "description": "This is not returned in the API."
- },
- "openAIEndpoint": {
- "type": "string",
- "maxLength": 10000
- },
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
}
},
"required": [
- "provider",
- "region",
- "models",
- "openAIKey",
- "openAIEndpoint"
+ "nodes",
+ "name",
+ "edges"
]
},
- "SipTrunkGateway": {
+ "VapiModel": {
"type": "object",
"properties": {
- "ip": {
- "type": "string",
- "description": "This is the address of the gateway. It can be an IPv4 address like 1.1.1.1 or a fully qualified domain name like my-sip-trunk.pstn.twilio.com."
- },
- "port": {
- "type": "number",
- "description": "This is the port number of the gateway. Default is 5060.\n\n@default 5060",
- "minimum": 1,
- "maximum": 65535
- },
- "netmask": {
- "type": "number",
- "description": "This is the netmask of the gateway. Defaults to 32.\n\n@default 32",
- "minimum": 24,
- "maximum": 32
- },
- "inboundEnabled": {
- "type": "boolean",
- "description": "This is whether inbound calls are allowed from this gateway. Default is true.\n\n@default true"
+ "messages": {
+ "description": "This is the starting state for the conversation.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OpenAIMessage"
+ }
},
- "outboundEnabled": {
- "type": "boolean",
- "description": "This is whether outbound calls should be sent to this gateway. Default is true.\n\nNote, if netmask is less than 32, it doesn't affect the outbound IPs that are tried. 1 attempt is made to `ip:port`.\n\n@default true"
- },
- "outboundProtocol": {
- "type": "string",
- "description": "This is the protocol to use for SIP signaling outbound calls. Default is udp.\n\n@default udp",
- "enum": [
- "tls/srtp",
- "tcp",
- "tls",
- "udp"
- ]
- },
- "optionsPingEnabled": {
- "type": "boolean",
- "description": "This is whether to send options ping to the gateway. This can be used to check if the gateway is reachable. Default is false.\n\nThis is useful for high availability setups where you want to check if the gateway is reachable before routing calls to it. Note, if no gateway for a trunk is reachable, outbound calls will be rejected.\n\n@default false"
- }
- },
- "required": [
- "ip"
- ]
- },
- "SipTrunkOutboundSipRegisterPlan": {
- "type": "object",
- "properties": {
- "domain": {
- "type": "string"
- },
- "username": {
- "type": "string"
- },
- "realm": {
- "type": "string"
- }
- }
- },
- "SipTrunkOutboundAuthenticationPlan": {
- "type": "object",
- "properties": {
- "authPassword": {
- "type": "string",
- "description": "This is not returned in the API."
- },
- "authUsername": {
- "type": "string"
- },
- "sipRegisterPlan": {
- "description": "This can be used to configure if SIP register is required by the SIP trunk. If not provided, no SIP registration will be attempted.",
- "allOf": [
- {
- "$ref": "#/components/schemas/SipTrunkOutboundSipRegisterPlan"
- }
- ]
- }
- }
- },
- "SbcConfiguration": {
- "type": "object",
- "properties": {}
- },
- "CreateByoSipTrunkCredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "description": "This can be used to bring your own SIP trunks or to connect to a Carrier.",
- "enum": [
- "byo-sip-trunk"
- ]
+ "tools": {
+ "type": "array",
+ "description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateApiRequestToolDTO",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateBashToolDTO",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateComputerToolDTO",
+ "title": "ComputerTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDtmfToolDTO",
+ "title": "DtmfTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateEndCallToolDTO",
+ "title": "EndCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateFunctionToolDTO",
+ "title": "FunctionTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
+ "title": "GoogleCalendarCreateEventTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
+ "title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateQueryToolDTO",
+ "title": "QueryTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
+ "title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmsToolDTO",
+ "title": "SmsTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTextEditorToolDTO",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTransferCallToolDTO",
+ "title": "TransferCallTool"
+ }
+ ]
+ }
},
- "gateways": {
- "description": "This is the list of SIP trunk's gateways.",
+ "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": {
- "$ref": "#/components/schemas/SipTrunkGateway"
+ "type": "string"
}
},
- "outboundAuthenticationPlan": {
- "description": "This can be used to configure the outbound authentication if required by the SIP trunk.",
- "allOf": [
+ "knowledgeBase": {
+ "description": "These are the options for the knowledge base.",
+ "oneOf": [
{
- "$ref": "#/components/schemas/SipTrunkOutboundAuthenticationPlan"
+ "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
+ "title": "Custom"
}
]
},
- "outboundLeadingPlusEnabled": {
- "type": "boolean",
- "description": "This ensures the outbound origination attempts have a leading plus. Defaults to false to match conventional telecom behavior.\n\nUsage:\n- Vonage/Twilio requires leading plus for all outbound calls. Set this to true.\n\n@default false"
+ "knowledgeBaseId": {
+ "type": "string",
+ "description": "This is the ID of the knowledge base the model will use."
},
- "techPrefix": {
+ "provider": {
"type": "string",
- "description": "This can be used to configure the tech prefix on outbound calls. This is an advanced property.",
- "maxLength": 10000
+ "enum": [
+ "vapi"
+ ]
},
- "sipDiversionHeader": {
+ "workflowId": {
"type": "string",
- "description": "This can be used to enable the SIP diversion header for authenticating the calling number if the SIP trunk supports it. This is an advanced property.",
- "maxLength": 10000
+ "description": "This is the workflow that will be used for the call. To use a transient workflow, use `workflow` instead."
},
- "sbcConfiguration": {
- "description": "This is an advanced configuration for enterprise deployments. This uses the onprem SBC to trunk into the SIP trunk's `gateways`, rather than the managed SBC provided by Vapi.",
+ "workflow": {
+ "description": "This is the workflow that will be used for the call. To use an existing workflow, use `workflowId` instead.",
"allOf": [
{
- "$ref": "#/components/schemas/SbcConfiguration"
+ "$ref": "#/components/schemas/WorkflowUserEditable"
}
]
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "gateways"
- ]
- },
- "CreateCartesiaCredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
+ "model": {
"type": "string",
- "enum": [
- "cartesia"
- ]
+ "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b"
},
- "apiKey": {
- "type": "string",
- "description": "This is not returned in the API."
+ "temperature": {
+ "type": "number",
+ "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.",
+ "minimum": 0,
+ "maximum": 2
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
+ "maxTokens": {
+ "type": "number",
+ "description": "This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.",
+ "minimum": 50,
+ "maximum": 10000
+ },
+ "emotionRecognitionEnabled": {
+ "type": "boolean",
+ "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.\n\n@default false"
+ },
+ "numFastTurns": {
+ "type": "number",
+ "description": "This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0",
+ "minimum": 0
}
},
"required": [
"provider",
- "apiKey"
+ "model"
]
},
- "CloudflareR2BucketPlan": {
+ "XaiModel": {
"type": "object",
"properties": {
- "accessKeyId": {
- "type": "string",
- "description": "Cloudflare R2 Access key ID."
+ "messages": {
+ "description": "This is the starting state for the conversation.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OpenAIMessage"
+ }
},
- "secretAccessKey": {
- "type": "string",
- "description": "Cloudflare R2 access key secret. This is not returned in the API."
+ "tools": {
+ "type": "array",
+ "description": "These are the tools that the assistant can use during the call. To use existing tools, use `toolIds`.\n\nBoth `tools` and `toolIds` can be used together.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateApiRequestToolDTO",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateBashToolDTO",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateComputerToolDTO",
+ "title": "ComputerTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDtmfToolDTO",
+ "title": "DtmfTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateEndCallToolDTO",
+ "title": "EndCallTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateFunctionToolDTO",
+ "title": "FunctionTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
+ "title": "GoogleCalendarCreateEventTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
+ "title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateQueryToolDTO",
+ "title": "QueryTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
+ "title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmsToolDTO",
+ "title": "SmsTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTextEditorToolDTO",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTransferCallToolDTO",
+ "title": "TransferCallTool"
+ }
+ ]
+ }
},
- "url": {
- "type": "string",
- "description": "Cloudflare R2 base url."
+ "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"
+ }
},
- "name": {
- "type": "string",
- "description": "This is the name of the bucket."
+ "knowledgeBase": {
+ "description": "These are the options for the knowledge base.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateCustomKnowledgeBaseDTO",
+ "title": "Custom"
+ }
+ ]
},
- "path": {
+ "knowledgeBaseId": {
"type": "string",
- "description": "This is the path where call artifacts will be stored.\n\nUsage:\n- To store call artifacts in a specific folder, set this to the full path. Eg. \"/folder-name1/folder-name2\".\n- To store call artifacts in the root of the bucket, leave this blank.\n\n@default \"/\""
- }
- },
- "required": [
- "name"
- ]
- },
- "CreateCloudflareCredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
+ "description": "This is the ID of the knowledge base the model will use."
+ },
+ "model": {
"type": "string",
+ "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b",
"enum": [
- "cloudflare"
- ],
- "description": "Credential provider. Only allowed value is cloudflare"
+ "grok-beta",
+ "grok-2",
+ "grok-3"
+ ]
},
- "accountId": {
+ "provider": {
"type": "string",
- "description": "Cloudflare Account Id."
+ "enum": [
+ "xai"
+ ]
},
- "apiKey": {
- "type": "string",
- "description": "Cloudflare API Key / Token."
+ "temperature": {
+ "type": "number",
+ "description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.",
+ "minimum": 0,
+ "maximum": 2
},
- "accountEmail": {
- "type": "string",
- "description": "Cloudflare Account Email."
+ "maxTokens": {
+ "type": "number",
+ "description": "This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.",
+ "minimum": 50,
+ "maximum": 10000
},
- "bucketPlan": {
- "description": "This is the bucket plan that can be provided to store call artifacts in R2",
- "allOf": [
- {
- "$ref": "#/components/schemas/CloudflareR2BucketPlan"
- }
- ]
+ "emotionRecognitionEnabled": {
+ "type": "boolean",
+ "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.\n\n@default false"
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
+ "numFastTurns": {
+ "type": "number",
+ "description": "This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai.\n\nDefault is 0.\n\n@default 0",
+ "minimum": 0
}
},
"required": [
+ "model",
"provider"
]
},
- "OAuth2AuthenticationPlan": {
+ "ExactReplacement": {
"type": "object",
"properties": {
"type": {
"type": "string",
+ "description": "This is the exact replacement type. You can use this to replace a specific word or phrase with a different word or phrase.\n\nUsage:\n- Replace \"hello\" with \"hi\": { type: 'exact', key: 'hello', value: 'hi' }\n- Replace \"good morning\" with \"good day\": { type: 'exact', key: 'good morning', value: 'good day' }\n- Replace a specific name: { type: 'exact', key: 'John Doe', value: 'Jane Smith' }\n- Replace an acronym: { type: 'exact', key: 'AI', value: 'Artificial Intelligence' }\n- Replace a company name with its phonetic pronunciation: { type: 'exact', key: 'Vapi', value: 'Vappy' }",
"enum": [
- "oauth2",
- "aws-sts"
+ "exact"
]
},
- "url": {
- "type": "string",
- "description": "This is the OAuth2 URL."
- },
- "clientId": {
- "type": "string",
- "description": "This is the OAuth2 client ID."
+ "replaceAllEnabled": {
+ "type": "boolean",
+ "description": "This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false",
+ "default": false
},
- "clientSecret": {
+ "key": {
"type": "string",
- "description": "This is the OAuth2 client secret."
+ "description": "This is the key to replace."
},
- "scope": {
+ "value": {
"type": "string",
- "description": "This is the scope of the OAuth2 token.",
+ "description": "This is the value that will replace the match.",
"maxLength": 1000
}
},
"required": [
"type",
- "url",
- "clientId",
- "clientSecret"
+ "key",
+ "value"
]
},
- "CreateCustomLLMCredentialDTO": {
+ "RegexReplacement": {
"type": "object",
"properties": {
- "provider": {
+ "type": {
"type": "string",
+ "description": "This is the regex replacement type. You can use this to replace a word or phrase that matches a pattern.\n\nUsage:\n- Replace all numbers with \"some number\": { type: 'regex', regex: '\\\\d+', value: 'some number' }\n- Replace email addresses with \"[EMAIL]\": { type: 'regex', regex: '\\\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Z|a-z]{2,}\\\\b', value: '[EMAIL]' }\n- Replace phone numbers with a formatted version: { type: 'regex', regex: '(\\\\d{3})(\\\\d{3})(\\\\d{4})', value: '($1) $2-$3' }\n- Replace all instances of \"color\" or \"colour\" with \"hue\": { type: 'regex', regex: 'colou?r', value: 'hue' }\n- Capitalize the first letter of every sentence: { type: 'regex', regex: '(?<=\\\\. |^)[a-z]', value: (match) => match.toUpperCase() }",
"enum": [
- "custom-llm"
+ "regex"
]
},
- "apiKey": {
+ "regex": {
"type": "string",
- "maxLength": 10000,
- "description": "This is not returned in the API."
+ "description": "This is the regex pattern to replace.\n\nNote:\n- This works by using the `string.replace` method in Node.JS. Eg. `\"hello there\".replace(/hello/g, \"hi\")` will return `\"hi there\"`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead."
},
- "authenticationPlan": {
- "description": "This is the authentication plan. Currently supports OAuth2 RFC 6749. To use Bearer authentication, use apiKey",
- "allOf": [
- {
- "$ref": "#/components/schemas/OAuth2AuthenticationPlan"
- }
- ]
+ "options": {
+ "description": "These are the options for the regex replacement. Defaults to all disabled.\n\n@default []",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RegexOption"
+ }
},
- "name": {
+ "value": {
"type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
+ "description": "This is the value that will replace the match.",
+ "maxLength": 1000
}
},
"required": [
- "provider",
- "apiKey"
+ "type",
+ "regex",
+ "value"
]
},
- "CreateDeepgramCredentialDTO": {
+ "FormatPlan": {
"type": "object",
"properties": {
- "provider": {
- "type": "string",
- "enum": [
- "deepgram"
- ]
+ "enabled": {
+ "type": "boolean",
+ "description": "This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.\n\nUsage:\n- To rely on the voice provider's formatting logic, set this to `false`.\n\nIf `voice.chunkPlan.enabled` is `false`, this is automatically `false` since there's no chunk to format.\n\n@default true",
+ "example": true
},
- "apiKey": {
- "type": "string",
- "description": "This is not returned in the API."
+ "numberToDigitsCutoff": {
+ "type": "number",
+ "description": "This is the cutoff after which a number is converted to individual digits instead of being spoken as words.\n\nExample:\n- If cutoff 2025, \"12345\" is converted to \"1 2 3 4 5\" while \"1200\" is converted to \"twelve hundred\".\n\nUsage:\n- If your use case doesn't involve IDs like zip codes, set this to a high value.\n- If your use case involves IDs that are shorter than 5 digits, set this to a lower value.\n\n@default 2025",
+ "minimum": 0,
+ "example": 2025
},
- "apiUrl": {
- "type": "string",
- "description": "This can be used to point to an onprem Deepgram instance. Defaults to api.deepgram.com."
+ "replacements": {
+ "type": "array",
+ "description": "These are the custom replacements you can make to the chunk before it is sent to the voice provider.\n\nUsage:\n- To replace a specific word or phrase with a different word or phrase, use the `ExactReplacement` type. Eg. `{ type: 'exact', key: 'hello', value: 'hi' }`\n- To replace a word or phrase that matches a pattern, use the `RegexReplacement` type. Eg. `{ type: 'regex', regex: '\\\\b[a-zA-Z]{5}\\\\b', value: 'hi' }`\n\n@default []",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ExactReplacement",
+ "title": "ExactReplacement"
+ },
+ {
+ "$ref": "#/components/schemas/RegexReplacement",
+ "title": "RegexReplacement"
+ }
+ ]
+ }
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "provider",
- "apiKey"
- ]
- },
- "CreateDeepInfraCredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
+ "formattersEnabled": {
+ "type": "array",
+ "description": "List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined",
"enum": [
- "deepinfra"
- ]
- },
- "apiKey": {
- "type": "string",
- "description": "This is not returned in the API."
- },
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
+ "markdown",
+ "asterisk",
+ "quote",
+ "dash",
+ "newline",
+ "colon",
+ "acronym",
+ "dollarAmount",
+ "email",
+ "date",
+ "time",
+ "distance",
+ "unit",
+ "percentage",
+ "phoneNumber",
+ "number",
+ "stripAsterisk"
+ ],
+ "items": {
+ "type": "string",
+ "enum": [
+ "markdown",
+ "asterisk",
+ "quote",
+ "dash",
+ "newline",
+ "colon",
+ "acronym",
+ "dollarAmount",
+ "email",
+ "date",
+ "time",
+ "distance",
+ "unit",
+ "percentage",
+ "phoneNumber",
+ "number",
+ "stripAsterisk"
+ ]
+ }
}
- },
- "required": [
- "provider",
- "apiKey"
- ]
+ }
},
- "CreateDeepSeekCredentialDTO": {
+ "ChunkPlan": {
"type": "object",
"properties": {
- "provider": {
- "type": "string",
- "enum": [
- "deep-seek"
- ]
+ "enabled": {
+ "type": "boolean",
+ "description": "This determines whether the model output is chunked before being sent to the voice provider. Default `true`.\n\nUsage:\n- To rely on the voice provider's audio generation logic, set this to `false`.\n- If seeing issues with quality, set this to `true`.\n\nIf disabled, Vapi-provided audio control tokens like will not work.\n\n@default true",
+ "example": true
},
- "apiKey": {
- "type": "string",
- "description": "This is not returned in the API."
+ "minCharacters": {
+ "type": "number",
+ "description": "This is the minimum number of characters in a chunk.\n\nUsage:\n- To increase quality, set this to a higher value.\n- To decrease latency, set this to a lower value.\n\n@default 30",
+ "minimum": 1,
+ "maximum": 80,
+ "example": 30
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
+ "punctuationBoundaries": {
+ "type": "array",
+ "description": "These are the punctuations that are considered valid boundaries for a chunk to be created.\n\nUsage:\n- To increase quality, constrain to fewer boundaries.\n- To decrease latency, enable all.\n\nDefault is automatically set to balance the trade-off between quality and latency based on the provider.",
+ "enum": [
+ "。",
+ "，",
+ ".",
+ "!",
+ "?",
+ ";",
+ ")",
+ "،",
+ "۔",
+ "।",
+ "॥",
+ "|",
+ "||",
+ ",",
+ ":"
+ ],
+ "example": [
+ "。",
+ "，",
+ ".",
+ "!",
+ "?",
+ ";",
+ "،",
+ "۔",
+ "।",
+ "॥",
+ "|",
+ "||",
+ ",",
+ ":"
+ ],
+ "items": {
+ "type": "string",
+ "enum": [
+ "。",
+ "，",
+ ".",
+ "!",
+ "?",
+ ";",
+ ")",
+ "،",
+ "۔",
+ "।",
+ "॥",
+ "|",
+ "||",
+ ",",
+ ":"
+ ]
+ }
+ },
+ "formatPlan": {
+ "description": "This is the plan for formatting the chunk before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FormatPlan"
+ }
+ ]
+ }
+ }
+ },
+ "FallbackPlan": {
+ "type": "object",
+ "properties": {
+ "voices": {
+ "type": "array",
+ "description": "This is the list of voices to fallback to in the event that the primary voice provider fails.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/FallbackAzureVoice",
+ "title": "Azure"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackCartesiaVoice",
+ "title": "Cartesia"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackHumeVoice",
+ "title": "Hume"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackCustomVoice",
+ "title": "CustomVoice"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackDeepgramVoice",
+ "title": "Deepgram"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackElevenLabsVoice",
+ "title": "ElevenLabs"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackVapiVoice",
+ "title": "Vapi"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackLMNTVoice",
+ "title": "LMNT"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackOpenAIVoice",
+ "title": "OpenAI"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackPlayHTVoice",
+ "title": "PlayHT"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackRimeAIVoice",
+ "title": "RimeAI"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackSmallestAIVoice",
+ "title": "Smallest AI"
+ },
+ {
+ "$ref": "#/components/schemas/FallbackTavusVoice",
+ "title": "TavusVoice"
+ }
+ ]
+ }
}
},
"required": [
- "provider",
- "apiKey"
+ "voices"
]
},
- "CreateElevenLabsCredentialDTO": {
+ "AzureVoice": {
"type": "object",
"properties": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
"provider": {
"type": "string",
+ "description": "This is the voice provider that will be used.",
"enum": [
- "11labs"
+ "azure"
]
},
- "apiKey": {
- "type": "string",
- "maxLength": 10000,
- "description": "This is not returned in the API."
+ "voiceId": {
+ "description": "This is the provider-specific ID that will be used.",
+ "oneOf": [
+ {
+ "type": "string",
+ "enum": [
+ "andrew",
+ "brian",
+ "emma"
+ ],
+ "title": "Preset Voice Options"
+ },
+ {
+ "type": "string",
+ "title": "Azure Voice ID"
+ }
+ ]
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
+ },
+ "speed": {
+ "type": "number",
+ "description": "This is the speed multiplier that will be used.",
+ "minimum": 0.5,
+ "maximum": 2
+ },
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackPlan"
+ }
+ ]
}
},
"required": [
"provider",
- "apiKey"
+ "voiceId"
]
},
- "GcpKey": {
+ "CartesiaExperimentalControls": {
"type": "object",
"properties": {
- "type": {
- "type": "string",
- "description": "This is the type of the key. Most likely, this is \"service_account\"."
- },
- "projectId": {
- "type": "string",
- "description": "This is the ID of the Google Cloud project associated with this key."
- },
- "privateKeyId": {
- "type": "string",
- "description": "This is the unique identifier for the private key."
- },
- "privateKey": {
- "type": "string",
- "description": "This is the private key in PEM format.\n\nNote: This is not returned in the API."
- },
- "clientEmail": {
- "type": "string",
- "description": "This is the email address associated with the service account."
- },
- "clientId": {
- "type": "string",
- "description": "This is the unique identifier for the client."
- },
- "authUri": {
- "type": "string",
- "description": "This is the URI for the auth provider's authorization endpoint."
- },
- "tokenUri": {
- "type": "string",
- "description": "This is the URI for the auth provider's token endpoint."
- },
- "authProviderX509CertUrl": {
- "type": "string",
- "description": "This is the URL of the public x509 certificate for the auth provider."
- },
- "clientX509CertUrl": {
- "type": "string",
- "description": "This is the URL of the public x509 certificate for the client."
+ "speed": {
+ "oneOf": [
+ {
+ "type": "string",
+ "enum": [
+ "slowest",
+ "slow",
+ "normal",
+ "fast",
+ "fastest"
+ ],
+ "example": "normal"
+ },
+ {
+ "type": "number",
+ "minimum": -1,
+ "maximum": 1,
+ "example": 0.5
+ }
+ ]
},
- "universeDomain": {
+ "emotion": {
"type": "string",
- "description": "This is the domain associated with the universe this service account belongs to."
+ "enum": [
+ "anger:lowest",
+ "anger:low",
+ "anger:high",
+ "anger:highest",
+ "positivity:lowest",
+ "positivity:low",
+ "positivity:high",
+ "positivity:highest",
+ "surprise:lowest",
+ "surprise:low",
+ "surprise:high",
+ "surprise:highest",
+ "sadness:lowest",
+ "sadness:low",
+ "sadness:high",
+ "sadness:highest",
+ "curiosity:lowest",
+ "curiosity:low",
+ "curiosity:high",
+ "curiosity:highest"
+ ],
+ "example": [
+ "happiness:high"
+ ]
}
- },
- "required": [
- "type",
- "projectId",
- "privateKeyId",
- "privateKey",
- "clientEmail",
- "clientId",
- "authUri",
- "tokenUri",
- "authProviderX509CertUrl",
- "clientX509CertUrl",
- "universeDomain"
- ]
+ }
},
- "BucketPlan": {
+ "CartesiaVoice": {
"type": "object",
"properties": {
- "name": {
- "type": "string",
- "description": "This is the name of the bucket."
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
},
- "region": {
+ "provider": {
"type": "string",
- "description": "This is the region of the bucket.\n\nUsage:\n- If `credential.type` is `aws`, then this is required.\n- If `credential.type` is `gcp`, then this is optional since GCP allows buckets to be accessed without a region but region is required for data residency requirements. Read here: https://cloud.google.com/storage/docs/request-endpoints"
+ "description": "This is the voice provider that will be used.",
+ "enum": [
+ "cartesia"
+ ]
},
- "path": {
+ "voiceId": {
"type": "string",
- "description": "This is the path where call artifacts will be stored.\n\nUsage:\n- To store call artifacts in a specific folder, set this to the full path. Eg. \"/folder-name1/folder-name2\".\n- To store call artifacts in the root of the bucket, leave this blank.\n\n@default \"/\""
+ "description": "The ID of the particular voice you want to use."
},
- "hmacAccessKey": {
+ "model": {
"type": "string",
- "description": "This is the HMAC access key offered by GCP for interoperability with S3 clients. Here is the guide on how to create: https://cloud.google.com/storage/docs/authentication/managing-hmackeys#console\n\nUsage:\n- If `credential.type` is `gcp`, then this is required.\n- If `credential.type` is `aws`, then this is not required since credential.awsAccessKeyId is used instead."
+ "description": "This is the model that will be used. This is optional and will default to the correct model for the voiceId.",
+ "enum": [
+ "sonic-2",
+ "sonic-english",
+ "sonic-multilingual",
+ "sonic-preview",
+ "sonic"
+ ],
+ "example": "sonic-english"
},
- "hmacSecret": {
- "type": "string",
- "description": "This is the secret for the HMAC access key. Here is the guide on how to create: https://cloud.google.com/storage/docs/authentication/managing-hmackeys#console\n\nUsage:\n- If `credential.type` is `gcp`, then this is required.\n- If `credential.type` is `aws`, then this is not required since credential.awsSecretAccessKey is used instead.\n\nNote: This is not returned in the API."
- }
- },
- "required": [
- "name"
- ]
- },
- "CreateGcpCredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
+ "language": {
"type": "string",
+ "description": "This is the language that will be used. This is optional and will default to the correct language for the voiceId.",
"enum": [
- "gcp"
- ]
+ "en",
+ "de",
+ "es",
+ "fr",
+ "ja",
+ "pt",
+ "zh",
+ "hi",
+ "it",
+ "ko",
+ "nl",
+ "pl",
+ "ru",
+ "sv",
+ "tr"
+ ],
+ "example": "en"
},
- "gcpKey": {
- "description": "This is the GCP key. This is the JSON that can be generated in the Google Cloud Console at https://console.cloud.google.com/iam-admin/serviceaccounts/details//keys.\n\nThe schema is identical to the JSON that GCP outputs.",
+ "experimentalControls": {
+ "description": "Experimental controls for Cartesia voice generation",
"allOf": [
{
- "$ref": "#/components/schemas/GcpKey"
+ "$ref": "#/components/schemas/CartesiaExperimentalControls"
}
]
},
- "bucketPlan": {
- "description": "This is the bucket plan that can be provided to store call artifacts in GCP.",
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
"allOf": [
{
- "$ref": "#/components/schemas/BucketPlan"
+ "$ref": "#/components/schemas/ChunkPlan"
}
]
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackPlan"
+ }
+ ]
}
},
"required": [
"provider",
- "gcpKey"
+ "voiceId"
]
},
- "CreateGladiaCredentialDTO": {
+ "CustomVoice": {
"type": "object",
"properties": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
"provider": {
"type": "string",
+ "description": "This is the voice provider that will be used. Use `custom-voice` for providers that are not natively supported.",
"enum": [
- "gladia"
+ "custom-voice"
]
},
- "apiKey": {
- "type": "string",
- "description": "This is not returned in the API."
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
+ "server": {
+ "description": "This is where the voice request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"message\": {\n \"type\": \"voice-request\",\n \"text\": \"Hello, world!\",\n \"sampleRate\": 24000,\n ...other metadata about the call...\n }\n}\n\nResponse Expected: 1-channel 16-bit raw PCM audio at the sample rate specified in the request. Here is how the response will be piped to the transport:\n```\nresponse.on('data', (chunk: Buffer) => {\n outputStream.write(chunk);\n});\n```",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
+ },
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackPlan"
+ }
+ ]
}
},
"required": [
"provider",
- "apiKey"
+ "server"
]
},
- "CreateGoHighLevelCredentialDTO": {
+ "DeepgramVoice": {
"type": "object",
"properties": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
"provider": {
"type": "string",
+ "description": "This is the voice provider that will be used.",
"enum": [
- "gohighlevel"
+ "deepgram"
]
},
- "apiKey": {
- "type": "string",
- "description": "This is not returned in the API."
- },
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "provider",
- "apiKey"
- ]
- },
- "CreateGroqCredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
+ "voiceId": {
"type": "string",
+ "description": "This is the provider-specific ID that will be used.",
"enum": [
- "groq"
- ]
- },
- "apiKey": {
- "type": "string",
- "description": "This is not returned in the API."
+ "asteria",
+ "luna",
+ "stella",
+ "athena",
+ "hera",
+ "orion",
+ "arcas",
+ "perseus",
+ "angus",
+ "orpheus",
+ "helios",
+ "zeus",
+ "thalia",
+ "andromeda",
+ "helena",
+ "apollo",
+ "arcas",
+ "aries",
+ "amalthea",
+ "asteria",
+ "athena",
+ "atlas",
+ "aurora",
+ "callista",
+ "cora",
+ "cordelia",
+ "delia",
+ "draco",
+ "electra",
+ "harmonia",
+ "hera",
+ "hermes",
+ "hyperion",
+ "iris",
+ "janus",
+ "juno",
+ "jupiter",
+ "luna",
+ "mars",
+ "minerva",
+ "neptune",
+ "odysseus",
+ "ophelia",
+ "orion",
+ "orpheus",
+ "pandora",
+ "phoebe",
+ "pluto",
+ "saturn",
+ "selene",
+ "theia",
+ "vesta",
+ "zeus"
+ ],
+ "title": "This is the Deepgram Voice ID"
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "provider",
- "apiKey"
- ]
- },
- "CreateLangfuseCredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
+ "model": {
"type": "string",
+ "description": "This is the model that will be used. Defaults to 'aura-2' when not specified.",
"enum": [
- "langfuse"
- ]
- },
- "publicKey": {
- "type": "string",
- "description": "The public key for Langfuse project. Eg: pk-lf-..."
- },
- "apiKey": {
- "type": "string",
- "description": "The secret key for Langfuse project. Eg: sk-lf-... .This is not returned in the API."
+ "aura",
+ "aura-2"
+ ],
+ "example": "aura-2"
},
- "apiUrl": {
- "type": "string",
- "description": "The host URL for Langfuse project. Eg: https://cloud.langfuse.com"
+ "mipOptOut": {
+ "type": "boolean",
+ "description": "If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false",
+ "example": false,
+ "default": false
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "provider",
- "publicKey",
- "apiKey",
- "apiUrl"
- ]
- },
- "CreateLmntCredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "enum": [
- "lmnt"
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
]
},
- "apiKey": {
- "type": "string",
- "description": "This is not returned in the API."
- },
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackPlan"
+ }
+ ]
}
},
"required": [
"provider",
- "apiKey"
+ "voiceId"
]
},
- "CreateMakeCredentialDTO": {
+ "ElevenLabsVoice": {
"type": "object",
"properties": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
"provider": {
"type": "string",
+ "description": "This is the voice provider that will be used.",
"enum": [
- "make"
+ "11labs"
]
},
- "teamId": {
- "type": "string",
- "description": "Team ID"
- },
- "region": {
- "type": "string",
- "description": "Region of your application. For example: eu1, eu2, us1, us2"
- },
- "apiKey": {
- "type": "string",
- "description": "This is not returned in the API."
- },
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "provider",
- "teamId",
- "region",
- "apiKey"
- ]
- },
- "CreateOpenAICredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "enum": [
- "openai"
+ "voiceId": {
+ "description": "This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.",
+ "oneOf": [
+ {
+ "type": "string",
+ "enum": [
+ "burt",
+ "marissa",
+ "andrea",
+ "sarah",
+ "phillip",
+ "steve",
+ "joseph",
+ "myra",
+ "paula",
+ "ryan",
+ "drew",
+ "paul",
+ "mrb",
+ "matilda",
+ "mark"
+ ],
+ "title": "Preset Voice Options"
+ },
+ {
+ "type": "string",
+ "title": "11Labs Voice ID"
+ }
]
},
- "apiKey": {
- "type": "string",
- "description": "This is not returned in the API."
+ "stability": {
+ "type": "number",
+ "description": "Defines the stability for voice settings.",
+ "minimum": 0,
+ "maximum": 1,
+ "example": 0.5
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "provider",
- "apiKey"
- ]
- },
- "CreateOpenRouterCredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "enum": [
- "openrouter"
- ]
+ "similarityBoost": {
+ "type": "number",
+ "description": "Defines the similarity boost for voice settings.",
+ "minimum": 0,
+ "maximum": 1,
+ "example": 0.75
},
- "apiKey": {
- "type": "string",
- "description": "This is not returned in the API."
+ "style": {
+ "type": "number",
+ "description": "Defines the style for voice settings.",
+ "minimum": 0,
+ "maximum": 1,
+ "example": 0
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "provider",
- "apiKey"
- ]
- },
- "CreatePerplexityAICredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "enum": [
- "perplexity-ai"
- ]
+ "useSpeakerBoost": {
+ "type": "boolean",
+ "description": "Defines the use speaker boost for voice settings.",
+ "example": false
},
- "apiKey": {
- "type": "string",
- "description": "This is not returned in the API."
+ "speed": {
+ "type": "number",
+ "description": "Defines the speed for voice settings.",
+ "minimum": 0.7,
+ "maximum": 1.2,
+ "example": 0.9
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "provider",
- "apiKey"
- ]
- },
- "CreatePlayHTCredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "enum": [
- "playht"
- ]
+ "optimizeStreamingLatency": {
+ "type": "number",
+ "description": "Defines the optimize streaming latency for voice settings. Defaults to 3.",
+ "minimum": 0,
+ "maximum": 4,
+ "example": 3
},
- "apiKey": {
- "type": "string",
- "description": "This is not returned in the API."
+ "enableSsmlParsing": {
+ "type": "boolean",
+ "description": "This enables the use of https://elevenlabs.io/docs/speech-synthesis/prompting#pronunciation. Defaults to false to save latency.\n\n@default false",
+ "example": false
},
- "userId": {
- "type": "string"
+ "autoMode": {
+ "type": "boolean",
+ "description": "Defines the auto mode for voice settings. Defaults to false.",
+ "example": false
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "provider",
- "apiKey",
- "userId"
- ]
- },
- "CreateRimeAICredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
+ "model": {
"type": "string",
+ "description": "This is the model that will be used. Defaults to 'eleven_turbo_v2' if not specified.",
"enum": [
- "rime-ai"
+ "eleven_multilingual_v2",
+ "eleven_turbo_v2",
+ "eleven_turbo_v2_5",
+ "eleven_flash_v2",
+ "eleven_flash_v2_5",
+ "eleven_monolingual_v1"
+ ],
+ "example": "eleven_turbo_v2_5"
+ },
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
]
},
- "apiKey": {
+ "language": {
"type": "string",
- "description": "This is not returned in the API."
+ "description": "This is the language (ISO 639-1) that is enforced for the model. Currently only Turbo v2.5 supports language enforcement. For other models, an error will be returned if language code is provided."
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackPlan"
+ }
+ ]
}
},
"required": [
"provider",
- "apiKey"
+ "voiceId"
]
},
- "CreateRunpodCredentialDTO": {
+ "HumeVoice": {
"type": "object",
"properties": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
"provider": {
"type": "string",
+ "description": "This is the voice provider that will be used.",
"enum": [
- "runpod"
+ "hume"
]
},
- "apiKey": {
- "type": "string",
- "description": "This is not returned in the API."
- },
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "provider",
- "apiKey"
- ]
- },
- "CreateS3CredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
+ "model": {
"type": "string",
+ "description": "This is the model that will be used.",
"enum": [
- "s3"
+ "octave"
],
- "description": "Credential provider. Only allowed value is s3"
- },
- "awsAccessKeyId": {
- "type": "string",
- "description": "AWS access key ID."
+ "example": "octave"
},
- "awsSecretAccessKey": {
+ "voiceId": {
"type": "string",
- "description": "AWS access key secret. This is not returned in the API."
+ "description": "The ID of the particular voice you want to use."
},
- "region": {
- "type": "string",
- "description": "AWS region in which the S3 bucket is located."
+ "isCustomHumeVoice": {
+ "type": "boolean",
+ "description": "Indicates whether the chosen voice is a preset Hume AI voice or a custom voice.",
+ "example": false
},
- "s3BucketName": {
- "type": "string",
- "description": "AWS S3 bucket name."
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
},
- "s3PathPrefix": {
+ "description": {
"type": "string",
- "description": "The path prefix for the uploaded recording. Ex. \"recordings/\""
+ "description": "Natural language instructions describing how the synthesized speech should sound, including but not limited to tone, intonation, pacing, and accent (e.g., 'a soft, gentle voice with a strong British accent').\n\nIf a Voice is specified in the request, this description serves as acting instructions.\nIf no Voice is specified, a new voice is generated based on this description."
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackPlan"
+ }
+ ]
}
},
"required": [
"provider",
- "awsAccessKeyId",
- "awsSecretAccessKey",
- "region",
- "s3BucketName",
- "s3PathPrefix"
+ "voiceId"
]
},
- "SupabaseBucketPlan": {
+ "LMNTVoice": {
"type": "object",
"properties": {
- "region": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
+ "provider": {
"type": "string",
- "description": "This is the S3 Region. It should look like us-east-1\nIt should be one of the supabase regions defined in the SUPABASE_REGION enum\nCheck https://supabase.com/docs/guides/platform/regions for up to date regions",
+ "description": "This is the voice provider that will be used.",
"enum": [
- "us-west-1",
- "us-east-1",
- "us-east-2",
- "ca-central-1",
- "eu-west-1",
- "eu-west-2",
- "eu-west-3",
- "eu-central-1",
- "eu-central-2",
- "eu-north-1",
- "ap-south-1",
- "ap-southeast-1",
- "ap-northeast-1",
- "ap-northeast-2",
- "ap-southeast-2",
- "sa-east-1"
+ "lmnt"
]
},
- "url": {
- "type": "string",
- "description": "This is the S3 compatible URL for Supabase S3\nThis should look like https://.supabase.co/storage/v1/s3"
- },
- "accessKeyId": {
- "type": "string",
- "description": "This is the Supabase S3 Access Key ID.\nThe user creates this in the Supabase project Storage settings"
- },
- "secretAccessKey": {
- "type": "string",
- "description": "This is the Supabase S3 Secret Access Key.\nThe user creates this in the Supabase project Storage settings along with the access key id"
+ "voiceId": {
+ "description": "This is the provider-specific ID that will be used.",
+ "oneOf": [
+ {
+ "type": "string",
+ "enum": [
+ "amy",
+ "ansel",
+ "autumn",
+ "ava",
+ "brandon",
+ "caleb",
+ "cassian",
+ "chloe",
+ "dalton",
+ "daniel",
+ "dustin",
+ "elowen",
+ "evander",
+ "huxley",
+ "james",
+ "juniper",
+ "kennedy",
+ "lauren",
+ "leah",
+ "lily",
+ "lucas",
+ "magnus",
+ "miles",
+ "morgan",
+ "natalie",
+ "nathan",
+ "noah",
+ "nyssa",
+ "oliver",
+ "paige",
+ "ryan",
+ "sadie",
+ "sophie",
+ "stella",
+ "terrence",
+ "tyler",
+ "vesper",
+ "violet",
+ "warrick",
+ "zain",
+ "zeke",
+ "zoe"
+ ],
+ "title": "Preset Voice Options"
+ },
+ {
+ "type": "string",
+ "title": "LMNT Voice ID"
+ }
+ ]
},
- "name": {
- "type": "string",
- "description": "This is the Supabase S3 Bucket Name.\nThe user must create this in Supabase under Storage > Buckets\nA bucket that does not exist will not be checked now, but file uploads will fail"
+ "speed": {
+ "type": "number",
+ "description": "This is the speed multiplier that will be used.",
+ "minimum": 0.25,
+ "maximum": 2,
+ "example": null
},
- "path": {
- "type": "string",
- "description": "This is the Supabase S3 Bucket Folder Path.\nThe user can create this in Supabase under Storage > Buckets\nA path that does not exist will not be checked now, but file uploads will fail\nA Path is like a folder in the bucket\nEg. If the bucket is called \"my-bucket\" and the path is \"my-folder\", the full path is \"my-bucket/my-folder\""
- }
- },
- "required": [
- "region",
- "url",
- "accessKeyId",
- "secretAccessKey",
- "name"
- ]
- },
- "CreateSupabaseCredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
+ "language": {
+ "description": "Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.",
"enum": [
- "supabase"
+ "aa",
+ "ab",
+ "ae",
+ "af",
+ "ak",
+ "am",
+ "an",
+ "ar",
+ "as",
+ "av",
+ "ay",
+ "az",
+ "ba",
+ "be",
+ "bg",
+ "bh",
+ "bi",
+ "bm",
+ "bn",
+ "bo",
+ "br",
+ "bs",
+ "ca",
+ "ce",
+ "ch",
+ "co",
+ "cr",
+ "cs",
+ "cu",
+ "cv",
+ "cy",
+ "da",
+ "de",
+ "dv",
+ "dz",
+ "ee",
+ "el",
+ "en",
+ "eo",
+ "es",
+ "et",
+ "eu",
+ "fa",
+ "ff",
+ "fi",
+ "fj",
+ "fo",
+ "fr",
+ "fy",
+ "ga",
+ "gd",
+ "gl",
+ "gn",
+ "gu",
+ "gv",
+ "ha",
+ "he",
+ "hi",
+ "ho",
+ "hr",
+ "ht",
+ "hu",
+ "hy",
+ "hz",
+ "ia",
+ "id",
+ "ie",
+ "ig",
+ "ii",
+ "ik",
+ "io",
+ "is",
+ "it",
+ "iu",
+ "ja",
+ "jv",
+ "ka",
+ "kg",
+ "ki",
+ "kj",
+ "kk",
+ "kl",
+ "km",
+ "kn",
+ "ko",
+ "kr",
+ "ks",
+ "ku",
+ "kv",
+ "kw",
+ "ky",
+ "la",
+ "lb",
+ "lg",
+ "li",
+ "ln",
+ "lo",
+ "lt",
+ "lu",
+ "lv",
+ "mg",
+ "mh",
+ "mi",
+ "mk",
+ "ml",
+ "mn",
+ "mr",
+ "ms",
+ "mt",
+ "my",
+ "na",
+ "nb",
+ "nd",
+ "ne",
+ "ng",
+ "nl",
+ "nn",
+ "no",
+ "nr",
+ "nv",
+ "ny",
+ "oc",
+ "oj",
+ "om",
+ "or",
+ "os",
+ "pa",
+ "pi",
+ "pl",
+ "ps",
+ "pt",
+ "qu",
+ "rm",
+ "rn",
+ "ro",
+ "ru",
+ "rw",
+ "sa",
+ "sc",
+ "sd",
+ "se",
+ "sg",
+ "si",
+ "sk",
+ "sl",
+ "sm",
+ "sn",
+ "so",
+ "sq",
+ "sr",
+ "ss",
+ "st",
+ "su",
+ "sv",
+ "sw",
+ "ta",
+ "te",
+ "tg",
+ "th",
+ "ti",
+ "tk",
+ "tl",
+ "tn",
+ "to",
+ "tr",
+ "ts",
+ "tt",
+ "tw",
+ "ty",
+ "ug",
+ "uk",
+ "ur",
+ "uz",
+ "ve",
+ "vi",
+ "vo",
+ "wa",
+ "wo",
+ "xh",
+ "yi",
+ "yue",
+ "yo",
+ "za",
+ "zh",
+ "zu",
+ "auto"
],
- "description": "This is for supabase storage."
- },
- "bucketPlan": {
- "$ref": "#/components/schemas/SupabaseBucketPlan"
- },
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "provider"
- ]
- },
- "CreateSmallestAICredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "enum": [
- "smallest-ai"
+ "example": "en",
+ "oneOf": [
+ {
+ "type": "string",
+ "enum": [
+ "aa",
+ "ab",
+ "ae",
+ "af",
+ "ak",
+ "am",
+ "an",
+ "ar",
+ "as",
+ "av",
+ "ay",
+ "az",
+ "ba",
+ "be",
+ "bg",
+ "bh",
+ "bi",
+ "bm",
+ "bn",
+ "bo",
+ "br",
+ "bs",
+ "ca",
+ "ce",
+ "ch",
+ "co",
+ "cr",
+ "cs",
+ "cu",
+ "cv",
+ "cy",
+ "da",
+ "de",
+ "dv",
+ "dz",
+ "ee",
+ "el",
+ "en",
+ "eo",
+ "es",
+ "et",
+ "eu",
+ "fa",
+ "ff",
+ "fi",
+ "fj",
+ "fo",
+ "fr",
+ "fy",
+ "ga",
+ "gd",
+ "gl",
+ "gn",
+ "gu",
+ "gv",
+ "ha",
+ "he",
+ "hi",
+ "ho",
+ "hr",
+ "ht",
+ "hu",
+ "hy",
+ "hz",
+ "ia",
+ "id",
+ "ie",
+ "ig",
+ "ii",
+ "ik",
+ "io",
+ "is",
+ "it",
+ "iu",
+ "ja",
+ "jv",
+ "ka",
+ "kg",
+ "ki",
+ "kj",
+ "kk",
+ "kl",
+ "km",
+ "kn",
+ "ko",
+ "kr",
+ "ks",
+ "ku",
+ "kv",
+ "kw",
+ "ky",
+ "la",
+ "lb",
+ "lg",
+ "li",
+ "ln",
+ "lo",
+ "lt",
+ "lu",
+ "lv",
+ "mg",
+ "mh",
+ "mi",
+ "mk",
+ "ml",
+ "mn",
+ "mr",
+ "ms",
+ "mt",
+ "my",
+ "na",
+ "nb",
+ "nd",
+ "ne",
+ "ng",
+ "nl",
+ "nn",
+ "no",
+ "nr",
+ "nv",
+ "ny",
+ "oc",
+ "oj",
+ "om",
+ "or",
+ "os",
+ "pa",
+ "pi",
+ "pl",
+ "ps",
+ "pt",
+ "qu",
+ "rm",
+ "rn",
+ "ro",
+ "ru",
+ "rw",
+ "sa",
+ "sc",
+ "sd",
+ "se",
+ "sg",
+ "si",
+ "sk",
+ "sl",
+ "sm",
+ "sn",
+ "so",
+ "sq",
+ "sr",
+ "ss",
+ "st",
+ "su",
+ "sv",
+ "sw",
+ "ta",
+ "te",
+ "tg",
+ "th",
+ "ti",
+ "tk",
+ "tl",
+ "tn",
+ "to",
+ "tr",
+ "ts",
+ "tt",
+ "tw",
+ "ty",
+ "ug",
+ "uk",
+ "ur",
+ "uz",
+ "ve",
+ "vi",
+ "vo",
+ "wa",
+ "wo",
+ "xh",
+ "yi",
+ "yue",
+ "yo",
+ "za",
+ "zh",
+ "zu"
+ ],
+ "title": "ISO 639-1 Language Code"
+ },
+ {
+ "type": "string",
+ "enum": [
+ "auto"
+ ],
+ "title": "Auto-detect"
+ }
]
},
- "apiKey": {
- "type": "string",
- "description": "This is not returned in the API."
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackPlan"
+ }
+ ]
}
},
"required": [
"provider",
- "apiKey"
+ "voiceId"
]
},
- "CreateTavusCredentialDTO": {
+ "NeuphonicVoice": {
"type": "object",
"properties": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
"provider": {
"type": "string",
+ "description": "This is the voice provider that will be used.",
"enum": [
- "tavus"
+ "neuphonic"
]
},
- "apiKey": {
- "type": "string",
- "description": "This is not returned in the API."
+ "voiceId": {
+ "description": "This is the provider-specific ID that will be used.",
+ "oneOf": [
+ {
+ "type": "string",
+ "enum": [],
+ "title": "Preset Voice Options"
+ },
+ {
+ "type": "string",
+ "title": "Neuphonic Voice ID"
+ }
+ ]
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "provider",
- "apiKey"
- ]
- },
- "CreateTogetherAICredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
+ "model": {
"type": "string",
+ "description": "This is the model that will be used. Defaults to 'neu_fast' if not specified.",
"enum": [
- "together-ai"
- ]
+ "neu_hq",
+ "neu_fast"
+ ],
+ "example": "neu_fast"
},
- "apiKey": {
- "type": "string",
- "description": "This is not returned in the API."
+ "language": {
+ "type": "object",
+ "description": "This is the language (ISO 639-1) that is enforced for the model.",
+ "example": "en"
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
+ "speed": {
+ "type": "number",
+ "description": "This is the speed multiplier that will be used.",
+ "minimum": 0.25,
+ "maximum": 2,
+ "example": null
+ },
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
+ },
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackPlan"
+ }
+ ]
}
},
"required": [
"provider",
- "apiKey"
+ "voiceId",
+ "language"
]
},
- "CreateTwilioCredentialDTO": {
+ "OpenAIVoice": {
"type": "object",
"properties": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
"provider": {
"type": "string",
+ "description": "This is the voice provider that will be used.",
"enum": [
- "twilio"
+ "openai"
]
},
- "authToken": {
- "type": "string",
- "description": "This is not returned in the API."
- },
- "accountSid": {
- "type": "string"
+ "voiceId": {
+ "description": "This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.",
+ "oneOf": [
+ {
+ "type": "string",
+ "enum": [
+ "alloy",
+ "echo",
+ "fable",
+ "onyx",
+ "nova",
+ "shimmer"
+ ],
+ "title": "Preset Voice Options"
+ },
+ {
+ "type": "string",
+ "title": "OpenAI Voice ID"
+ }
+ ]
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "provider",
- "authToken",
- "accountSid"
- ]
- },
- "CreateVonageCredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
+ "model": {
"type": "string",
+ "description": "This is the model that will be used for text-to-speech.",
"enum": [
- "vonage"
+ "tts-1",
+ "tts-1-hd",
+ "gpt-4o-mini-tts"
]
},
- "apiSecret": {
+ "instructions": {
"type": "string",
- "description": "This is not returned in the API."
+ "description": "This is a prompt that allows you to control the voice of your generated audio.\nDoes not work with 'tts-1' or 'tts-1-hd' models.",
+ "maxLength": 10000
},
- "apiKey": {
- "type": "string"
+ "speed": {
+ "type": "number",
+ "description": "This is the speed multiplier that will be used.",
+ "minimum": 0.25,
+ "maximum": 4,
+ "example": null
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "provider",
- "apiSecret",
- "apiKey"
- ]
- },
- "CreateWebhookCredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "enum": [
- "webhook"
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
]
},
- "authenticationPlan": {
- "description": "This is the authentication plan. Currently supports OAuth2 RFC 6749.",
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
"allOf": [
{
- "$ref": "#/components/schemas/OAuth2AuthenticationPlan"
+ "$ref": "#/components/schemas/FallbackPlan"
}
]
- },
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
}
},
"required": [
"provider",
- "authenticationPlan"
+ "voiceId"
]
},
- "CreateXAiCredentialDTO": {
+ "PlayHTVoice": {
"type": "object",
"properties": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
"provider": {
"type": "string",
- "description": "This is the api key for Grok in XAi's console. Get it from here: https://console.x.ai",
+ "description": "This is the voice provider that will be used.",
"enum": [
- "xai"
+ "playht"
]
},
- "apiKey": {
- "type": "string",
- "maxLength": 10000,
- "description": "This is not returned in the API."
- },
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "provider",
- "apiKey"
- ]
- },
- "CreateGoogleCalendarOAuth2ClientCredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "enum": [
- "google.calendar.oauth2-client"
+ "voiceId": {
+ "description": "This is the provider-specific ID that will be used.",
+ "oneOf": [
+ {
+ "type": "string",
+ "enum": [
+ "jennifer",
+ "melissa",
+ "will",
+ "chris",
+ "matt",
+ "jack",
+ "ruby",
+ "davis",
+ "donna",
+ "michael"
+ ],
+ "title": "Preset Voice Options"
+ },
+ {
+ "type": "string",
+ "title": "PlayHT Voice ID"
+ }
]
},
- "name": {
+ "speed": {
+ "type": "number",
+ "description": "This is the speed multiplier that will be used.",
+ "minimum": 0.1,
+ "maximum": 5,
+ "example": null
+ },
+ "temperature": {
+ "type": "number",
+ "description": "A floating point number between 0, exclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used. The temperature parameter controls variance. Lower temperatures result in more predictable results, higher temperatures allow each run to vary more, so the voice may sound less like the baseline voice.",
+ "minimum": 0.1,
+ "maximum": 2,
+ "example": null
+ },
+ "emotion": {
"type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
- }
- },
- "required": [
- "provider"
- ]
- },
- "CreateGoogleCalendarOAuth2AuthorizationCredentialDTO": {
- "type": "object",
- "properties": {
- "provider": {
+ "description": "An emotion to be applied to the speech.",
+ "enum": [
+ "female_happy",
+ "female_sad",
+ "female_angry",
+ "female_fearful",
+ "female_disgust",
+ "female_surprised",
+ "male_happy",
+ "male_sad",
+ "male_angry",
+ "male_fearful",
+ "male_disgust",
+ "male_surprised"
+ ],
+ "example": null
+ },
+ "voiceGuidance": {
+ "type": "number",
+ "description": "A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.",
+ "minimum": 1,
+ "maximum": 6,
+ "example": null
+ },
+ "styleGuidance": {
+ "type": "number",
+ "description": "A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.",
+ "minimum": 1,
+ "maximum": 30,
+ "example": null
+ },
+ "textGuidance": {
+ "type": "number",
+ "description": "A number between 1 and 2. This number influences how closely the generated speech adheres to the input text. Use lower values to create more fluid speech, but with a higher chance of deviating from the input text. Higher numbers will make the generated speech more accurate to the input text, ensuring that the words spoken align closely with the provided text.",
+ "minimum": 1,
+ "maximum": 2,
+ "example": null
+ },
+ "model": {
"type": "string",
+ "description": "Playht voice model/engine to use.",
"enum": [
- "google.calendar.oauth2-authorization"
+ "PlayHT2.0",
+ "PlayHT2.0-turbo",
+ "Play3.0-mini",
+ "PlayDialog"
]
},
- "authorizationId": {
+ "language": {
"type": "string",
- "description": "The authorization ID for the OAuth2 authorization"
+ "description": "The language to use for the speech.",
+ "enum": [
+ "afrikaans",
+ "albanian",
+ "amharic",
+ "arabic",
+ "bengali",
+ "bulgarian",
+ "catalan",
+ "croatian",
+ "czech",
+ "danish",
+ "dutch",
+ "english",
+ "french",
+ "galician",
+ "german",
+ "greek",
+ "hebrew",
+ "hindi",
+ "hungarian",
+ "indonesian",
+ "italian",
+ "japanese",
+ "korean",
+ "malay",
+ "mandarin",
+ "polish",
+ "portuguese",
+ "russian",
+ "serbian",
+ "spanish",
+ "swedish",
+ "tagalog",
+ "thai",
+ "turkish",
+ "ukrainian",
+ "urdu",
+ "xhosa"
+ ]
},
- "name": {
- "type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
+ },
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackPlan"
+ }
+ ]
}
},
"required": [
"provider",
- "authorizationId"
+ "voiceId"
]
},
- "CreateGoogleSheetsOAuth2AuthorizationCredentialDTO": {
+ "RimeAIVoice": {
"type": "object",
"properties": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
"provider": {
"type": "string",
+ "description": "This is the voice provider that will be used.",
"enum": [
- "google.sheets.oauth2-authorization"
+ "rime-ai"
]
},
- "authorizationId": {
+ "voiceId": {
+ "description": "This is the provider-specific ID that will be used.",
+ "oneOf": [
+ {
+ "type": "string",
+ "enum": [
+ "abbie",
+ "allison",
+ "ally",
+ "alona",
+ "amber",
+ "ana",
+ "antoine",
+ "armon",
+ "brenda",
+ "brittany",
+ "carol",
+ "colin",
+ "courtney",
+ "elena",
+ "elliot",
+ "eva",
+ "geoff",
+ "gerald",
+ "hank",
+ "helen",
+ "hera",
+ "jen",
+ "joe",
+ "joy",
+ "juan",
+ "kendra",
+ "kendrick",
+ "kenneth",
+ "kevin",
+ "kris",
+ "linda",
+ "madison",
+ "marge",
+ "marina",
+ "marissa",
+ "marta",
+ "maya",
+ "nicholas",
+ "nyles",
+ "phil",
+ "reba",
+ "rex",
+ "rick",
+ "ritu",
+ "rob",
+ "rodney",
+ "rohan",
+ "rosco",
+ "samantha",
+ "sandy",
+ "selena",
+ "seth",
+ "sharon",
+ "stan",
+ "tamra",
+ "tanya",
+ "tibur",
+ "tj",
+ "tyler",
+ "viv",
+ "yadira",
+ "marsh",
+ "bayou",
+ "creek",
+ "brook",
+ "flower",
+ "spore",
+ "glacier",
+ "gulch",
+ "alpine",
+ "cove",
+ "lagoon",
+ "tundra",
+ "steppe",
+ "mesa",
+ "grove",
+ "rainforest",
+ "moraine",
+ "wildflower",
+ "peak",
+ "boulder",
+ "gypsum",
+ "zest"
+ ],
+ "title": "Preset Voice Options"
+ },
+ {
+ "type": "string",
+ "title": "RimeAI Voice ID"
+ }
+ ]
+ },
+ "model": {
"type": "string",
- "description": "The authorization ID for the OAuth2 authorization"
+ "description": "This is the model that will be used. Defaults to 'v1' when not specified.",
+ "enum": [
+ "v1",
+ "mist",
+ "mistv2"
+ ],
+ "example": "mistv2"
},
- "name": {
+ "speed": {
+ "type": "number",
+ "description": "This is the speed multiplier that will be used.",
+ "minimum": 0.1,
+ "example": null
+ },
+ "pauseBetweenBrackets": {
+ "type": "boolean",
+ "description": "This is a flag that controls whether to add slight pauses using angle brackets. Example: \"Hi. <200> I'd love to have a conversation with you.\" adds a 200ms pause between the first and second sentences.",
+ "example": false
+ },
+ "phonemizeBetweenBrackets": {
+ "type": "boolean",
+ "description": "This is a flag that controls whether text inside brackets should be phonemized (converted to phonetic pronunciation) - Example: \"{h'El.o} World\" will pronounce \"Hello\" as expected.",
+ "example": false
+ },
+ "reduceLatency": {
+ "type": "boolean",
+ "description": "This is a flag that controls whether to optimize for reduced latency in streaming. https://docs.rime.ai/api-reference/endpoint/websockets#param-reduce-latency",
+ "example": false
+ },
+ "inlineSpeedAlpha": {
"type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
+ "description": "This is a string that allows inline speed control using alpha notation. https://docs.rime.ai/api-reference/endpoint/websockets#param-inline-speed-alpha",
+ "example": null
+ },
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
+ },
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackPlan"
+ }
+ ]
}
},
"required": [
"provider",
- "authorizationId"
+ "voiceId"
]
},
- "CreateSlackOAuth2AuthorizationCredentialDTO": {
+ "SesameVoice": {
"type": "object",
"properties": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
"provider": {
"type": "string",
+ "description": "This is the voice provider that will be used.",
"enum": [
- "slack.oauth2-authorization"
+ "sesame"
]
},
- "authorizationId": {
+ "voiceId": {
"type": "string",
- "description": "The authorization ID for the OAuth2 authorization"
+ "description": "This is the provider-specific ID that will be used.",
+ "title": "Sesame Voice ID. This should be either a name (a built-in voice) or a UUID (a custom voice)."
},
- "name": {
+ "model": {
"type": "string",
- "description": "This is the name of credential. This is just for your reference.",
- "minLength": 1,
- "maxLength": 40
+ "description": "This is the model that will be used.",
+ "enum": [
+ "csm-1b"
+ ]
+ },
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
+ },
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackPlan"
+ }
+ ]
}
},
"required": [
"provider",
- "authorizationId"
+ "voiceId",
+ "model"
]
},
- "TransferAssistantHookAction": {
+ "SmallestAIVoice": {
"type": "object",
"properties": {
- "type": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
+ "provider": {
"type": "string",
- "description": "This is the type of action - must be \"transfer\"",
+ "description": "This is the voice provider that will be used.",
"enum": [
- "transfer"
+ "smallest-ai"
]
},
- "destination": {
- "description": "This is the destination details for the transfer - can be a phone number or SIP URI",
+ "voiceId": {
+ "description": "This is the provider-specific ID that will be used.",
"oneOf": [
{
- "$ref": "#/components/schemas/TransferDestinationNumber",
- "title": "NumberTransferDestination"
+ "type": "string",
+ "enum": [
+ "emily",
+ "jasmine",
+ "arman",
+ "james",
+ "mithali",
+ "aravind",
+ "raj",
+ "diya",
+ "raman",
+ "ananya",
+ "isha",
+ "william",
+ "aarav",
+ "monika",
+ "niharika",
+ "deepika",
+ "raghav",
+ "kajal",
+ "radhika",
+ "mansi",
+ "nisha",
+ "saurabh",
+ "pooja",
+ "saina",
+ "sanya"
+ ],
+ "title": "Preset Voice Options"
},
{
- "$ref": "#/components/schemas/TransferDestinationSip",
- "title": "SipTransferDestination"
+ "type": "string",
+ "title": "Smallest AI Voice ID"
}
]
- }
- },
- "required": [
- "type"
- ]
- },
- "GoogleVoicemailDetectionPlan": {
- "type": "object",
- "properties": {
- "provider": {
+ },
+ "model": {
"type": "string",
- "description": "This is the provider to use for voicemail detection.",
+ "description": "Smallest AI voice model to use. Defaults to 'lightning' when not specified.",
"enum": [
- "google"
+ "lightning"
]
},
- "voicemailExpectedDurationSeconds": {
+ "speed": {
"type": "number",
- "description": "This is how long should we listen in order to determine if we were sent to voicemail or not?\n\n@default 15",
- "minimum": 5,
- "maximum": 60,
- "default": 25
+ "description": "This is the speed multiplier that will be used.",
+ "example": null
+ },
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
+ },
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FallbackPlan"
+ }
+ ]
}
},
"required": [
"provider",
- "voicemailExpectedDurationSeconds"
+ "voiceId"
]
},
- "OpenAIVoicemailDetectionPlan": {
+ "TavusConversationProperties": {
"type": "object",
"properties": {
- "provider": {
- "type": "string",
- "description": "This is the provider to use for voicemail detection.",
- "enum": [
- "openai"
- ]
+ "maxCallDuration": {
+ "type": "number",
+ "description": "The maximum duration of the call in seconds. The default `maxCallDuration` is 3600 seconds (1 hour).\nOnce the time limit specified by this parameter has been reached, the conversation will automatically shut down."
+ },
+ "participantLeftTimeout": {
+ "type": "number",
+ "description": "The duration in seconds after which the call will be automatically shut down once the last participant leaves."
},
- "voicemailExpectedDurationSeconds": {
+ "participantAbsentTimeout": {
"type": "number",
- "description": "This is how long should we listen in order to determine if we were sent to voicemail or not?\n\n@default 15",
- "minimum": 5,
- "maximum": 60,
- "default": 25
+ "description": "Starting from conversation creation, the duration in seconds after which the call will be automatically shut down if no participant joins the call.\nDefault is 300 seconds (5 minutes)."
+ },
+ "enableRecording": {
+ "type": "boolean",
+ "description": "If true, the user will be able to record the conversation."
+ },
+ "enableTranscription": {
+ "type": "boolean",
+ "description": "If true, the user will be able to transcribe the conversation.\nYou can find more instructions on displaying transcriptions if you are using your custom DailyJS components here.\nYou need to have an event listener on Daily that listens for `app-messages`."
+ },
+ "applyGreenscreen": {
+ "type": "boolean",
+ "description": "If true, the background will be replaced with a greenscreen (RGB values: `[0, 255, 155]`).\nYou can use WebGL on the frontend to make the greenscreen transparent or change its color."
+ },
+ "language": {
+ "type": "string",
+ "description": "The language of the conversation. Please provide the **full language name**, not the two-letter code.\nIf you are using your own TTS voice, please ensure it supports the language you provide.\nIf you are using a stock replica or default persona, please note that only ElevenLabs and Cartesia supported languages are available.\nYou can find a full list of supported languages for Cartesia here, for ElevenLabs here, and for PlayHT here."
+ },
+ "recordingS3BucketName": {
+ "type": "string",
+ "description": "The name of the S3 bucket where the recording will be stored."
+ },
+ "recordingS3BucketRegion": {
+ "type": "string",
+ "description": "The region of the S3 bucket where the recording will be stored."
+ },
+ "awsAssumeRoleArn": {
+ "type": "string",
+ "description": "The ARN of the role that will be assumed to access the S3 bucket."
}
- },
- "required": [
- "provider",
- "voicemailExpectedDurationSeconds"
- ]
+ }
},
- "TwilioVoicemailDetectionPlan": {
+ "TavusVoice": {
"type": "object",
"properties": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
"provider": {
"type": "string",
- "description": "This is the provider to use for voicemail detection.",
+ "description": "This is the voice provider that will be used.",
"enum": [
- "twilio"
+ "tavus"
]
},
- "voicemailDetectionTypes": {
- "type": "array",
- "description": "These are the AMD messages from Twilio that are considered as voicemail. Default is ['machine_end_beep', 'machine_end_silence'].\n\n@default {Array} ['machine_end_beep', 'machine_end_silence']",
- "enum": [
- "machine_start",
- "human",
- "fax",
- "unknown",
- "machine_end_beep",
- "machine_end_silence",
- "machine_end_other"
- ],
- "example": [
- "machine_end_beep",
- "machine_end_silence"
- ],
- "items": {
- "type": "string",
- "enum": [
- "machine_start",
- "human",
- "fax",
- "unknown",
- "machine_end_beep",
- "machine_end_silence",
- "machine_end_other"
- ]
- }
- },
- "enabled": {
- "type": "boolean",
- "description": "This sets whether the assistant should detect voicemail. Defaults to true.\n\n@default true"
+ "voiceId": {
+ "description": "This is the provider-specific ID that will be used.",
+ "oneOf": [
+ {
+ "type": "string",
+ "enum": [
+ "r52da2535a"
+ ],
+ "title": "Preset Voice Options"
+ },
+ {
+ "type": "string",
+ "title": "Tavus Voice ID"
+ }
+ ]
},
- "machineDetectionTimeout": {
- "type": "number",
- "description": "The number of seconds that Twilio should attempt to perform answering machine detection before timing out and returning AnsweredBy as unknown. Default is 30 seconds.\n\nIncreasing this value will provide the engine more time to make a determination. This can be useful when DetectMessageEnd is provided in the MachineDetection parameter and there is an expectation of long answering machine greetings that can exceed 30 seconds.\n\nDecreasing this value will reduce the amount of time the engine has to make a determination. This can be particularly useful when the Enable option is provided in the MachineDetection parameter and you want to limit the time for initial detection.\n\nCheck the [Twilio docs](https://www.twilio.com/docs/voice/answering-machine-detection#optional-api-tuning-parameters) for more info.\n\n@default 30",
- "minimum": 3,
- "maximum": 59
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
},
- "machineDetectionSpeechThreshold": {
- "type": "number",
- "description": "The number of milliseconds that is used as the measuring stick for the length of the speech activity. Durations lower than this value will be interpreted as a human, longer as a machine. Default is 2400 milliseconds.\n\nIncreasing this value will reduce the chance of a False Machine (detected machine, actually human) for a long human greeting (e.g., a business greeting) but increase the time it takes to detect a machine.\n\nDecreasing this value will reduce the chances of a False Human (detected human, actually machine) for short voicemail greetings. The value of this parameter may need to be reduced by more than 1000ms to detect very short voicemail greetings. A reduction of that significance can result in increased False Machine detections. Adjusting the MachineDetectionSpeechEndThreshold is likely the better approach for short voicemails. Decreasing MachineDetectionSpeechThreshold will also reduce the time it takes to detect a machine.\n\nCheck the [Twilio docs](https://www.twilio.com/docs/voice/answering-machine-detection#optional-api-tuning-parameters) for more info.\n\n@default 2400",
- "minimum": 1000,
- "maximum": 6000
+ "personaId": {
+ "type": "string",
+ "description": "This is the unique identifier for the persona that the replica will use in the conversation."
},
- "machineDetectionSpeechEndThreshold": {
- "type": "number",
- "description": "The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Default is 1200 milliseconds.\n\nIncreasing this value will typically be used to better address the short voicemail greeting scenarios. For short voicemails, there is typically 1000-2000ms of audio followed by 1200-2400ms of silence and then additional audio before the beep. Increasing the MachineDetectionSpeechEndThreshold to ~2500ms will treat the 1200-2400ms of silence as a gap in the greeting but not the end of the greeting and will result in a machine detection. The downsides of such a change include:\n- Increasing the delay for human detection by the amount you increase this parameter, e.g., a change of 1200ms to 2500ms increases human detection delay by 1300ms.\n- Cases where a human has two utterances separated by a period of silence (e.g. a \"Hello\", then 2000ms of silence, and another \"Hello\") may be interpreted as a machine.\n\nDecreasing this value will result in faster human detection. The consequence is that it can lead to increased False Human (detected human, actually machine) detections because a silence gap in a voicemail greeting (not necessarily just in short voicemail scenarios) can be incorrectly interpreted as the end of speech.\n\nCheck the [Twilio docs](https://www.twilio.com/docs/voice/answering-machine-detection#optional-api-tuning-parameters) for more info.\n\n@default 1200",
- "minimum": 500,
- "maximum": 5000
+ "callbackUrl": {
+ "type": "string",
+ "description": "This is the url that will receive webhooks with updates regarding the conversation state."
},
- "machineDetectionSilenceTimeout": {
- "type": "number",
- "description": "The number of milliseconds of initial silence after which an unknown AnsweredBy result will be returned. Default is 5000 milliseconds.\n\nIncreasing this value will result in waiting for a longer period of initial silence before returning an 'unknown' AMD result.\n\nDecreasing this value will result in waiting for a shorter period of initial silence before returning an 'unknown' AMD result.\n\nCheck the [Twilio docs](https://www.twilio.com/docs/voice/answering-machine-detection#optional-api-tuning-parameters) for more info.\n\n@default 5000",
- "minimum": 2000,
- "maximum": 10000
- }
- },
- "required": [
- "provider"
- ]
- },
- "CompliancePlan": {
- "type": "object",
- "properties": {
- "hipaaEnabled": {
- "type": "boolean",
- "description": "When this is enabled, no logs, recordings, or transcriptions will be stored.\nAt the end of the call, you will still receive an end-of-call-report message to store on your server. Defaults to false.",
- "example": {
- "hipaaEnabled": false
- }
+ "conversationName": {
+ "type": "string",
+ "description": "This is the name for the conversation."
},
- "pciEnabled": {
- "type": "boolean",
- "description": "When this is enabled, the user will be restricted to use PCI-compliant providers, and no logs or transcripts are stored.\nAt the end of the call, you will receive an end-of-call-report message to store on your server. Defaults to false.",
- "example": {
- "pciEnabled": false
- }
- }
- }
- },
- "StructuredDataPlan": {
- "type": "object",
- "properties": {
- "messages": {
- "description": "These are the messages used to generate the structured data.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert data extractor. You will be given a transcript of a call. Extract structured data per the JSON Schema. DO NOT return anything except the structured data.\\n\\nJson Schema:\\\\n{{schema}}\\n\\nOnly respond with the JSON.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: the transcript of the call from `call.artifact.transcript`- {{systemPrompt}}: the system prompt of the call from `assistant.model.messages[type=system].content`- {{schema}}: the schema of the structured data from `structuredDataPlan.schema`",
- "type": "array",
- "items": {
- "type": "object"
- }
+ "conversationalContext": {
+ "type": "string",
+ "description": "This is the context that will be appended to any context provided in the persona, if one is provided."
},
- "enabled": {
- "type": "boolean",
- "description": "This determines whether structured data is generated and stored in `call.analysis.structuredData`. Defaults to false.\n\nUsage:\n- If you want to extract structured data, set this to true and provide a `schema`.\n\n@default false"
+ "customGreeting": {
+ "type": "string",
+ "description": "This is the custom greeting that the replica will give once a participant joines the conversation."
},
- "schema": {
- "description": "This is the schema of the structured data. The 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).",
+ "properties": {
+ "description": "These are optional properties used to customize the conversation.",
"allOf": [
{
- "$ref": "#/components/schemas/JsonSchema"
+ "$ref": "#/components/schemas/TavusConversationProperties"
}
]
},
- "timeoutSeconds": {
- "type": "number",
- "description": "This is how long the request is tried before giving up. When request times out, `call.analysis.structuredData` will be empty.\n\nUsage:\n- To guarantee the structured data is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds",
- "minimum": 1,
- "maximum": 60
- }
- }
- },
- "StructuredDataMultiPlan": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "This is the key of the structured data plan in the catalog."
- },
- "plan": {
- "description": "This is an individual structured data plan in the catalog.",
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
"allOf": [
{
- "$ref": "#/components/schemas/StructuredDataPlan"
+ "$ref": "#/components/schemas/FallbackPlan"
}
]
}
},
"required": [
- "key",
- "plan"
+ "provider",
+ "voiceId"
]
},
- "SuccessEvaluationPlan": {
+ "VapiVoice": {
"type": "object",
"properties": {
- "rubric": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
+ "provider": {
"type": "string",
+ "description": "This is the voice provider that will be used.",
"enum": [
- "NumericScale",
- "DescriptiveScale",
- "Checklist",
- "Matrix",
- "PercentageScale",
- "LikertScale",
- "AutomaticRubric",
- "PassFail"
- ],
- "description": "This enforces the rubric of the evaluation. The output is stored in `call.analysis.successEvaluation`.\n\nOptions include:\n- 'NumericScale': A scale of 1 to 10.\n- 'DescriptiveScale': A scale of Excellent, Good, Fair, Poor.\n- 'Checklist': A checklist of criteria and their status.\n- 'Matrix': A grid that evaluates multiple criteria across different performance levels.\n- 'PercentageScale': A scale of 0% to 100%.\n- 'LikertScale': A scale of Strongly Agree, Agree, Neutral, Disagree, Strongly Disagree.\n- 'AutomaticRubric': Automatically break down evaluation into several criteria, each with its own score.\n- 'PassFail': A simple 'true' if call passed, 'false' if not.\n\nDefault is 'PassFail'."
- },
- "messages": {
- "description": "These are the messages used to generate the success evaluation.\n\n@default: ```\n[\n {\n \"role\": \"system\",\n \"content\": \"You are an expert call evaluator. You will be given a transcript of a call and the system prompt of the AI participant. Determine if the call was successful based on the objectives inferred from the system prompt. DO NOT return anything except the result.\\n\\nRubric:\\\\n{{rubric}}\\n\\nOnly respond with the result.\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here is the transcript:\\n\\n{{transcript}}\\n\\n\"\n },\n {\n \"role\": \"user\",\n \"content\": \"Here was the system prompt of the call:\\n\\n{{systemPrompt}}\\n\\n\"\n }\n]```\n\nYou can customize by providing any messages you want.\n\nHere are the template variables available:\n- {{transcript}}: the transcript of the call from `call.artifact.transcript`- {{systemPrompt}}: the system prompt of the call from `assistant.model.messages[type=system].content`- {{rubric}}: the rubric of the success evaluation from `successEvaluationPlan.rubric`",
- "type": "array",
- "items": {
- "type": "object"
- }
+ "vapi"
+ ]
},
- "enabled": {
- "type": "boolean",
- "description": "This determines whether a success evaluation is generated and stored in `call.analysis.successEvaluation`. Defaults to true.\n\nUsage:\n- If you want to disable the success evaluation, set this to false.\n\n@default true"
+ "voiceId": {
+ "type": "string",
+ "description": "The voices provided by Vapi",
+ "enum": [
+ "Elliot",
+ "Kylie",
+ "Rohan",
+ "Lily",
+ "Savannah",
+ "Hana",
+ "Neha",
+ "Cole",
+ "Harry",
+ "Paige",
+ "Spencer"
+ ]
},
- "timeoutSeconds": {
+ "speed": {
"type": "number",
- "description": "This is how long the request is tried before giving up. When request times out, `call.analysis.successEvaluation` will be empty.\n\nUsage:\n- To guarantee the success evaluation is generated, set this value high. Note, this will delay the end of call report in cases where model is slow to respond.\n\n@default 5 seconds",
- "minimum": 1,
- "maximum": 60
- }
- }
- },
- "AnalysisPlan": {
- "type": "object",
- "properties": {
- "summaryPlan": {
- "description": "This is the plan for generating the summary of the call. This outputs to `call.analysis.summary`.",
- "allOf": [
- {
- "$ref": "#/components/schemas/SummaryPlan"
- }
- ]
+ "description": "This is the speed multiplier that will be used.\n\n@default 1",
+ "minimum": 0.25,
+ "maximum": 2,
+ "default": 1
},
- "structuredDataPlan": {
- "description": "This is the plan for generating the structured data from the call. This outputs to `call.analysis.structuredData`.",
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
"allOf": [
{
- "$ref": "#/components/schemas/StructuredDataPlan"
+ "$ref": "#/components/schemas/ChunkPlan"
}
]
},
- "structuredDataMultiPlan": {
- "description": "This is an array of structured data plan catalogs. Each entry includes a `key` and a `plan` for generating the structured data from the call. This outputs to `call.analysis.structuredDataMulti`.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/StructuredDataMultiPlan"
- }
- },
- "successEvaluationPlan": {
- "description": "This is the plan for generating the success evaluation of the call. This outputs to `call.analysis.successEvaluation`.",
+ "fallbackPlan": {
+ "description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
"allOf": [
{
- "$ref": "#/components/schemas/SuccessEvaluationPlan"
+ "$ref": "#/components/schemas/FallbackPlan"
}
]
}
- }
+ },
+ "required": [
+ "provider",
+ "voiceId"
+ ]
},
- "MessagePlan": {
+ "FallbackAzureVoice": {
"type": "object",
"properties": {
- "idleMessages": {
- "description": "This are the messages that the assistant will speak when the user hasn't responded for `idleTimeoutSeconds`. Each time the timeout is triggered, a random message will be chosen from this array.\n\nUsage:\n- If user gets distracted and doesn't respond for a while, this can be used to grab their attention.\n- If the transcriber doesn't pick up what the user said, this can be used to ask the user to repeat themselves. (From the perspective of the assistant, the conversation is idle since it didn't \"hear\" any user messages.)\n\n@default null (no idle message is spoken)",
- "type": "array",
- "items": {
- "type": "string",
- "maxLength": 1000
- }
- },
- "idleMessageMaxSpokenCount": {
- "type": "number",
- "description": "This determines the maximum number of times `idleMessages` can be spoken during the call.\n\n@default 3",
- "minimum": 1,
- "maximum": 10
- },
- "idleMessageResetCountOnUserSpeechEnabled": {
+ "cachingEnabled": {
"type": "boolean",
- "description": "This determines whether the idle message count is reset whenever the user speaks.\n\n@default false"
- },
- "idleTimeoutSeconds": {
- "type": "number",
- "description": "This is the timeout in seconds before a message from `idleMessages` is spoken. The clock starts when the assistant finishes speaking and remains active until the user speaks.\n\n@default 10",
- "minimum": 5,
- "maximum": 60
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
},
- "silenceTimeoutMessage": {
- "type": "string",
- "description": "This is the message that the assistant will say if the call ends due to silence.\n\nIf unspecified, it will hang up without saying anything.",
- "maxLength": 1000
- }
- }
- },
- "AssistantCustomEndpointingRule": {
- "type": "object",
- "properties": {
- "type": {
+ "provider": {
"type": "string",
- "description": "This endpointing rule is based on the last assistant message before customer started speaking.\n\nFlow:\n- Assistant speaks\n- Customer starts speaking\n- Customer transcription comes in\n- This rule is evaluated on the last assistant message\n- If a match is found based on `regex`, the endpointing timeout is set to `timeoutSeconds`\n\nUsage:\n- If you have yes/no questions in your use case like \"are you interested in a loan?\", you can set a shorter timeout.\n- If you have questions where the customer may pause to look up information like \"what's my account number?\", you can set a longer timeout.",
+ "description": "This is the voice provider that will be used.",
"enum": [
- "assistant"
+ "azure"
]
},
- "regex": {
- "type": "string",
- "description": "This is the regex pattern to match.\n\nNote:\n- This works by using the `RegExp.test` method in Node.JS. Eg. `/hello/.test(\"hello there\")` will return `true`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.\n- `RegExp.test` does substring matching, so `/cat/.test(\"I love cats\")` will return `true`. To do full string matching, send \"^cat$\"."
- },
- "regexOptions": {
- "description": "These are the options for the regex match. Defaults to all disabled.\n\n@default []",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RegexOption"
- }
+ "voiceId": {
+ "description": "This is the provider-specific ID that will be used.",
+ "oneOf": [
+ {
+ "type": "string",
+ "enum": [
+ "andrew",
+ "brian",
+ "emma"
+ ],
+ "title": "Preset Voice Options"
+ },
+ {
+ "type": "string",
+ "title": "Azure Voice ID"
+ }
+ ]
},
- "timeoutSeconds": {
+ "speed": {
"type": "number",
- "description": "This is the endpointing timeout in seconds, if the rule is matched.",
- "minimum": 0,
- "maximum": 15
+ "description": "This is the speed multiplier that will be used.",
+ "minimum": 0.5,
+ "maximum": 2
+ },
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
}
},
"required": [
- "type",
- "regex",
- "timeoutSeconds"
+ "provider",
+ "voiceId"
]
},
- "CustomerCustomEndpointingRule": {
+ "FallbackCartesiaVoice": {
"type": "object",
"properties": {
- "type": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
+ "provider": {
"type": "string",
- "description": "This endpointing rule is based on current customer message as they are speaking.\n\nFlow:\n- Assistant speaks\n- Customer starts speaking\n- Customer transcription comes in\n- This rule is evaluated on the current customer transcription\n- If a match is found based on `regex`, the endpointing timeout is set to `timeoutSeconds`\n\nUsage:\n- If you want to wait longer while customer is speaking numbers, you can set a longer timeout.",
+ "description": "This is the voice provider that will be used.",
"enum": [
- "customer"
+ "cartesia"
]
},
- "regex": {
+ "voiceId": {
"type": "string",
- "description": "This is the regex pattern to match.\n\nNote:\n- This works by using the `RegExp.test` method in Node.JS. Eg. `/hello/.test(\"hello there\")` will return `true`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.\n- `RegExp.test` does substring matching, so `/cat/.test(\"I love cats\")` will return `true`. To do full string matching, send \"^cat$\"."
- },
- "regexOptions": {
- "description": "These are the options for the regex match. Defaults to all disabled.\n\n@default []",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RegexOption"
- }
+ "description": "The ID of the particular voice you want to use."
},
- "timeoutSeconds": {
- "type": "number",
- "description": "This is the endpointing timeout in seconds, if the rule is matched.",
- "minimum": 0,
- "maximum": 15
- }
- },
- "required": [
- "type",
- "regex",
- "timeoutSeconds"
- ]
- },
- "BothCustomEndpointingRule": {
- "type": "object",
- "properties": {
- "type": {
+ "model": {
"type": "string",
- "description": "This endpointing rule is based on both the last assistant message and the current customer message as they are speaking.\n\nFlow:\n- Assistant speaks\n- Customer starts speaking\n- Customer transcription comes in\n- This rule is evaluated on the last assistant message and the current customer transcription\n- If assistant message matches `assistantRegex` AND customer message matches `customerRegex`, the endpointing timeout is set to `timeoutSeconds`\n\nUsage:\n- If you want to wait longer while customer is speaking numbers, you can set a longer timeout.",
+ "description": "This is the model that will be used. This is optional and will default to the correct model for the voiceId.",
"enum": [
- "both"
- ]
+ "sonic-2",
+ "sonic-english",
+ "sonic-multilingual",
+ "sonic-preview",
+ "sonic"
+ ],
+ "example": "sonic-english"
},
- "assistantRegex": {
+ "language": {
"type": "string",
- "description": "This is the regex pattern to match the assistant's message.\n\nNote:\n- This works by using the `RegExp.test` method in Node.JS. Eg. `/hello/.test(\"hello there\")` will return `true`.\n\nHot tip:\n- In JavaScript, escape `\\` when sending the regex pattern. Eg. `\"hello\\sthere\"` will be sent over the wire as `\"hellosthere\"`. Send `\"hello\\\\sthere\"` instead.\n- `RegExp.test` does substring matching, so `/cat/.test(\"I love cats\")` will return `true`. To do full string matching, send \"^cat$\"."
- },
- "assistantRegexOptions": {
- "description": "These are the options for the assistant's message regex match. Defaults to all disabled.\n\n@default []",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RegexOption"
- }
- },
- "customerRegex": {
- "type": "string"
+ "description": "This is the language that will be used. This is optional and will default to the correct language for the voiceId.",
+ "enum": [
+ "en",
+ "de",
+ "es",
+ "fr",
+ "ja",
+ "pt",
+ "zh",
+ "hi",
+ "it",
+ "ko",
+ "nl",
+ "pl",
+ "ru",
+ "sv",
+ "tr"
+ ],
+ "example": "en"
},
- "customerRegexOptions": {
- "description": "These are the options for the customer's message regex match. Defaults to all disabled.\n\n@default []",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RegexOption"
- }
+ "experimentalControls": {
+ "description": "Experimental controls for Cartesia voice generation",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CartesiaExperimentalControls"
+ }
+ ]
},
- "timeoutSeconds": {
- "type": "number",
- "description": "This is the endpointing timeout in seconds, if the rule is matched.",
- "minimum": 0,
- "maximum": 15
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
}
},
"required": [
- "type",
- "assistantRegex",
- "customerRegex",
- "timeoutSeconds"
+ "provider",
+ "voiceId"
]
},
- "VapiSmartEndpointingPlan": {
+ "FallbackCustomVoice": {
"type": "object",
"properties": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
"provider": {
"type": "string",
- "description": "This is the provider for the smart endpointing plan.",
+ "description": "This is the voice provider that will be used. Use `custom-voice` for providers that are not natively supported.",
"enum": [
- "vapi",
- "livekit"
- ],
- "example": "vapi"
+ "custom-voice"
+ ]
+ },
+ "server": {
+ "description": "This is where the voice request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"message\": {\n \"type\": \"voice-request\",\n \"text\": \"Hello, world!\",\n \"sampleRate\": 24000,\n ...other metadata about the call...\n }\n}\n\nResponse Expected: 1-channel 16-bit raw PCM audio at the sample rate specified in the request. Here is how the response will be piped to the transport:\n```\nresponse.on('data', (chunk: Buffer) => {\n outputStream.write(chunk);\n});\n```",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
+ },
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
}
},
"required": [
- "provider"
+ "provider",
+ "server"
]
},
- "LivekitSmartEndpointingPlan": {
+ "FallbackDeepgramVoice": {
"type": "object",
"properties": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
"provider": {
"type": "string",
- "description": "This is the provider for the smart endpointing plan.",
+ "description": "This is the voice provider that will be used.",
"enum": [
- "vapi",
- "livekit"
- ],
- "example": "livekit"
+ "deepgram"
+ ]
},
- "waitFunction": {
+ "voiceId": {
"type": "string",
- "description": "This expression describes how long the bot will wait to start speaking based on the likelihood that the user has reached an endpoint.\n\nThis is a millisecond valued function. It maps probabilities (real numbers on [0,1]) to milliseconds that the bot should wait before speaking ([0, \\infty]). Any negative values that are returned are set to zero (the bot can't start talking in the past).\n\nA probability of zero represents very high confidence that the caller has stopped speaking, and would like the bot to speak to them. A probability of one represents very high confidence that the caller is still speaking.\n\nUnder the hood, this is parsed into a mathjs expression. Whatever you use to write your expression needs to be valid with respect to mathjs\n\n@default \"70 + 4000 * x\"",
- "examples": [
- "70 + 4000 * x",
- "200 + 8000 * x",
- "4000 * (1 - cos(pi * x))"
- ]
- }
- },
- "required": [
- "provider"
- ]
- },
- "TranscriptionEndpointingPlan": {
- "type": "object",
- "properties": {
- "onPunctuationSeconds": {
- "type": "number",
- "description": "The minimum number of seconds to wait after transcription ending with punctuation before sending a request to the model. Defaults to 0.1.\n\nThis setting exists because the transcriber punctuates the transcription when it's more confident that customer has completed a thought.\n\n@default 0.1",
- "minimum": 0,
- "maximum": 3,
- "example": 0.1
+ "description": "This is the provider-specific ID that will be used.",
+ "enum": [
+ "asteria",
+ "luna",
+ "stella",
+ "athena",
+ "hera",
+ "orion",
+ "arcas",
+ "perseus",
+ "angus",
+ "orpheus",
+ "helios",
+ "zeus",
+ "thalia",
+ "andromeda",
+ "helena",
+ "apollo",
+ "arcas",
+ "aries",
+ "amalthea",
+ "asteria",
+ "athena",
+ "atlas",
+ "aurora",
+ "callista",
+ "cora",
+ "cordelia",
+ "delia",
+ "draco",
+ "electra",
+ "harmonia",
+ "hera",
+ "hermes",
+ "hyperion",
+ "iris",
+ "janus",
+ "juno",
+ "jupiter",
+ "luna",
+ "mars",
+ "minerva",
+ "neptune",
+ "odysseus",
+ "ophelia",
+ "orion",
+ "orpheus",
+ "pandora",
+ "phoebe",
+ "pluto",
+ "saturn",
+ "selene",
+ "theia",
+ "vesta",
+ "zeus"
+ ],
+ "title": "This is the Deepgram Voice ID"
},
- "onNoPunctuationSeconds": {
- "type": "number",
- "description": "The minimum number of seconds to wait after transcription ending without punctuation before sending a request to the model. Defaults to 1.5.\n\nThis setting exists to catch the cases where the transcriber was not confident enough to punctuate the transcription, but the customer is done and has been silent for a long time.\n\n@default 1.5",
- "minimum": 0,
- "maximum": 3,
- "example": 1.5
+ "model": {
+ "type": "string",
+ "description": "This is the model that will be used. Defaults to 'aura-2' when not specified.",
+ "enum": [
+ "aura",
+ "aura-2"
+ ],
+ "example": "aura-2"
},
- "onNumberSeconds": {
- "type": "number",
- "description": "The minimum number of seconds to wait after transcription ending with a number before sending a request to the model. Defaults to 0.4.\n\nThis setting exists because the transcriber will sometimes punctuate the transcription ending with a number, even though the customer hasn't uttered the full number. This happens commonly for long numbers when the customer reads the number in chunks.\n\n@default 0.5",
- "minimum": 0,
- "maximum": 3,
- "example": 0.5
+ "mipOptOut": {
+ "type": "boolean",
+ "description": "If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false",
+ "example": false,
+ "default": false
+ },
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
}
- }
+ },
+ "required": [
+ "provider",
+ "voiceId"
+ ]
},
- "StartSpeakingPlan": {
+ "FallbackElevenLabsVoice": {
"type": "object",
"properties": {
- "waitSeconds": {
- "type": "number",
- "description": "This is how long assistant waits before speaking. Defaults to 0.4.\n\nThis is the minimum it will wait but if there is latency is the pipeline, this minimum will be exceeded. This is intended as a stopgap in case the pipeline is moving too fast.\n\nExample:\n- If model generates tokens and voice generates bytes within 100ms, the pipeline still waits 300ms before outputting speech.\n\nUsage:\n- If the customer is taking long pauses, set this to a higher value.\n- If the assistant is accidentally jumping in too much, set this to a higher value.\n\n@default 0.4",
- "minimum": 0,
- "maximum": 5,
- "example": 0.4
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
},
- "smartEndpointingEnabled": {
- "type": "object",
- "example": false,
- "deprecated": true
+ "provider": {
+ "type": "string",
+ "description": "This is the voice provider that will be used.",
+ "enum": [
+ "11labs"
+ ]
},
- "smartEndpointingPlan": {
- "description": "This is the plan for smart endpointing. Pick between Vapi smart endpointing or LiveKit smart endpointing (or nothing). We strongly recommend using livekit endpointing when working in English. LiveKit endpointing is not supported in other languages, yet.\n\nIf this is set, it will override and take precedence over `transcriptionEndpointingPlan`.\nThis plan will still be overridden by any matching `customEndpointingRules`.",
+ "voiceId": {
+ "description": "This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.",
"oneOf": [
{
- "$ref": "#/components/schemas/VapiSmartEndpointingPlan",
- "title": "Vapi"
+ "type": "string",
+ "enum": [
+ "burt",
+ "marissa",
+ "andrea",
+ "sarah",
+ "phillip",
+ "steve",
+ "joseph",
+ "myra",
+ "paula",
+ "ryan",
+ "drew",
+ "paul",
+ "mrb",
+ "matilda",
+ "mark"
+ ],
+ "title": "Preset Voice Options"
},
{
- "$ref": "#/components/schemas/LivekitSmartEndpointingPlan",
- "title": "Livekit"
+ "type": "string",
+ "title": "11Labs Voice ID"
}
]
},
- "customEndpointingRules": {
- "type": "array",
- "description": "These are the custom endpointing rules to set an endpointing timeout based on a regex on the customer's speech or the assistant's last message.\n\nUsage:\n- If you have yes/no questions like \"are you interested in a loan?\", you can set a shorter timeout.\n- If you have questions where the customer may pause to look up information like \"what's my account number?\", you can set a longer timeout.\n- If you want to wait longer while customer is enumerating a list of numbers, you can set a longer timeout.\n\nThese rules have the highest precedence and will override both `smartEndpointingPlan` and `transcriptionEndpointingPlan` when a rule is matched.\n\nThe rules are evaluated in order and the first one that matches will be used.\n\nOrder of precedence for endpointing:\n1. customEndpointingRules (if any match)\n2. smartEndpointingPlan (if set)\n3. transcriptionEndpointingPlan\n\n@default []",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/AssistantCustomEndpointingRule",
- "title": "Assistant"
- },
- {
- "$ref": "#/components/schemas/CustomerCustomEndpointingRule",
- "title": "Customer"
- },
- {
- "$ref": "#/components/schemas/BothCustomEndpointingRule",
- "title": "Both"
- }
- ]
- }
- },
- "transcriptionEndpointingPlan": {
- "description": "This determines how a customer speech is considered done (endpointing) using the transcription of customer's speech.\n\nOnce an endpoint is triggered, the request is sent to `assistant.model`.\n\nNote: This plan is only used if `smartEndpointingPlan` is not set. If both are provided, `smartEndpointingPlan` takes precedence.\nThis plan will also be overridden by any matching `customEndpointingRules`.",
- "allOf": [
- {
- "$ref": "#/components/schemas/TranscriptionEndpointingPlan"
- }
- ]
- }
- }
- },
- "StopSpeakingPlan": {
- "type": "object",
- "properties": {
- "numWords": {
+ "stability": {
"type": "number",
- "description": "This is the number of words that the customer has to say before the assistant will stop talking.\n\nWords like \"stop\", \"actually\", \"no\", etc. will always interrupt immediately regardless of this value.\n\nWords like \"okay\", \"yeah\", \"right\" will never interrupt.\n\nWhen set to 0, `voiceSeconds` is used in addition to the transcriptions to determine the customer has started speaking.\n\nDefaults to 0.\n\n@default 0",
+ "description": "Defines the stability for voice settings.",
"minimum": 0,
- "maximum": 10,
- "example": 0
+ "maximum": 1,
+ "example": 0.5
},
- "voiceSeconds": {
+ "similarityBoost": {
"type": "number",
- "description": "This is the seconds customer has to speak before the assistant stops talking. This uses the VAD (Voice Activity Detection) spike to determine if the customer has started speaking.\n\nConsiderations:\n- A lower value might be more responsive but could potentially pick up non-speech sounds.\n- A higher value reduces false positives but might slightly delay the detection of speech onset.\n\nThis is only used if `numWords` is set to 0.\n\nDefaults to 0.2\n\n@default 0.2",
+ "description": "Defines the similarity boost for voice settings.",
"minimum": 0,
- "maximum": 0.5,
- "example": 0.2
+ "maximum": 1,
+ "example": 0.75
},
- "backoffSeconds": {
+ "style": {
"type": "number",
- "description": "This is the seconds to wait before the assistant will start talking again after being interrupted.\n\nDefaults to 1.\n\n@default 1",
+ "description": "Defines the style for voice settings.",
"minimum": 0,
- "maximum": 10,
- "example": 1
+ "maximum": 1,
+ "example": 0
},
- "acknowledgementPhrases": {
- "description": "These are the phrases that will never interrupt the assistant, even if numWords threshold is met.\nThese are typically acknowledgement or backchanneling phrases.",
- "example": [
- "i understand",
- "i see",
- "i got it",
- "i hear you",
- "im listening",
- "im with you",
- "right",
- "okay",
- "ok",
- "sure",
- "alright",
- "got it",
- "understood",
- "yeah",
- "yes",
- "uh-huh",
- "mm-hmm",
- "gotcha",
- "mhmm",
- "ah",
- "yeah okay",
- "yeah sure"
- ],
- "default": [
- "i understand",
- "i see",
- "i got it",
- "i hear you",
- "im listening",
- "im with you",
- "right",
- "okay",
- "ok",
- "sure",
- "alright",
- "got it",
- "understood",
- "yeah",
- "yes",
- "uh-huh",
- "mm-hmm",
- "gotcha",
- "mhmm",
- "ah",
- "yeah okay",
- "yeah sure"
- ],
- "type": "array",
- "items": {
- "type": "string",
- "maxLength": 240
- }
+ "useSpeakerBoost": {
+ "type": "boolean",
+ "description": "Defines the use speaker boost for voice settings.",
+ "example": false
},
- "interruptionPhrases": {
- "description": "These are the phrases that will always interrupt the assistant immediately, regardless of numWords.\nThese are typically phrases indicating disagreement or desire to stop.",
- "example": [
- "stop",
- "shut",
- "up",
- "enough",
- "quiet",
- "silence",
- "but",
- "dont",
- "not",
- "no",
- "hold",
- "wait",
- "cut",
- "pause",
- "nope",
- "nah",
- "nevermind",
- "never",
- "bad",
- "actually"
- ],
- "default": [
- "stop",
- "shut",
- "up",
- "enough",
- "quiet",
- "silence",
- "but",
- "dont",
- "not",
- "no",
- "hold",
- "wait",
- "cut",
- "pause",
- "nope",
- "nah",
- "nevermind",
- "never",
- "bad",
- "actually"
- ],
- "type": "array",
- "items": {
- "type": "string",
- "maxLength": 240
- }
- }
- }
- },
- "MonitorPlan": {
- "type": "object",
- "properties": {
- "listenEnabled": {
+ "speed": {
+ "type": "number",
+ "description": "Defines the speed for voice settings.",
+ "minimum": 0.7,
+ "maximum": 1.2,
+ "example": 0.9
+ },
+ "optimizeStreamingLatency": {
+ "type": "number",
+ "description": "Defines the optimize streaming latency for voice settings. Defaults to 3.",
+ "minimum": 0,
+ "maximum": 4,
+ "example": 3
+ },
+ "enableSsmlParsing": {
"type": "boolean",
- "description": "This determines whether the assistant's calls allow live listening. Defaults to true.\n\nFetch `call.monitor.listenUrl` to get the live listening URL.\n\n@default true",
+ "description": "This enables the use of https://elevenlabs.io/docs/speech-synthesis/prompting#pronunciation. Defaults to false to save latency.\n\n@default false",
"example": false
},
- "controlEnabled": {
+ "autoMode": {
"type": "boolean",
- "description": "This determines whether the assistant's calls allow live control. Defaults to true.\n\nFetch `call.monitor.controlUrl` to get the live control URL.\n\nTo use, send any control message via a POST request to `call.monitor.controlUrl`. Here are the types of controls supported: https://docs.vapi.ai/api-reference/messages/client-inbound-message\n\n@default true",
+ "description": "Defines the auto mode for voice settings. Defaults to false.",
"example": false
- }
- }
- },
- "AssistantHookFilter": {
- "type": "object",
- "properties": {
- "type": {
+ },
+ "model": {
"type": "string",
- "description": "This is the type of filter - currently only \"oneOf\" is supported",
+ "description": "This is the model that will be used. Defaults to 'eleven_turbo_v2' if not specified.",
"enum": [
- "oneOf"
+ "eleven_multilingual_v2",
+ "eleven_turbo_v2",
+ "eleven_turbo_v2_5",
+ "eleven_flash_v2",
+ "eleven_flash_v2_5",
+ "eleven_monolingual_v1"
],
- "maxLength": 1000
+ "example": "eleven_turbo_v2_5"
},
- "key": {
+ "language": {
"type": "string",
- "description": "This is the key to filter on (e.g. \"call.endedReason\")",
- "maxLength": 1000
+ "description": "This is the language (ISO 639-1) that is enforced for the model. Currently only Turbo v2.5 supports language enforcement. For other models, an error will be returned if language code is provided."
},
- "oneOf": {
- "description": "This is the array of possible values to match against",
- "type": "array",
- "items": {
- "type": "string",
- "maxLength": 1000
- }
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
}
},
"required": [
- "type",
- "key",
- "oneOf"
+ "provider",
+ "voiceId"
]
},
- "AssistantHookActionBase": {
- "type": "object",
- "properties": {}
- },
- "AssistantHooks": {
+ "FallbackHumeVoice": {
"type": "object",
"properties": {
- "on": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
+ "provider": {
"type": "string",
- "description": "This is the event that triggers this hook",
+ "description": "This is the voice provider that will be used.",
"enum": [
- "call.ending"
+ "hume"
+ ]
+ },
+ "model": {
+ "type": "string",
+ "description": "This is the model that will be used.",
+ "enum": [
+ "octave"
],
- "maxLength": 1000
+ "example": "octave"
},
- "filters": {
- "description": "This is the set of filters that must match for the hook to trigger",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AssistantHookFilter"
- }
+ "voiceId": {
+ "type": "string",
+ "description": "The ID of the particular voice you want to use."
},
- "do": {
- "description": "This is the set of actions to perform when the hook triggers",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AssistantHookActionBase"
- }
+ "isCustomHumeVoice": {
+ "type": "boolean",
+ "description": "Indicates whether the chosen voice is a preset Hume AI voice or a custom voice.",
+ "example": false
+ },
+ "description": {
+ "type": "string",
+ "description": "Natural language instructions describing how the synthesized speech should sound, including but not limited to tone, intonation, pacing, and accent (e.g., 'a soft, gentle voice with a strong British accent').\n\nIf a Voice is specified in the request, this description serves as acting instructions.\nIf no Voice is specified, a new voice is generated based on this description."
+ },
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
}
},
"required": [
- "on",
- "do"
+ "provider",
+ "voiceId"
]
},
- "KeypadInputPlan": {
+ "FallbackLMNTVoice": {
"type": "object",
"properties": {
- "enabled": {
+ "cachingEnabled": {
"type": "boolean",
- "description": "This keeps track of whether the user has enabled keypad input.\nBy default, it is off.\n\n@default false"
- },
- "timeoutSeconds": {
- "type": "number",
- "description": "This is the time in seconds to wait before processing the input.\nIf the input is not received within this time, the input will be ignored.\nIf set to \"off\", the input will be processed when the user enters a delimiter or immediately if no delimiter is used.\n\n@default 2",
- "minimum": 0,
- "maximum": 10
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
},
- "delimiters": {
+ "provider": {
"type": "string",
- "description": "This is the delimiter(s) that will be used to process the input.\nCan be '#', '*', or an empty array.",
+ "description": "This is the voice provider that will be used.",
"enum": [
- "#",
- "*",
- ""
+ "lmnt"
]
- }
- }
- },
- "CreateAssistantDTO": {
- "type": "object",
- "properties": {
- "transcriber": {
- "description": "These are the options for the assistant's transcriber.",
+ },
+ "voiceId": {
+ "description": "This is the provider-specific ID that will be used.",
"oneOf": [
{
- "$ref": "#/components/schemas/AssemblyAITranscriber",
- "title": "AssemblyAI"
- },
- {
- "$ref": "#/components/schemas/AzureSpeechTranscriber",
- "title": "Azure"
- },
- {
- "$ref": "#/components/schemas/CustomTranscriber",
- "title": "CustomTranscriber"
- },
- {
- "$ref": "#/components/schemas/DeepgramTranscriber",
- "title": "Deepgram"
- },
- {
- "$ref": "#/components/schemas/ElevenLabsTranscriber",
- "title": "ElevenLabs"
- },
- {
- "$ref": "#/components/schemas/GladiaTranscriber",
- "title": "Gladia"
- },
- {
- "$ref": "#/components/schemas/SpeechmaticsTranscriber",
- "title": "Speechmatics"
- },
- {
- "$ref": "#/components/schemas/TalkscriberTranscriber",
- "title": "Talkscriber"
- },
- {
- "$ref": "#/components/schemas/GoogleTranscriber",
- "title": "Google"
+ "type": "string",
+ "enum": [
+ "amy",
+ "ansel",
+ "autumn",
+ "ava",
+ "brandon",
+ "caleb",
+ "cassian",
+ "chloe",
+ "dalton",
+ "daniel",
+ "dustin",
+ "elowen",
+ "evander",
+ "huxley",
+ "james",
+ "juniper",
+ "kennedy",
+ "lauren",
+ "leah",
+ "lily",
+ "lucas",
+ "magnus",
+ "miles",
+ "morgan",
+ "natalie",
+ "nathan",
+ "noah",
+ "nyssa",
+ "oliver",
+ "paige",
+ "ryan",
+ "sadie",
+ "sophie",
+ "stella",
+ "terrence",
+ "tyler",
+ "vesper",
+ "violet",
+ "warrick",
+ "zain",
+ "zeke",
+ "zoe"
+ ],
+ "title": "Preset Voice Options"
},
{
- "$ref": "#/components/schemas/OpenAITranscriber",
- "title": "OpenAI"
- }
+ "type": "string",
+ "title": "LMNT Voice ID"
+ }
]
},
- "model": {
- "description": "These are the options for the assistant's LLM.",
+ "speed": {
+ "type": "number",
+ "description": "This is the speed multiplier that will be used.",
+ "minimum": 0.25,
+ "maximum": 2,
+ "example": null
+ },
+ "language": {
+ "description": "Two letter ISO 639-1 language code. Use \"auto\" for auto-detection.",
+ "enum": [
+ "aa",
+ "ab",
+ "ae",
+ "af",
+ "ak",
+ "am",
+ "an",
+ "ar",
+ "as",
+ "av",
+ "ay",
+ "az",
+ "ba",
+ "be",
+ "bg",
+ "bh",
+ "bi",
+ "bm",
+ "bn",
+ "bo",
+ "br",
+ "bs",
+ "ca",
+ "ce",
+ "ch",
+ "co",
+ "cr",
+ "cs",
+ "cu",
+ "cv",
+ "cy",
+ "da",
+ "de",
+ "dv",
+ "dz",
+ "ee",
+ "el",
+ "en",
+ "eo",
+ "es",
+ "et",
+ "eu",
+ "fa",
+ "ff",
+ "fi",
+ "fj",
+ "fo",
+ "fr",
+ "fy",
+ "ga",
+ "gd",
+ "gl",
+ "gn",
+ "gu",
+ "gv",
+ "ha",
+ "he",
+ "hi",
+ "ho",
+ "hr",
+ "ht",
+ "hu",
+ "hy",
+ "hz",
+ "ia",
+ "id",
+ "ie",
+ "ig",
+ "ii",
+ "ik",
+ "io",
+ "is",
+ "it",
+ "iu",
+ "ja",
+ "jv",
+ "ka",
+ "kg",
+ "ki",
+ "kj",
+ "kk",
+ "kl",
+ "km",
+ "kn",
+ "ko",
+ "kr",
+ "ks",
+ "ku",
+ "kv",
+ "kw",
+ "ky",
+ "la",
+ "lb",
+ "lg",
+ "li",
+ "ln",
+ "lo",
+ "lt",
+ "lu",
+ "lv",
+ "mg",
+ "mh",
+ "mi",
+ "mk",
+ "ml",
+ "mn",
+ "mr",
+ "ms",
+ "mt",
+ "my",
+ "na",
+ "nb",
+ "nd",
+ "ne",
+ "ng",
+ "nl",
+ "nn",
+ "no",
+ "nr",
+ "nv",
+ "ny",
+ "oc",
+ "oj",
+ "om",
+ "or",
+ "os",
+ "pa",
+ "pi",
+ "pl",
+ "ps",
+ "pt",
+ "qu",
+ "rm",
+ "rn",
+ "ro",
+ "ru",
+ "rw",
+ "sa",
+ "sc",
+ "sd",
+ "se",
+ "sg",
+ "si",
+ "sk",
+ "sl",
+ "sm",
+ "sn",
+ "so",
+ "sq",
+ "sr",
+ "ss",
+ "st",
+ "su",
+ "sv",
+ "sw",
+ "ta",
+ "te",
+ "tg",
+ "th",
+ "ti",
+ "tk",
+ "tl",
+ "tn",
+ "to",
+ "tr",
+ "ts",
+ "tt",
+ "tw",
+ "ty",
+ "ug",
+ "uk",
+ "ur",
+ "uz",
+ "ve",
+ "vi",
+ "vo",
+ "wa",
+ "wo",
+ "xh",
+ "yi",
+ "yue",
+ "yo",
+ "za",
+ "zh",
+ "zu",
+ "auto"
+ ],
+ "example": "en",
"oneOf": [
{
- "$ref": "#/components/schemas/AnyscaleModel",
- "title": "Anyscale"
- },
- {
- "$ref": "#/components/schemas/AnthropicModel",
- "title": "Anthropic"
- },
- {
- "$ref": "#/components/schemas/CerebrasModel",
- "title": "Cerebras"
- },
- {
- "$ref": "#/components/schemas/CustomLLMModel",
- "title": "CustomLLM"
- },
- {
- "$ref": "#/components/schemas/DeepInfraModel",
- "title": "DeepInfra"
- },
- {
- "$ref": "#/components/schemas/DeepSeekModel",
- "title": "DeepSeek"
- },
- {
- "$ref": "#/components/schemas/GoogleModel",
- "title": "Google"
- },
- {
- "$ref": "#/components/schemas/GroqModel",
- "title": "Groq"
- },
- {
- "$ref": "#/components/schemas/InflectionAIModel",
- "title": "InflectionAI"
- },
- {
- "$ref": "#/components/schemas/OpenAIModel",
- "title": "OpenAI"
- },
- {
- "$ref": "#/components/schemas/OpenRouterModel",
- "title": "OpenRouter"
- },
- {
- "$ref": "#/components/schemas/PerplexityAIModel",
- "title": "PerplexityAI"
- },
- {
- "$ref": "#/components/schemas/TogetherAIModel",
- "title": "Together"
+ "type": "string",
+ "enum": [
+ "aa",
+ "ab",
+ "ae",
+ "af",
+ "ak",
+ "am",
+ "an",
+ "ar",
+ "as",
+ "av",
+ "ay",
+ "az",
+ "ba",
+ "be",
+ "bg",
+ "bh",
+ "bi",
+ "bm",
+ "bn",
+ "bo",
+ "br",
+ "bs",
+ "ca",
+ "ce",
+ "ch",
+ "co",
+ "cr",
+ "cs",
+ "cu",
+ "cv",
+ "cy",
+ "da",
+ "de",
+ "dv",
+ "dz",
+ "ee",
+ "el",
+ "en",
+ "eo",
+ "es",
+ "et",
+ "eu",
+ "fa",
+ "ff",
+ "fi",
+ "fj",
+ "fo",
+ "fr",
+ "fy",
+ "ga",
+ "gd",
+ "gl",
+ "gn",
+ "gu",
+ "gv",
+ "ha",
+ "he",
+ "hi",
+ "ho",
+ "hr",
+ "ht",
+ "hu",
+ "hy",
+ "hz",
+ "ia",
+ "id",
+ "ie",
+ "ig",
+ "ii",
+ "ik",
+ "io",
+ "is",
+ "it",
+ "iu",
+ "ja",
+ "jv",
+ "ka",
+ "kg",
+ "ki",
+ "kj",
+ "kk",
+ "kl",
+ "km",
+ "kn",
+ "ko",
+ "kr",
+ "ks",
+ "ku",
+ "kv",
+ "kw",
+ "ky",
+ "la",
+ "lb",
+ "lg",
+ "li",
+ "ln",
+ "lo",
+ "lt",
+ "lu",
+ "lv",
+ "mg",
+ "mh",
+ "mi",
+ "mk",
+ "ml",
+ "mn",
+ "mr",
+ "ms",
+ "mt",
+ "my",
+ "na",
+ "nb",
+ "nd",
+ "ne",
+ "ng",
+ "nl",
+ "nn",
+ "no",
+ "nr",
+ "nv",
+ "ny",
+ "oc",
+ "oj",
+ "om",
+ "or",
+ "os",
+ "pa",
+ "pi",
+ "pl",
+ "ps",
+ "pt",
+ "qu",
+ "rm",
+ "rn",
+ "ro",
+ "ru",
+ "rw",
+ "sa",
+ "sc",
+ "sd",
+ "se",
+ "sg",
+ "si",
+ "sk",
+ "sl",
+ "sm",
+ "sn",
+ "so",
+ "sq",
+ "sr",
+ "ss",
+ "st",
+ "su",
+ "sv",
+ "sw",
+ "ta",
+ "te",
+ "tg",
+ "th",
+ "ti",
+ "tk",
+ "tl",
+ "tn",
+ "to",
+ "tr",
+ "ts",
+ "tt",
+ "tw",
+ "ty",
+ "ug",
+ "uk",
+ "ur",
+ "uz",
+ "ve",
+ "vi",
+ "vo",
+ "wa",
+ "wo",
+ "xh",
+ "yi",
+ "yue",
+ "yo",
+ "za",
+ "zh",
+ "zu"
+ ],
+ "title": "ISO 639-1 Language Code"
},
{
- "$ref": "#/components/schemas/VapiModel",
- "title": "Vapi"
- },
+ "type": "string",
+ "enum": [
+ "auto"
+ ],
+ "title": "Auto-detect"
+ }
+ ]
+ },
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
{
- "$ref": "#/components/schemas/XaiModel",
- "title": "XAI"
+ "$ref": "#/components/schemas/ChunkPlan"
}
]
+ }
+ },
+ "required": [
+ "provider",
+ "voiceId"
+ ]
+ },
+ "FallbackNeuphonicVoice": {
+ "type": "object",
+ "properties": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
+ "provider": {
+ "type": "string",
+ "description": "This is the voice provider that will be used.",
+ "enum": [
+ "neuphonic"
+ ]
},
- "voice": {
- "description": "These are the options for the assistant's voice.",
+ "voiceId": {
+ "description": "This is the provider-specific ID that will be used.",
"oneOf": [
{
- "$ref": "#/components/schemas/AzureVoice",
- "title": "Azure"
- },
- {
- "$ref": "#/components/schemas/CartesiaVoice",
- "title": "Cartesia"
- },
- {
- "$ref": "#/components/schemas/CustomVoice",
- "title": "CustomVoice"
- },
- {
- "$ref": "#/components/schemas/DeepgramVoice",
- "title": "Deepgram"
- },
- {
- "$ref": "#/components/schemas/ElevenLabsVoice",
- "title": "ElevenLabs"
- },
- {
- "$ref": "#/components/schemas/HumeVoice",
- "title": "Hume"
- },
- {
- "$ref": "#/components/schemas/LMNTVoice",
- "title": "LMNT"
- },
- {
- "$ref": "#/components/schemas/NeuphonicVoice",
- "title": "Neuphonic"
- },
- {
- "$ref": "#/components/schemas/OpenAIVoice",
- "title": "OpenAI"
- },
- {
- "$ref": "#/components/schemas/PlayHTVoice",
- "title": "PlayHT"
+ "type": "string",
+ "enum": [],
+ "title": "Preset Voice Options"
},
{
- "$ref": "#/components/schemas/RimeAIVoice",
- "title": "RimeAI"
- },
+ "type": "string",
+ "title": "Neuphonic Voice ID"
+ }
+ ]
+ },
+ "model": {
+ "type": "string",
+ "description": "This is the model that will be used. Defaults to 'neu_fast' if not specified.",
+ "enum": [
+ "neu_hq",
+ "neu_fast"
+ ],
+ "example": "neu_fast"
+ },
+ "language": {
+ "type": "object",
+ "description": "This is the language (ISO 639-1) that is enforced for the model.",
+ "example": "en"
+ },
+ "speed": {
+ "type": "number",
+ "description": "This is the speed multiplier that will be used.",
+ "minimum": 0.25,
+ "maximum": 2,
+ "example": null
+ },
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
{
- "$ref": "#/components/schemas/SmallestAIVoice",
- "title": "SmallestAI"
- },
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
+ }
+ },
+ "required": [
+ "provider",
+ "voiceId",
+ "language"
+ ]
+ },
+ "FallbackOpenAIVoice": {
+ "type": "object",
+ "properties": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
+ "provider": {
+ "type": "string",
+ "description": "This is the voice provider that will be used.",
+ "enum": [
+ "openai"
+ ]
+ },
+ "voiceId": {
+ "description": "This is the provider-specific ID that will be used.\nPlease note that ash, ballad, coral, sage, and verse may only be used with realtime models.",
+ "oneOf": [
{
- "$ref": "#/components/schemas/TavusVoice",
- "title": "TavusVoice"
+ "type": "string",
+ "enum": [
+ "alloy",
+ "echo",
+ "fable",
+ "onyx",
+ "nova",
+ "shimmer"
+ ],
+ "title": "Preset Voice Options"
},
{
- "$ref": "#/components/schemas/VapiVoice",
- "title": "Vapi"
+ "type": "string",
+ "title": "OpenAI Voice ID"
}
- ],
- "default": {
- "provider": "playht",
- "voiceId": "jennifer"
- }
+ ]
},
- "firstMessage": {
+ "model": {
"type": "string",
- "description": "This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).\n\nIf unspecified, assistant will wait for user to speak and use the model to respond once they speak.",
- "example": "Hello! How can I help you today?"
+ "description": "This is the model that will be used for text-to-speech.",
+ "enum": [
+ "tts-1",
+ "tts-1-hd",
+ "gpt-4o-mini-tts"
+ ]
},
- "firstMessageInterruptionsEnabled": {
+ "instructions": {
+ "type": "string",
+ "description": "This is a prompt that allows you to control the voice of your generated audio.\nDoes not work with 'tts-1' or 'tts-1-hd' models.",
+ "maxLength": 10000
+ },
+ "speed": {
+ "type": "number",
+ "description": "This is the speed multiplier that will be used.",
+ "minimum": 0.25,
+ "maximum": 4,
+ "example": null
+ },
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
+ }
+ },
+ "required": [
+ "provider",
+ "voiceId"
+ ]
+ },
+ "FallbackPlayHTVoice": {
+ "type": "object",
+ "properties": {
+ "cachingEnabled": {
"type": "boolean",
- "default": false
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
},
- "firstMessageMode": {
+ "provider": {
"type": "string",
- "description": "This is the mode for the first message. Default is 'assistant-speaks-first'.\n\nUse:\n- 'assistant-speaks-first' to have the assistant speak first.\n- 'assistant-waits-for-user' to have the assistant wait for the user to speak first.\n- 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points).\n\n@default 'assistant-speaks-first'",
+ "description": "This is the voice provider that will be used.",
"enum": [
- "assistant-speaks-first",
- "assistant-speaks-first-with-model-generated-message",
- "assistant-waits-for-user"
- ],
- "example": "assistant-speaks-first"
+ "playht"
+ ]
},
- "voicemailDetection": {
- "description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.",
+ "voiceId": {
+ "description": "This is the provider-specific ID that will be used.",
"oneOf": [
{
- "$ref": "#/components/schemas/GoogleVoicemailDetectionPlan",
- "title": "Google"
- },
- {
- "$ref": "#/components/schemas/OpenAIVoicemailDetectionPlan",
- "title": "OpenAI"
+ "type": "string",
+ "enum": [
+ "jennifer",
+ "melissa",
+ "will",
+ "chris",
+ "matt",
+ "jack",
+ "ruby",
+ "davis",
+ "donna",
+ "michael"
+ ],
+ "title": "Preset Voice Options"
},
{
- "$ref": "#/components/schemas/TwilioVoicemailDetectionPlan",
- "title": "Twilio"
+ "type": "string",
+ "title": "PlayHT Voice ID"
}
]
},
- "clientMessages": {
- "type": "array",
+ "speed": {
+ "type": "number",
+ "description": "This is the speed multiplier that will be used.",
+ "minimum": 0.1,
+ "maximum": 5,
+ "example": null
+ },
+ "temperature": {
+ "type": "number",
+ "description": "A floating point number between 0, exclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used. The temperature parameter controls variance. Lower temperatures result in more predictable results, higher temperatures allow each run to vary more, so the voice may sound less like the baseline voice.",
+ "minimum": 0.1,
+ "maximum": 2,
+ "example": null
+ },
+ "emotion": {
+ "type": "string",
+ "description": "An emotion to be applied to the speech.",
"enum": [
- "conversation-update",
- "function-call",
- "function-call-result",
- "hang",
- "language-changed",
- "metadata",
- "model-output",
- "speech-update",
- "status-update",
- "transcript",
- "tool-calls",
- "tool-calls-result",
- "transfer-update",
- "user-interrupted",
- "voice-input",
- "workflow.node.started"
- ],
- "example": [
- "conversation-update",
- "function-call",
- "hang",
- "model-output",
- "speech-update",
- "status-update",
- "transfer-update",
- "transcript",
- "tool-calls",
- "user-interrupted",
- "voice-input",
- "workflow.node.started"
+ "female_happy",
+ "female_sad",
+ "female_angry",
+ "female_fearful",
+ "female_disgust",
+ "female_surprised",
+ "male_happy",
+ "male_sad",
+ "male_angry",
+ "male_fearful",
+ "male_disgust",
+ "male_surprised"
],
- "description": "These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started. You can check the shape of the messages in ClientMessage schema.",
- "items": {
- "type": "string",
- "enum": [
- "conversation-update",
- "function-call",
- "function-call-result",
- "hang",
- "language-changed",
- "metadata",
- "model-output",
- "speech-update",
- "status-update",
- "transcript",
- "tool-calls",
- "tool-calls-result",
- "transfer-update",
- "user-interrupted",
- "voice-input",
- "workflow.node.started"
- ]
- }
+ "example": null
},
- "serverMessages": {
- "type": "array",
- "enum": [
- "conversation-update",
- "end-of-call-report",
- "function-call",
- "hang",
- "language-changed",
- "language-change-detected",
- "model-output",
- "phone-call-control",
- "speech-update",
- "status-update",
- "transcript",
- "transcript[transcriptType=\"final\"]",
- "tool-calls",
- "transfer-destination-request",
- "transfer-update",
- "user-interrupted",
- "voice-input"
- ],
- "example": [
- "conversation-update",
- "end-of-call-report",
- "function-call",
- "hang",
- "speech-update",
- "status-update",
- "tool-calls",
- "transfer-destination-request",
- "user-interrupted"
- ],
- "description": "These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,user-interrupted. You can check the shape of the messages in ServerMessage schema.",
- "items": {
- "type": "string",
- "enum": [
- "conversation-update",
- "end-of-call-report",
- "function-call",
- "hang",
- "language-changed",
- "language-change-detected",
- "model-output",
- "phone-call-control",
- "speech-update",
- "status-update",
- "transcript",
- "transcript[transcriptType=\"final\"]",
- "tool-calls",
- "transfer-destination-request",
- "transfer-update",
- "user-interrupted",
- "voice-input"
- ]
- }
+ "voiceGuidance": {
+ "type": "number",
+ "description": "A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.",
+ "minimum": 1,
+ "maximum": 6,
+ "example": null
},
- "silenceTimeoutSeconds": {
+ "styleGuidance": {
"type": "number",
- "description": "How many seconds of silence to wait before ending the call. Defaults to 30.\n\n@default 30",
- "minimum": 10,
- "maximum": 3600,
- "example": 30
+ "description": "A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.",
+ "minimum": 1,
+ "maximum": 30,
+ "example": null
},
- "maxDurationSeconds": {
+ "textGuidance": {
"type": "number",
- "description": "This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.\n\n@default 600 (10 minutes)",
- "minimum": 10,
- "maximum": 43200,
- "example": 600
+ "description": "A number between 1 and 2. This number influences how closely the generated speech adheres to the input text. Use lower values to create more fluid speech, but with a higher chance of deviating from the input text. Higher numbers will make the generated speech more accurate to the input text, ensuring that the words spoken align closely with the provided text.",
+ "minimum": 1,
+ "maximum": 2,
+ "example": null
},
- "backgroundSound": {
- "description": "This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.\nYou can also provide a custom sound by providing a URL to an audio file.",
- "maxLength": 1000,
+ "model": {
+ "type": "string",
+ "description": "Playht voice model/engine to use.",
+ "enum": [
+ "PlayHT2.0",
+ "PlayHT2.0-turbo",
+ "Play3.0-mini",
+ "PlayDialog"
+ ]
+ },
+ "language": {
+ "type": "string",
+ "description": "The language to use for the speech.",
+ "enum": [
+ "afrikaans",
+ "albanian",
+ "amharic",
+ "arabic",
+ "bengali",
+ "bulgarian",
+ "catalan",
+ "croatian",
+ "czech",
+ "danish",
+ "dutch",
+ "english",
+ "french",
+ "galician",
+ "german",
+ "greek",
+ "hebrew",
+ "hindi",
+ "hungarian",
+ "indonesian",
+ "italian",
+ "japanese",
+ "korean",
+ "malay",
+ "mandarin",
+ "polish",
+ "portuguese",
+ "russian",
+ "serbian",
+ "spanish",
+ "swedish",
+ "tagalog",
+ "thai",
+ "turkish",
+ "ukrainian",
+ "urdu",
+ "xhosa"
+ ]
+ },
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
+ }
+ },
+ "required": [
+ "provider",
+ "voiceId"
+ ]
+ },
+ "FallbackRimeAIVoice": {
+ "type": "object",
+ "properties": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
+ "provider": {
+ "type": "string",
+ "description": "This is the voice provider that will be used.",
+ "enum": [
+ "rime-ai"
+ ]
+ },
+ "voiceId": {
+ "description": "This is the provider-specific ID that will be used.",
"oneOf": [
{
- "type": "enum",
+ "type": "string",
"enum": [
- "off",
- "office"
+ "abbie",
+ "allison",
+ "ally",
+ "alona",
+ "amber",
+ "ana",
+ "antoine",
+ "armon",
+ "brenda",
+ "brittany",
+ "carol",
+ "colin",
+ "courtney",
+ "elena",
+ "elliot",
+ "eva",
+ "geoff",
+ "gerald",
+ "hank",
+ "helen",
+ "hera",
+ "jen",
+ "joe",
+ "joy",
+ "juan",
+ "kendra",
+ "kendrick",
+ "kenneth",
+ "kevin",
+ "kris",
+ "linda",
+ "madison",
+ "marge",
+ "marina",
+ "marissa",
+ "marta",
+ "maya",
+ "nicholas",
+ "nyles",
+ "phil",
+ "reba",
+ "rex",
+ "rick",
+ "ritu",
+ "rob",
+ "rodney",
+ "rohan",
+ "rosco",
+ "samantha",
+ "sandy",
+ "selena",
+ "seth",
+ "sharon",
+ "stan",
+ "tamra",
+ "tanya",
+ "tibur",
+ "tj",
+ "tyler",
+ "viv",
+ "yadira",
+ "marsh",
+ "bayou",
+ "creek",
+ "brook",
+ "flower",
+ "spore",
+ "glacier",
+ "gulch",
+ "alpine",
+ "cove",
+ "lagoon",
+ "tundra",
+ "steppe",
+ "mesa",
+ "grove",
+ "rainforest",
+ "moraine",
+ "wildflower",
+ "peak",
+ "boulder",
+ "gypsum",
+ "zest"
],
- "example": "office"
+ "title": "Preset Voice Options"
},
{
"type": "string",
- "format": "uri",
- "example": "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3"
+ "title": "RimeAI Voice ID"
}
]
},
- "backgroundDenoisingEnabled": {
+ "model": {
+ "type": "string",
+ "description": "This is the model that will be used. Defaults to 'v1' when not specified.",
+ "enum": [
+ "v1",
+ "mist",
+ "mistv2"
+ ],
+ "example": "mistv2"
+ },
+ "speed": {
+ "type": "number",
+ "description": "This is the speed multiplier that will be used.",
+ "minimum": 0.1,
+ "example": null
+ },
+ "pauseBetweenBrackets": {
"type": "boolean",
- "description": "This enables filtering of noise and background speech while the user is talking.\n\nDefault `false` while in beta.\n\n@default false",
+ "description": "This is a flag that controls whether to add slight pauses using angle brackets. Example: \"Hi. <200> I'd love to have a conversation with you.\" adds a 200ms pause between the first and second sentences.",
"example": false
},
- "modelOutputInMessagesEnabled": {
+ "phonemizeBetweenBrackets": {
"type": "boolean",
- "description": "This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech.\n\nDefault `false` while in beta.\n\n@default false",
+ "description": "This is a flag that controls whether text inside brackets should be phonemized (converted to phonetic pronunciation) - Example: \"{h'El.o} World\" will pronounce \"Hello\" as expected.",
"example": false
},
- "transportConfigurations": {
- "type": "array",
- "description": "These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransportConfigurationTwilio",
- "title": "Twilio"
- }
- ]
- }
+ "reduceLatency": {
+ "type": "boolean",
+ "description": "This is a flag that controls whether to optimize for reduced latency in streaming. https://docs.rime.ai/api-reference/endpoint/websockets#param-reduce-latency",
+ "example": false
},
- "observabilityPlan": {
- "description": "This is the plan for observability configuration of assistant's calls.\nCurrently supports Langfuse for tracing and monitoring.",
+ "inlineSpeedAlpha": {
+ "type": "string",
+ "description": "This is a string that allows inline speed control using alpha notation. https://docs.rime.ai/api-reference/endpoint/websockets#param-inline-speed-alpha",
+ "example": null
+ },
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
+ }
+ },
+ "required": [
+ "provider",
+ "voiceId"
+ ]
+ },
+ "FallbackSesameVoice": {
+ "type": "object",
+ "properties": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
+ "provider": {
+ "type": "string",
+ "description": "This is the voice provider that will be used.",
+ "enum": [
+ "sesame"
+ ]
+ },
+ "voiceId": {
+ "type": "string",
+ "description": "This is the provider-specific ID that will be used.",
+ "title": "Sesame Voice ID. This should be either a name (a built-in voice) or a UUID (a custom voice)."
+ },
+ "model": {
+ "type": "string",
+ "description": "This is the model that will be used.",
+ "enum": [
+ "csm-1b"
+ ]
+ },
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChunkPlan"
+ }
+ ]
+ }
+ },
+ "required": [
+ "provider",
+ "voiceId",
+ "model"
+ ]
+ },
+ "FallbackSmallestAIVoice": {
+ "type": "object",
+ "properties": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
+ },
+ "provider": {
+ "type": "string",
+ "description": "This is the voice provider that will be used.",
+ "enum": [
+ "smallest-ai"
+ ]
+ },
+ "voiceId": {
+ "description": "This is the provider-specific ID that will be used.",
"oneOf": [
{
- "$ref": "#/components/schemas/LangfuseObservabilityPlan",
- "title": "Langfuse"
+ "type": "string",
+ "enum": [
+ "emily",
+ "jasmine",
+ "arman",
+ "james",
+ "mithali",
+ "aravind",
+ "raj",
+ "diya",
+ "raman",
+ "ananya",
+ "isha",
+ "william",
+ "aarav",
+ "monika",
+ "niharika",
+ "deepika",
+ "raghav",
+ "kajal",
+ "radhika",
+ "mansi",
+ "nisha",
+ "saurabh",
+ "pooja",
+ "saina",
+ "sanya"
+ ],
+ "title": "Preset Voice Options"
+ },
+ {
+ "type": "string",
+ "title": "Smallest AI Voice ID"
}
- ],
+ ]
+ },
+ "model": {
+ "type": "string",
+ "description": "Smallest AI voice model to use. Defaults to 'lightning' when not specified.",
+ "enum": [
+ "lightning"
+ ]
+ },
+ "speed": {
+ "type": "number",
+ "description": "This is the speed multiplier that will be used.",
+ "example": null
+ },
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
"allOf": [
{
- "$ref": "#/components/schemas/LangfuseObservabilityPlan"
+ "$ref": "#/components/schemas/ChunkPlan"
}
]
+ }
+ },
+ "required": [
+ "provider",
+ "voiceId"
+ ]
+ },
+ "FallbackTavusVoice": {
+ "type": "object",
+ "properties": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
},
- "credentials": {
- "type": "array",
- "description": "These are dynamic credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/CreateAnthropicCredentialDTO",
- "title": "AnthropicCredential"
- },
- {
- "$ref": "#/components/schemas/CreateAnyscaleCredentialDTO",
- "title": "AnyscaleCredential"
- },
- {
- "$ref": "#/components/schemas/CreateAssemblyAICredentialDTO",
- "title": "AssemblyAICredential"
- },
- {
- "$ref": "#/components/schemas/CreateAzureCredentialDTO",
- "title": "AzureCredential"
- },
- {
- "$ref": "#/components/schemas/CreateAzureOpenAICredentialDTO",
- "title": "AzureOpenAICredential"
- },
- {
- "$ref": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
- "title": "ByoSipTrunkCredential"
- },
- {
- "$ref": "#/components/schemas/CreateCartesiaCredentialDTO",
- "title": "CartesiaCredential"
- },
- {
- "$ref": "#/components/schemas/CreateCerebrasCredentialDTO",
- "title": "CerebrasCredential"
- },
- {
- "$ref": "#/components/schemas/CreateCloudflareCredentialDTO",
- "title": "CloudflareCredential"
- },
- {
- "$ref": "#/components/schemas/CreateCustomLLMCredentialDTO",
- "title": "CustomLLMCredential"
- },
- {
- "$ref": "#/components/schemas/CreateDeepgramCredentialDTO",
- "title": "DeepgramCredential"
- },
- {
- "$ref": "#/components/schemas/CreateDeepInfraCredentialDTO",
- "title": "DeepInfraCredential"
- },
- {
- "$ref": "#/components/schemas/CreateDeepSeekCredentialDTO",
- "title": "DeepSeekCredential"
- },
- {
- "$ref": "#/components/schemas/CreateElevenLabsCredentialDTO",
- "title": "ElevenLabsCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGcpCredentialDTO",
- "title": "GcpCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGladiaCredentialDTO",
- "title": "GladiaCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGoHighLevelCredentialDTO",
- "title": "GhlCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCredentialDTO",
- "title": "GoogleCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGroqCredentialDTO",
- "title": "GroqCredential"
- },
- {
- "$ref": "#/components/schemas/CreateHumeCredentialDTO",
- "title": "HumeCredential"
- },
- {
- "$ref": "#/components/schemas/CreateInflectionAICredentialDTO",
- "title": "InflectionAICredential"
- },
- {
- "$ref": "#/components/schemas/CreateLangfuseCredentialDTO",
- "title": "LangfuseCredential"
- },
- {
- "$ref": "#/components/schemas/CreateLmntCredentialDTO",
- "title": "LmntCredential"
- },
- {
- "$ref": "#/components/schemas/CreateMakeCredentialDTO",
- "title": "MakeCredential"
- },
- {
- "$ref": "#/components/schemas/CreateMistralCredentialDTO",
- "title": "MistralCredential"
- },
- {
- "$ref": "#/components/schemas/CreateNeuphonicCredentialDTO",
- "title": "NeuphonicCredential"
- },
- {
- "$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/CreateS3CredentialDTO",
- "title": "S3Credential"
- },
- {
- "$ref": "#/components/schemas/CreateSmallestAICredentialDTO",
- "title": "SmallestAICredential"
- },
- {
- "$ref": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
- "title": "SpeechmaticsCredential"
- },
- {
- "$ref": "#/components/schemas/CreateSupabaseCredentialDTO",
- "title": "SupabaseCredential"
- },
- {
- "$ref": "#/components/schemas/CreateTavusCredentialDTO",
- "title": "TavusCredential"
- },
- {
- "$ref": "#/components/schemas/CreateTogetherAICredentialDTO",
- "title": "TogetherAICredential"
- },
- {
- "$ref": "#/components/schemas/CreateTrieveCredentialDTO",
- "title": "TrieveCredential"
- },
- {
- "$ref": "#/components/schemas/CreateTwilioCredentialDTO",
- "title": "TwilioCredential"
- },
- {
- "$ref": "#/components/schemas/CreateVonageCredentialDTO",
- "title": "VonageCredential"
- },
- {
- "$ref": "#/components/schemas/CreateWebhookCredentialDTO",
- "title": "WebhookCredential"
- },
- {
- "$ref": "#/components/schemas/CreateXAiCredentialDTO",
- "title": "XAiCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
- "title": "GoogleCalendarOAuth2ClientCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
- "title": "GoogleCalendarOAuth2AuthorizationCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
- "title": "GoogleSheetsOAuth2AuthorizationCredential"
- },
- {
- "$ref": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO",
- "title": "SlackOAuth2AuthorizationCredential"
- }
- ],
- "discriminator": {
- "propertyName": "provider",
- "mapping": {
- "11labs": "#/components/schemas/CreateElevenLabsCredentialDTO",
- "anthropic": "#/components/schemas/CreateAnthropicCredentialDTO",
- "anyscale": "#/components/schemas/CreateAnyscaleCredentialDTO",
- "assembly-ai": "#/components/schemas/CreateAssemblyAICredentialDTO",
- "azure-openai": "#/components/schemas/CreateAzureOpenAICredentialDTO",
- "azure": "#/components/schemas/CreateAzureCredentialDTO",
- "byo-sip-trunk": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
- "cartesia": "#/components/schemas/CreateCartesiaCredentialDTO",
- "cerebras": "#/components/schemas/CreateCerebrasCredentialDTO",
- "cloudflare": "#/components/schemas/CreateCloudflareCredentialDTO",
- "custom-llm": "#/components/schemas/CreateCustomLLMCredentialDTO",
- "deepgram": "#/components/schemas/CreateDeepgramCredentialDTO",
- "deepinfra": "#/components/schemas/CreateDeepInfraCredentialDTO",
- "deep-seek": "#/components/schemas/CreateDeepSeekCredentialDTO",
- "gcp": "#/components/schemas/CreateGcpCredentialDTO",
- "gladia": "#/components/schemas/CreateGladiaCredentialDTO",
- "gohighlevel": "#/components/schemas/CreateGoHighLevelCredentialDTO",
- "google": "#/components/schemas/CreateGoogleCredentialDTO",
- "groq": "#/components/schemas/CreateGroqCredentialDTO",
- "inflection-ai": "#/components/schemas/CreateInflectionAICredentialDTO",
- "langfuse": "#/components/schemas/CreateLangfuseCredentialDTO",
- "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",
- "s3": "#/components/schemas/CreateS3CredentialDTO",
- "supabase": "#/components/schemas/CreateSupabaseCredentialDTO",
- "smallest-ai": "#/components/schemas/CreateSmallestAICredentialDTO",
- "tavus": "#/components/schemas/CreateTavusCredentialDTO",
- "together-ai": "#/components/schemas/CreateTogetherAICredentialDTO",
- "twilio": "#/components/schemas/CreateTwilioCredentialDTO",
- "vonage": "#/components/schemas/CreateVonageCredentialDTO",
- "webhook": "#/components/schemas/CreateWebhookCredentialDTO",
- "xai": "#/components/schemas/CreateXAiCredentialDTO",
- "neuphonic": "#/components/schemas/CreateNeuphonicCredentialDTO",
- "hume": "#/components/schemas/CreateHumeCredentialDTO",
- "mistral": "#/components/schemas/CreateMistralCredentialDTO",
- "speechmatics": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
- "trieve": "#/components/schemas/CreateTrieveCredentialDTO",
- "google.calendar.oauth2-client": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
- "google.calendar.oauth2-authorization": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
- "google.sheets.oauth2-authorization": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
- "slack.oauth2-authorization": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO"
- }
+ "provider": {
+ "type": "string",
+ "description": "This is the voice provider that will be used.",
+ "enum": [
+ "tavus"
+ ]
+ },
+ "voiceId": {
+ "description": "This is the provider-specific ID that will be used.",
+ "oneOf": [
+ {
+ "type": "string",
+ "enum": [
+ "r52da2535a"
+ ],
+ "title": "Preset Voice Options"
+ },
+ {
+ "type": "string",
+ "title": "Tavus Voice ID"
}
- }
+ ]
},
- "name": {
+ "personaId": {
"type": "string",
- "description": "This is the name of the assistant.\n\nThis is required when you want to transfer between assistants in a call.",
- "maxLength": 40
+ "description": "This is the unique identifier for the persona that the replica will use in the conversation."
},
- "voicemailMessage": {
+ "callbackUrl": {
"type": "string",
- "description": "This is the message that the assistant will say if the call is forwarded to voicemail.\n\nIf unspecified, it will hang up.",
- "maxLength": 1000
+ "description": "This is the url that will receive webhooks with updates regarding the conversation state."
},
- "endCallMessage": {
+ "conversationName": {
"type": "string",
- "description": "This is the message that the assistant will say if it ends the call.\n\nIf unspecified, it will hang up without saying anything.",
- "maxLength": 1000
- },
- "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": 140,
- "minLength": 2
- }
+ "description": "This is the name for the conversation."
},
- "compliancePlan": {
- "$ref": "#/components/schemas/CompliancePlan"
+ "conversationalContext": {
+ "type": "string",
+ "description": "This is the context that will be appended to any context provided in the persona, if one is provided."
},
- "metadata": {
- "type": "object",
- "description": "This is for metadata you want to store on the assistant."
+ "customGreeting": {
+ "type": "string",
+ "description": "This is the custom greeting that the replica will give once a participant joines the conversation."
},
- "analysisPlan": {
- "description": "This is the plan for analysis of assistant's calls. Stored in `call.analysis`.",
+ "properties": {
+ "description": "These are optional properties used to customize the conversation.",
"allOf": [
{
- "$ref": "#/components/schemas/AnalysisPlan"
+ "$ref": "#/components/schemas/TavusConversationProperties"
}
]
},
- "artifactPlan": {
- "description": "This is the plan for artifacts generated during assistant's calls. Stored in `call.artifact`.\n\nNote: `recordingEnabled` is currently at the root level. It will be moved to `artifactPlan` in the future, but will remain backwards compatible.",
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
"allOf": [
{
- "$ref": "#/components/schemas/ArtifactPlan"
+ "$ref": "#/components/schemas/ChunkPlan"
}
]
+ }
+ },
+ "required": [
+ "provider",
+ "voiceId"
+ ]
+ },
+ "FallbackVapiVoice": {
+ "type": "object",
+ "properties": {
+ "cachingEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle voice caching for the assistant.",
+ "example": true,
+ "default": true
},
- "messagePlan": {
- "description": "This is the plan for static predefined messages that can be spoken by the assistant during the call, like `idleMessages`.\n\nNote: `firstMessage`, `voicemailMessage`, and `endCallMessage` are currently at the root level. They will be moved to `messagePlan` in the future, but will remain backwards compatible.",
- "allOf": [
- {
- "$ref": "#/components/schemas/MessagePlan"
- }
+ "provider": {
+ "type": "string",
+ "description": "This is the voice provider that will be used.",
+ "enum": [
+ "vapi"
]
},
- "startSpeakingPlan": {
- "description": "This is the plan for when the assistant should start talking.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to start talking after the customer is done speaking.\n- The assistant is too fast to start talking after the customer is done speaking.\n- The assistant is so fast that it's actually interrupting the customer.",
- "allOf": [
- {
- "$ref": "#/components/schemas/StartSpeakingPlan"
- }
+ "voiceId": {
+ "type": "string",
+ "description": "The voices provided by Vapi",
+ "enum": [
+ "Elliot",
+ "Kylie",
+ "Rohan",
+ "Lily",
+ "Savannah",
+ "Hana",
+ "Neha",
+ "Cole",
+ "Harry",
+ "Paige",
+ "Spencer"
]
},
- "stopSpeakingPlan": {
- "description": "This is the plan for when assistant should stop talking on customer interruption.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to recognize customer's interruption.\n- The assistant is too fast to recognize customer's interruption.\n- The assistant is getting interrupted by phrases that are just acknowledgments.\n- The assistant is getting interrupted by background noises.\n- The assistant is not properly stopping -- it starts talking right after getting interrupted.",
+ "speed": {
+ "type": "number",
+ "description": "This is the speed multiplier that will be used.\n\n@default 1",
+ "minimum": 0.25,
+ "maximum": 2,
+ "default": 1
+ },
+ "chunkPlan": {
+ "description": "This is the plan for chunking the model output before it is sent to the voice provider.",
"allOf": [
{
- "$ref": "#/components/schemas/StopSpeakingPlan"
+ "$ref": "#/components/schemas/ChunkPlan"
}
]
+ }
+ },
+ "required": [
+ "provider",
+ "voiceId"
+ ]
+ },
+ "TransportConfigurationTwilio": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "twilio"
+ ]
},
- "monitorPlan": {
- "description": "This is the plan for real-time monitoring of the assistant's calls.\n\nUsage:\n- To enable live listening of the assistant's calls, set `monitorPlan.listenEnabled` to `true`.\n- To enable live control of the assistant's calls, set `monitorPlan.controlEnabled` to `true`.\n\nNote, `serverMessages`, `clientMessages`, `serverUrl` and `serverUrlSecret` are currently at the root level but will be moved to `monitorPlan` in the future. Will remain backwards compatible",
- "allOf": [
- {
- "$ref": "#/components/schemas/MonitorPlan"
- }
+ "timeout": {
+ "type": "number",
+ "description": "The integer number of seconds that we should allow the phone to ring before assuming there is no answer.\nThe default is `60` seconds and the maximum is `600` seconds.\nFor some call flows, we will add a 5-second buffer to the timeout value you provide.\nFor this reason, a timeout value of 10 seconds could result in an actual timeout closer to 15 seconds.\nYou can set this to a short time, such as `15` seconds, to hang up before reaching an answering machine or voicemail.\n\n@default 60",
+ "minimum": 1,
+ "maximum": 600,
+ "example": 60
+ },
+ "record": {
+ "type": "boolean",
+ "description": "Whether to record the call.\nCan be `true` to record the phone call, or `false` to not.\nThe default is `false`.\n\n@default false",
+ "example": false
+ },
+ "recordingChannels": {
+ "type": "string",
+ "description": "The number of channels in the final recording.\nCan be: `mono` or `dual`.\nThe default is `mono`.\n`mono` records both legs of the call in a single channel of the recording file.\n`dual` records each leg to a separate channel of the recording file.\nThe first channel of a dual-channel recording contains the parent call and the second channel contains the child call.\n\n@default 'mono'",
+ "enum": [
+ "mono",
+ "dual"
+ ],
+ "example": "mono"
+ }
+ },
+ "required": [
+ "provider"
+ ]
+ },
+ "CreateAnthropicCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "anthropic"
]
},
- "credentialIds": {
- "description": "These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this.",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "apiKey": {
+ "type": "string",
+ "maxLength": 10000,
+ "description": "This is not returned in the API."
},
- "server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server.url\n2. phoneNumber.serverUrl\n3. org.serverUrl",
- "allOf": [
- {
- "$ref": "#/components/schemas/Server"
- }
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "apiKey"
+ ]
+ },
+ "CreateAnyscaleCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "anyscale"
]
},
- "hooks": {
- "description": "This is a set of actions that will be performed on certain events.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AssistantHooks"
- }
+ "apiKey": {
+ "type": "string",
+ "maxLength": 10000,
+ "description": "This is not returned in the API."
},
- "keypadInputPlan": {
- "$ref": "#/components/schemas/KeypadInputPlan"
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
}
- }
+ },
+ "required": [
+ "provider",
+ "apiKey"
+ ]
},
- "AssistantOverrides": {
+ "CreateAssemblyAICredentialDTO": {
"type": "object",
"properties": {
- "transcriber": {
- "description": "These are the options for the assistant's transcriber.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/AssemblyAITranscriber",
- "title": "AssemblyAI"
- },
- {
- "$ref": "#/components/schemas/AzureSpeechTranscriber",
- "title": "Azure"
- },
- {
- "$ref": "#/components/schemas/CustomTranscriber",
- "title": "CustomTranscriber"
- },
- {
- "$ref": "#/components/schemas/DeepgramTranscriber",
- "title": "Deepgram"
- },
- {
- "$ref": "#/components/schemas/ElevenLabsTranscriber",
- "title": "ElevenLabs"
- },
- {
- "$ref": "#/components/schemas/GladiaTranscriber",
- "title": "Gladia"
- },
- {
- "$ref": "#/components/schemas/SpeechmaticsTranscriber",
- "title": "Speechmatics"
- },
- {
- "$ref": "#/components/schemas/TalkscriberTranscriber",
- "title": "Talkscriber"
- },
- {
- "$ref": "#/components/schemas/GoogleTranscriber",
- "title": "Google"
- },
- {
- "$ref": "#/components/schemas/OpenAITranscriber",
- "title": "OpenAI"
- }
+ "provider": {
+ "type": "string",
+ "enum": [
+ "assembly-ai"
]
},
- "model": {
- "description": "These are the options for the assistant's LLM.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/AnyscaleModel",
- "title": "Anyscale"
- },
- {
- "$ref": "#/components/schemas/AnthropicModel",
- "title": "Anthropic"
- },
- {
- "$ref": "#/components/schemas/CerebrasModel",
- "title": "Cerebras"
- },
- {
- "$ref": "#/components/schemas/CustomLLMModel",
- "title": "CustomLLM"
- },
- {
- "$ref": "#/components/schemas/DeepInfraModel",
- "title": "DeepInfra"
- },
- {
- "$ref": "#/components/schemas/DeepSeekModel",
- "title": "DeepSeek"
- },
- {
- "$ref": "#/components/schemas/GoogleModel",
- "title": "Google"
- },
- {
- "$ref": "#/components/schemas/GroqModel",
- "title": "Groq"
- },
- {
- "$ref": "#/components/schemas/InflectionAIModel",
- "title": "InflectionAI"
- },
- {
- "$ref": "#/components/schemas/OpenAIModel",
- "title": "OpenAI"
- },
- {
- "$ref": "#/components/schemas/OpenRouterModel",
- "title": "OpenRouter"
- },
- {
- "$ref": "#/components/schemas/PerplexityAIModel",
- "title": "PerplexityAI"
- },
- {
- "$ref": "#/components/schemas/TogetherAIModel",
- "title": "Together"
- },
- {
- "$ref": "#/components/schemas/VapiModel",
- "title": "Vapi"
- },
- {
- "$ref": "#/components/schemas/XaiModel",
- "title": "XAI"
- }
- ]
+ "apiKey": {
+ "type": "string",
+ "description": "This is not returned in the API."
},
- "voice": {
- "description": "These are the options for the assistant's voice.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/AzureVoice",
- "title": "Azure"
- },
- {
- "$ref": "#/components/schemas/CartesiaVoice",
- "title": "Cartesia"
- },
- {
- "$ref": "#/components/schemas/CustomVoice",
- "title": "CustomVoice"
- },
- {
- "$ref": "#/components/schemas/DeepgramVoice",
- "title": "Deepgram"
- },
- {
- "$ref": "#/components/schemas/ElevenLabsVoice",
- "title": "ElevenLabs"
- },
- {
- "$ref": "#/components/schemas/HumeVoice",
- "title": "Hume"
- },
- {
- "$ref": "#/components/schemas/LMNTVoice",
- "title": "LMNT"
- },
- {
- "$ref": "#/components/schemas/NeuphonicVoice",
- "title": "Neuphonic"
- },
- {
- "$ref": "#/components/schemas/OpenAIVoice",
- "title": "OpenAI"
- },
- {
- "$ref": "#/components/schemas/PlayHTVoice",
- "title": "PlayHT"
- },
- {
- "$ref": "#/components/schemas/RimeAIVoice",
- "title": "RimeAI"
- },
- {
- "$ref": "#/components/schemas/SmallestAIVoice",
- "title": "SmallestAI"
- },
- {
- "$ref": "#/components/schemas/TavusVoice",
- "title": "TavusVoice"
- },
- {
- "$ref": "#/components/schemas/VapiVoice",
- "title": "Vapi"
- }
- ],
- "default": {
- "provider": "playht",
- "voiceId": "jennifer"
- }
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "apiKey"
+ ]
+ },
+ "AzureBlobStorageBucketPlan": {
+ "type": "object",
+ "properties": {
+ "connectionString": {
+ "type": "string",
+ "description": "This is the blob storage connection string for the Azure resource."
},
- "firstMessage": {
+ "containerName": {
"type": "string",
- "description": "This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).\n\nIf unspecified, assistant will wait for user to speak and use the model to respond once they speak.",
- "example": "Hello! How can I help you today?"
+ "description": "This is the container name for the Azure blob storage."
},
- "firstMessageInterruptionsEnabled": {
- "type": "boolean",
- "default": false
+ "path": {
+ "type": "string",
+ "description": "This is the path where call artifacts will be stored.\n\nUsage:\n- To store call artifacts in a specific folder, set this to the full path. Eg. \"/folder-name1/folder-name2\".\n- To store call artifacts in the root of the bucket, leave this blank.\n\n@default \"/\""
+ }
+ },
+ "required": [
+ "connectionString",
+ "containerName"
+ ]
+ },
+ "CreateAzureCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "azure"
+ ]
},
- "firstMessageMode": {
+ "service": {
"type": "string",
- "description": "This is the mode for the first message. Default is 'assistant-speaks-first'.\n\nUse:\n- 'assistant-speaks-first' to have the assistant speak first.\n- 'assistant-waits-for-user' to have the assistant wait for the user to speak first.\n- 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points).\n\n@default 'assistant-speaks-first'",
+ "description": "This is the service being used in Azure.",
"enum": [
- "assistant-speaks-first",
- "assistant-speaks-first-with-model-generated-message",
- "assistant-waits-for-user"
+ "speech",
+ "blob_storage"
],
- "example": "assistant-speaks-first"
+ "default": "speech"
},
- "voicemailDetection": {
- "description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/GoogleVoicemailDetectionPlan",
- "title": "Google"
- },
- {
- "$ref": "#/components/schemas/OpenAIVoicemailDetectionPlan",
- "title": "OpenAI"
- },
+ "region": {
+ "type": "string",
+ "description": "This is the region of the Azure resource.",
+ "enum": [
+ "australia",
+ "canadaeast",
+ "canadacentral",
+ "eastus2",
+ "eastus",
+ "france",
+ "india",
+ "japaneast",
+ "japanwest",
+ "uaenorth",
+ "northcentralus",
+ "norway",
+ "southcentralus",
+ "swedencentral",
+ "switzerland",
+ "uk",
+ "westus",
+ "westus3"
+ ]
+ },
+ "apiKey": {
+ "type": "string",
+ "description": "This is not returned in the API.",
+ "maxLength": 10000
+ },
+ "fallbackIndex": {
+ "type": "number",
+ "minimum": 1,
+ "description": "This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order."
+ },
+ "bucketPlan": {
+ "description": "This is the bucket plan that can be provided to store call artifacts in Azure Blob Storage.",
+ "allOf": [
{
- "$ref": "#/components/schemas/TwilioVoicemailDetectionPlan",
- "title": "Twilio"
+ "$ref": "#/components/schemas/AzureBlobStorageBucketPlan"
}
]
},
- "clientMessages": {
- "type": "array",
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "service"
+ ]
+ },
+ "CreateAzureOpenAICredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
"enum": [
- "conversation-update",
- "function-call",
- "function-call-result",
- "hang",
- "language-changed",
- "metadata",
- "model-output",
- "speech-update",
- "status-update",
- "transcript",
- "tool-calls",
- "tool-calls-result",
- "transfer-update",
- "user-interrupted",
- "voice-input",
- "workflow.node.started"
- ],
- "example": [
- "conversation-update",
- "function-call",
- "hang",
- "model-output",
- "speech-update",
- "status-update",
- "transfer-update",
- "transcript",
- "tool-calls",
- "user-interrupted",
- "voice-input",
- "workflow.node.started"
- ],
- "description": "These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started. You can check the shape of the messages in ClientMessage schema.",
- "items": {
- "type": "string",
- "enum": [
- "conversation-update",
- "function-call",
- "function-call-result",
- "hang",
- "language-changed",
- "metadata",
- "model-output",
- "speech-update",
- "status-update",
- "transcript",
- "tool-calls",
- "tool-calls-result",
- "transfer-update",
- "user-interrupted",
- "voice-input",
- "workflow.node.started"
- ]
- }
+ "azure-openai"
+ ]
},
- "serverMessages": {
+ "region": {
+ "type": "string",
+ "enum": [
+ "australia",
+ "canadaeast",
+ "canadacentral",
+ "eastus2",
+ "eastus",
+ "france",
+ "india",
+ "japaneast",
+ "japanwest",
+ "uaenorth",
+ "northcentralus",
+ "norway",
+ "southcentralus",
+ "swedencentral",
+ "switzerland",
+ "uk",
+ "westus",
+ "westus3"
+ ]
+ },
+ "models": {
"type": "array",
"enum": [
- "conversation-update",
- "end-of-call-report",
- "function-call",
- "hang",
- "language-changed",
- "language-change-detected",
- "model-output",
- "phone-call-control",
- "speech-update",
- "status-update",
- "transcript",
- "transcript[transcriptType=\"final\"]",
- "tool-calls",
- "transfer-destination-request",
- "transfer-update",
- "user-interrupted",
- "voice-input"
+ "gpt-4.1-2025-04-14",
+ "gpt-4.1-mini-2025-04-14",
+ "gpt-4.1-nano-2025-04-14",
+ "gpt-4o-2024-11-20",
+ "gpt-4o-2024-08-06",
+ "gpt-4o-2024-05-13",
+ "gpt-4o-mini-2024-07-18",
+ "gpt-4-turbo-2024-04-09",
+ "gpt-4-0125-preview",
+ "gpt-4-1106-preview",
+ "gpt-4-0613",
+ "gpt-35-turbo-0125",
+ "gpt-35-turbo-1106"
],
"example": [
- "conversation-update",
- "end-of-call-report",
- "function-call",
- "hang",
- "speech-update",
- "status-update",
- "tool-calls",
- "transfer-destination-request",
- "user-interrupted"
+ "gpt-4-0125-preview",
+ "gpt-4-0613"
],
- "description": "These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,user-interrupted. You can check the shape of the messages in ServerMessage schema.",
"items": {
"type": "string",
"enum": [
- "conversation-update",
- "end-of-call-report",
- "function-call",
- "hang",
- "language-changed",
- "language-change-detected",
- "model-output",
- "phone-call-control",
- "speech-update",
- "status-update",
- "transcript",
- "transcript[transcriptType=\"final\"]",
- "tool-calls",
- "transfer-destination-request",
- "transfer-update",
- "user-interrupted",
- "voice-input"
+ "gpt-4.1-2025-04-14",
+ "gpt-4.1-mini-2025-04-14",
+ "gpt-4.1-nano-2025-04-14",
+ "gpt-4o-2024-11-20",
+ "gpt-4o-2024-08-06",
+ "gpt-4o-2024-05-13",
+ "gpt-4o-mini-2024-07-18",
+ "gpt-4-turbo-2024-04-09",
+ "gpt-4-0125-preview",
+ "gpt-4-1106-preview",
+ "gpt-4-0613",
+ "gpt-35-turbo-0125",
+ "gpt-35-turbo-1106"
]
}
},
- "silenceTimeoutSeconds": {
+ "openAIKey": {
+ "type": "string",
+ "maxLength": 10000,
+ "description": "This is not returned in the API."
+ },
+ "ocpApimSubscriptionKey": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "openAIEndpoint": {
+ "type": "string",
+ "maxLength": 10000
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "region",
+ "models",
+ "openAIKey",
+ "openAIEndpoint"
+ ]
+ },
+ "SipTrunkGateway": {
+ "type": "object",
+ "properties": {
+ "ip": {
+ "type": "string",
+ "description": "This is the address of the gateway. It can be an IPv4 address like 1.1.1.1 or a fully qualified domain name like my-sip-trunk.pstn.twilio.com."
+ },
+ "port": {
"type": "number",
- "description": "How many seconds of silence to wait before ending the call. Defaults to 30.\n\n@default 30",
- "minimum": 10,
- "maximum": 3600,
- "example": 30
+ "description": "This is the port number of the gateway. Default is 5060.\n\n@default 5060",
+ "minimum": 1,
+ "maximum": 65535
},
- "maxDurationSeconds": {
+ "netmask": {
"type": "number",
- "description": "This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.\n\n@default 600 (10 minutes)",
- "minimum": 10,
- "maximum": 43200,
- "example": 600
+ "description": "This is the netmask of the gateway. Defaults to 32.\n\n@default 32",
+ "minimum": 24,
+ "maximum": 32
},
- "backgroundSound": {
- "description": "This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.\nYou can also provide a custom sound by providing a URL to an audio file.",
- "maxLength": 1000,
- "oneOf": [
- {
- "type": "enum",
- "enum": [
- "off",
- "office"
- ],
- "example": "office"
- },
- {
- "type": "string",
- "format": "uri",
- "example": "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3"
- }
- ]
+ "inboundEnabled": {
+ "type": "boolean",
+ "description": "This is whether inbound calls are allowed from this gateway. Default is true.\n\n@default true"
},
- "backgroundDenoisingEnabled": {
+ "outboundEnabled": {
"type": "boolean",
- "description": "This enables filtering of noise and background speech while the user is talking.\n\nDefault `false` while in beta.\n\n@default false",
- "example": false
+ "description": "This is whether outbound calls should be sent to this gateway. Default is true.\n\nNote, if netmask is less than 32, it doesn't affect the outbound IPs that are tried. 1 attempt is made to `ip:port`.\n\n@default true"
},
- "modelOutputInMessagesEnabled": {
+ "outboundProtocol": {
+ "type": "string",
+ "description": "This is the protocol to use for SIP signaling outbound calls. Default is udp.\n\n@default udp",
+ "enum": [
+ "tls/srtp",
+ "tcp",
+ "tls",
+ "udp"
+ ]
+ },
+ "optionsPingEnabled": {
"type": "boolean",
- "description": "This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech.\n\nDefault `false` while in beta.\n\n@default false",
- "example": false
+ "description": "This is whether to send options ping to the gateway. This can be used to check if the gateway is reachable. Default is false.\n\nThis is useful for high availability setups where you want to check if the gateway is reachable before routing calls to it. Note, if no gateway for a trunk is reachable, outbound calls will be rejected.\n\n@default false"
+ }
+ },
+ "required": [
+ "ip"
+ ]
+ },
+ "SipTrunkOutboundSipRegisterPlan": {
+ "type": "object",
+ "properties": {
+ "domain": {
+ "type": "string"
},
- "transportConfigurations": {
- "type": "array",
- "description": "These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransportConfigurationTwilio",
- "title": "Twilio"
- }
- ]
- }
+ "username": {
+ "type": "string"
},
- "observabilityPlan": {
- "description": "This is the plan for observability configuration of assistant's calls.\nCurrently supports Langfuse for tracing and monitoring.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/LangfuseObservabilityPlan",
- "title": "Langfuse"
- }
- ],
+ "realm": {
+ "type": "string"
+ }
+ }
+ },
+ "SipTrunkOutboundAuthenticationPlan": {
+ "type": "object",
+ "properties": {
+ "authPassword": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "authUsername": {
+ "type": "string"
+ },
+ "sipRegisterPlan": {
+ "description": "This can be used to configure if SIP register is required by the SIP trunk. If not provided, no SIP registration will be attempted.",
"allOf": [
{
- "$ref": "#/components/schemas/LangfuseObservabilityPlan"
+ "$ref": "#/components/schemas/SipTrunkOutboundSipRegisterPlan"
}
]
- },
- "credentials": {
- "type": "array",
- "description": "These are dynamic credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/CreateAnthropicCredentialDTO",
- "title": "AnthropicCredential"
- },
- {
- "$ref": "#/components/schemas/CreateAnyscaleCredentialDTO",
- "title": "AnyscaleCredential"
- },
- {
- "$ref": "#/components/schemas/CreateAssemblyAICredentialDTO",
- "title": "AssemblyAICredential"
- },
- {
- "$ref": "#/components/schemas/CreateAzureCredentialDTO",
- "title": "AzureCredential"
- },
- {
- "$ref": "#/components/schemas/CreateAzureOpenAICredentialDTO",
- "title": "AzureOpenAICredential"
- },
- {
- "$ref": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
- "title": "ByoSipTrunkCredential"
- },
- {
- "$ref": "#/components/schemas/CreateCartesiaCredentialDTO",
- "title": "CartesiaCredential"
- },
- {
- "$ref": "#/components/schemas/CreateCerebrasCredentialDTO",
- "title": "CerebrasCredential"
- },
- {
- "$ref": "#/components/schemas/CreateCloudflareCredentialDTO",
- "title": "CloudflareCredential"
- },
- {
- "$ref": "#/components/schemas/CreateCustomLLMCredentialDTO",
- "title": "CustomLLMCredential"
- },
- {
- "$ref": "#/components/schemas/CreateDeepgramCredentialDTO",
- "title": "DeepgramCredential"
- },
- {
- "$ref": "#/components/schemas/CreateDeepInfraCredentialDTO",
- "title": "DeepInfraCredential"
- },
- {
- "$ref": "#/components/schemas/CreateDeepSeekCredentialDTO",
- "title": "DeepSeekCredential"
- },
- {
- "$ref": "#/components/schemas/CreateElevenLabsCredentialDTO",
- "title": "ElevenLabsCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGcpCredentialDTO",
- "title": "GcpCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGladiaCredentialDTO",
- "title": "GladiaCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGoHighLevelCredentialDTO",
- "title": "GhlCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCredentialDTO",
- "title": "GoogleCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGroqCredentialDTO",
- "title": "GroqCredential"
- },
- {
- "$ref": "#/components/schemas/CreateHumeCredentialDTO",
- "title": "HumeCredential"
- },
- {
- "$ref": "#/components/schemas/CreateInflectionAICredentialDTO",
- "title": "InflectionAICredential"
- },
- {
- "$ref": "#/components/schemas/CreateLangfuseCredentialDTO",
- "title": "LangfuseCredential"
- },
- {
- "$ref": "#/components/schemas/CreateLmntCredentialDTO",
- "title": "LmntCredential"
- },
- {
- "$ref": "#/components/schemas/CreateMakeCredentialDTO",
- "title": "MakeCredential"
- },
- {
- "$ref": "#/components/schemas/CreateMistralCredentialDTO",
- "title": "MistralCredential"
- },
- {
- "$ref": "#/components/schemas/CreateNeuphonicCredentialDTO",
- "title": "NeuphonicCredential"
- },
- {
- "$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/CreateS3CredentialDTO",
- "title": "S3Credential"
- },
- {
- "$ref": "#/components/schemas/CreateSmallestAICredentialDTO",
- "title": "SmallestAICredential"
- },
- {
- "$ref": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
- "title": "SpeechmaticsCredential"
- },
- {
- "$ref": "#/components/schemas/CreateSupabaseCredentialDTO",
- "title": "SupabaseCredential"
- },
- {
- "$ref": "#/components/schemas/CreateTavusCredentialDTO",
- "title": "TavusCredential"
- },
- {
- "$ref": "#/components/schemas/CreateTogetherAICredentialDTO",
- "title": "TogetherAICredential"
- },
- {
- "$ref": "#/components/schemas/CreateTrieveCredentialDTO",
- "title": "TrieveCredential"
- },
- {
- "$ref": "#/components/schemas/CreateTwilioCredentialDTO",
- "title": "TwilioCredential"
- },
- {
- "$ref": "#/components/schemas/CreateVonageCredentialDTO",
- "title": "VonageCredential"
- },
- {
- "$ref": "#/components/schemas/CreateWebhookCredentialDTO",
- "title": "WebhookCredential"
- },
- {
- "$ref": "#/components/schemas/CreateXAiCredentialDTO",
- "title": "XAiCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
- "title": "GoogleCalendarOAuth2ClientCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
- "title": "GoogleCalendarOAuth2AuthorizationCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
- "title": "GoogleSheetsOAuth2AuthorizationCredential"
- },
- {
- "$ref": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO",
- "title": "SlackOAuth2AuthorizationCredential"
- }
- ],
- "discriminator": {
- "propertyName": "provider",
- "mapping": {
- "11labs": "#/components/schemas/CreateElevenLabsCredentialDTO",
- "anthropic": "#/components/schemas/CreateAnthropicCredentialDTO",
- "anyscale": "#/components/schemas/CreateAnyscaleCredentialDTO",
- "assembly-ai": "#/components/schemas/CreateAssemblyAICredentialDTO",
- "azure-openai": "#/components/schemas/CreateAzureOpenAICredentialDTO",
- "azure": "#/components/schemas/CreateAzureCredentialDTO",
- "byo-sip-trunk": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
- "cartesia": "#/components/schemas/CreateCartesiaCredentialDTO",
- "cerebras": "#/components/schemas/CreateCerebrasCredentialDTO",
- "cloudflare": "#/components/schemas/CreateCloudflareCredentialDTO",
- "custom-llm": "#/components/schemas/CreateCustomLLMCredentialDTO",
- "deepgram": "#/components/schemas/CreateDeepgramCredentialDTO",
- "deepinfra": "#/components/schemas/CreateDeepInfraCredentialDTO",
- "deep-seek": "#/components/schemas/CreateDeepSeekCredentialDTO",
- "gcp": "#/components/schemas/CreateGcpCredentialDTO",
- "gladia": "#/components/schemas/CreateGladiaCredentialDTO",
- "gohighlevel": "#/components/schemas/CreateGoHighLevelCredentialDTO",
- "google": "#/components/schemas/CreateGoogleCredentialDTO",
- "groq": "#/components/schemas/CreateGroqCredentialDTO",
- "inflection-ai": "#/components/schemas/CreateInflectionAICredentialDTO",
- "langfuse": "#/components/schemas/CreateLangfuseCredentialDTO",
- "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",
- "s3": "#/components/schemas/CreateS3CredentialDTO",
- "supabase": "#/components/schemas/CreateSupabaseCredentialDTO",
- "smallest-ai": "#/components/schemas/CreateSmallestAICredentialDTO",
- "tavus": "#/components/schemas/CreateTavusCredentialDTO",
- "together-ai": "#/components/schemas/CreateTogetherAICredentialDTO",
- "twilio": "#/components/schemas/CreateTwilioCredentialDTO",
- "vonage": "#/components/schemas/CreateVonageCredentialDTO",
- "webhook": "#/components/schemas/CreateWebhookCredentialDTO",
- "xai": "#/components/schemas/CreateXAiCredentialDTO",
- "neuphonic": "#/components/schemas/CreateNeuphonicCredentialDTO",
- "hume": "#/components/schemas/CreateHumeCredentialDTO",
- "mistral": "#/components/schemas/CreateMistralCredentialDTO",
- "speechmatics": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
- "trieve": "#/components/schemas/CreateTrieveCredentialDTO",
- "google.calendar.oauth2-client": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
- "google.calendar.oauth2-authorization": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
- "google.sheets.oauth2-authorization": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
- "slack.oauth2-authorization": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO"
- }
- }
- }
- },
- "variableValues": {
- "type": "object",
- "description": "These are values that will be used to replace the template variables in the assistant messages and other text-based fields.\nThis uses LiquidJS syntax. https://liquidjs.com/tutorials/intro-to-liquid.html\n\nSo for example, `{{ name }}` will be replaced with the value of `name` in `variableValues`.\n`{{\"now\" | date: \"%b %d, %Y, %I:%M %p\", \"America/New_York\"}}` will be replaced with the current date and time in New York.\n Some VAPI reserved defaults:\n - *customer* - the customer 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.",
- "maxLength": 40
- },
- "voicemailMessage": {
- "type": "string",
- "description": "This is the message that the assistant will say if the call is forwarded to voicemail.\n\nIf unspecified, it will hang up.",
- "maxLength": 1000
- },
- "endCallMessage": {
+ }
+ }
+ },
+ "SbcConfiguration": {
+ "type": "object",
+ "properties": {}
+ },
+ "CreateByoSipTrunkCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
"type": "string",
- "description": "This is the message that the assistant will say if it ends the call.\n\nIf unspecified, it will hang up without saying anything.",
- "maxLength": 1000
+ "description": "This can be used to bring your own SIP trunks or to connect to a Carrier.",
+ "enum": [
+ "byo-sip-trunk"
+ ]
},
- "endCallPhrases": {
- "description": "This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.",
+ "gateways": {
+ "description": "This is the list of SIP trunk's gateways.",
"type": "array",
"items": {
- "type": "string",
- "maxLength": 140,
- "minLength": 2
+ "$ref": "#/components/schemas/SipTrunkGateway"
}
},
- "compliancePlan": {
- "$ref": "#/components/schemas/CompliancePlan"
- },
- "metadata": {
- "type": "object",
- "description": "This is for metadata you want to store on the assistant."
- },
- "analysisPlan": {
- "description": "This is the plan for analysis of assistant's calls. Stored in `call.analysis`.",
- "allOf": [
- {
- "$ref": "#/components/schemas/AnalysisPlan"
- }
- ]
- },
- "artifactPlan": {
- "description": "This is the plan for artifacts generated during assistant's calls. Stored in `call.artifact`.\n\nNote: `recordingEnabled` is currently at the root level. It will be moved to `artifactPlan` in the future, but will remain backwards compatible.",
+ "outboundAuthenticationPlan": {
+ "description": "This can be used to configure the outbound authentication if required by the SIP trunk.",
"allOf": [
{
- "$ref": "#/components/schemas/ArtifactPlan"
+ "$ref": "#/components/schemas/SipTrunkOutboundAuthenticationPlan"
}
]
},
- "messagePlan": {
- "description": "This is the plan for static predefined messages that can be spoken by the assistant during the call, like `idleMessages`.\n\nNote: `firstMessage`, `voicemailMessage`, and `endCallMessage` are currently at the root level. They will be moved to `messagePlan` in the future, but will remain backwards compatible.",
- "allOf": [
- {
- "$ref": "#/components/schemas/MessagePlan"
- }
- ]
+ "outboundLeadingPlusEnabled": {
+ "type": "boolean",
+ "description": "This ensures the outbound origination attempts have a leading plus. Defaults to false to match conventional telecom behavior.\n\nUsage:\n- Vonage/Twilio requires leading plus for all outbound calls. Set this to true.\n\n@default false"
},
- "startSpeakingPlan": {
- "description": "This is the plan for when the assistant should start talking.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to start talking after the customer is done speaking.\n- The assistant is too fast to start talking after the customer is done speaking.\n- The assistant is so fast that it's actually interrupting the customer.",
- "allOf": [
- {
- "$ref": "#/components/schemas/StartSpeakingPlan"
- }
- ]
+ "techPrefix": {
+ "type": "string",
+ "description": "This can be used to configure the tech prefix on outbound calls. This is an advanced property.",
+ "maxLength": 10000
},
- "stopSpeakingPlan": {
- "description": "This is the plan for when assistant should stop talking on customer interruption.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to recognize customer's interruption.\n- The assistant is too fast to recognize customer's interruption.\n- The assistant is getting interrupted by phrases that are just acknowledgments.\n- The assistant is getting interrupted by background noises.\n- The assistant is not properly stopping -- it starts talking right after getting interrupted.",
- "allOf": [
- {
- "$ref": "#/components/schemas/StopSpeakingPlan"
- }
- ]
+ "sipDiversionHeader": {
+ "type": "string",
+ "description": "This can be used to enable the SIP diversion header for authenticating the calling number if the SIP trunk supports it. This is an advanced property.",
+ "maxLength": 10000
},
- "monitorPlan": {
- "description": "This is the plan for real-time monitoring of the assistant's calls.\n\nUsage:\n- To enable live listening of the assistant's calls, set `monitorPlan.listenEnabled` to `true`.\n- To enable live control of the assistant's calls, set `monitorPlan.controlEnabled` to `true`.\n\nNote, `serverMessages`, `clientMessages`, `serverUrl` and `serverUrlSecret` are currently at the root level but will be moved to `monitorPlan` in the future. Will remain backwards compatible",
+ "sbcConfiguration": {
+ "description": "This is an advanced configuration for enterprise deployments. This uses the onprem SBC to trunk into the SIP trunk's `gateways`, rather than the managed SBC provided by Vapi.",
"allOf": [
{
- "$ref": "#/components/schemas/MonitorPlan"
+ "$ref": "#/components/schemas/SbcConfiguration"
}
]
},
- "credentialIds": {
- "description": "These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server.url\n2. phoneNumber.serverUrl\n3. org.serverUrl",
- "allOf": [
- {
- "$ref": "#/components/schemas/Server"
- }
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "gateways"
+ ]
+ },
+ "CreateCartesiaCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "cartesia"
]
},
- "hooks": {
- "description": "This is a set of actions that will be performed on certain events.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AssistantHooks"
- }
+ "apiKey": {
+ "type": "string",
+ "description": "This is not returned in the API."
},
- "keypadInputPlan": {
- "$ref": "#/components/schemas/KeypadInputPlan"
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
}
- }
+ },
+ "required": [
+ "provider",
+ "apiKey"
+ ]
},
- "SquadMemberDTO": {
+ "CloudflareR2BucketPlan": {
"type": "object",
"properties": {
- "assistantId": {
+ "accessKeyId": {
"type": "string",
- "nullable": true,
- "description": "This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead."
+ "description": "Cloudflare R2 Access key ID."
},
- "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"
- }
- ]
+ "secretAccessKey": {
+ "type": "string",
+ "description": "Cloudflare R2 access key secret. This is not returned in the API."
},
- "assistantOverrides": {
- "description": "This can be used to override the assistant's settings and provide values for it's template variables.",
- "allOf": [
- {
- "$ref": "#/components/schemas/AssistantOverrides"
- }
- ]
+ "url": {
+ "type": "string",
+ "description": "Cloudflare R2 base url."
},
- "assistantDestinations": {
- "description": "These are the others assistants that this assistant can transfer to.\n\nIf the assistant already has transfer call tool, these destinations are just appended to existing ones.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TransferDestinationAssistant"
- }
+ "name": {
+ "type": "string",
+ "description": "This is the name of the bucket."
+ },
+ "path": {
+ "type": "string",
+ "description": "This is the path where call artifacts will be stored.\n\nUsage:\n- To store call artifacts in a specific folder, set this to the full path. Eg. \"/folder-name1/folder-name2\".\n- To store call artifacts in the root of the bucket, leave this blank.\n\n@default \"/\""
}
- }
+ },
+ "required": [
+ "name"
+ ]
},
- "CreateSquadDTO": {
+ "CreateCloudflareCredentialDTO": {
"type": "object",
"properties": {
- "name": {
+ "provider": {
"type": "string",
- "description": "This is the name of the squad."
+ "enum": [
+ "cloudflare"
+ ],
+ "description": "Credential provider. Only allowed value is cloudflare"
},
- "members": {
- "description": "This is the list of assistants that make up the squad.\n\nThe call will start with the first assistant in the list.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/SquadMemberDTO"
- }
+ "accountId": {
+ "type": "string",
+ "description": "Cloudflare Account Id."
},
- "membersOverrides": {
- "description": "This can be used to override all the assistants' settings and provide values for their template variables.\n\nBoth `membersOverrides` and `members[n].assistantOverrides` can be used together. First, `members[n].assistantOverrides` is applied. Then, `membersOverrides` is applied as a global override.",
+ "apiKey": {
+ "type": "string",
+ "description": "Cloudflare API Key / Token."
+ },
+ "accountEmail": {
+ "type": "string",
+ "description": "Cloudflare Account Email."
+ },
+ "fallbackIndex": {
+ "type": "number",
+ "description": "This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.",
+ "minimum": 1
+ },
+ "bucketPlan": {
+ "description": "This is the bucket plan that can be provided to store call artifacts in R2",
"allOf": [
{
- "$ref": "#/components/schemas/AssistantOverrides"
+ "$ref": "#/components/schemas/CloudflareR2BucketPlan"
}
]
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
}
},
"required": [
- "members"
+ "provider"
]
},
- "PhoneNumberHookCallRinging": {
+ "OAuth2AuthenticationPlan": {
"type": "object",
"properties": {
- "on": {
+ "type": {
"type": "string",
- "description": "This is the event to trigger the hook on",
"enum": [
- "call.ringing"
- ],
- "maxLength": 1000
+ "oauth2",
+ "aws-sts"
+ ]
},
- "do": {
- "type": "array",
- "description": "This is the set of actions to perform when the hook triggers",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransferPhoneNumberHookAction",
- "title": "TransferPhoneNumberHookAction"
- },
- {
- "$ref": "#/components/schemas/SayPhoneNumberHookAction",
- "title": "SayPhoneNumberHookAction"
- }
- ]
- }
+ "url": {
+ "type": "string",
+ "description": "This is the OAuth2 URL."
+ },
+ "clientId": {
+ "type": "string",
+ "description": "This is the OAuth2 client ID."
+ },
+ "clientSecret": {
+ "type": "string",
+ "description": "This is the OAuth2 client secret."
+ },
+ "scope": {
+ "type": "string",
+ "description": "This is the scope of the OAuth2 token.",
+ "maxLength": 1000
}
},
"required": [
- "on",
- "do"
+ "type",
+ "url",
+ "clientId",
+ "clientSecret"
]
},
- "ImportTwilioPhoneNumberDTO": {
+ "CreateCustomLLMCredentialDTO": {
"type": "object",
"properties": {
- "fallbackDestination": {
- "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransferDestinationNumber",
- "title": "NumberTransferDestination"
- },
+ "provider": {
+ "type": "string",
+ "enum": [
+ "custom-llm"
+ ]
+ },
+ "apiKey": {
+ "type": "string",
+ "maxLength": 10000,
+ "description": "This is not returned in the API."
+ },
+ "authenticationPlan": {
+ "description": "This is the authentication plan. Currently supports OAuth2 RFC 6749. To use Bearer authentication, use apiKey",
+ "allOf": [
{
- "$ref": "#/components/schemas/TransferDestinationSip",
- "title": "SipTransferDestination"
+ "$ref": "#/components/schemas/OAuth2AuthenticationPlan"
}
]
},
- "hooks": {
- "type": "array",
- "description": "This is the hooks that will be used for incoming calls to this phone number.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
- "title": "PhoneNumberHookCallRinging"
- }
- ]
- }
- },
- "twilioPhoneNumber": {
+ "name": {
"type": "string",
- "description": "These are the digits of the phone number you own on your Twilio.",
- "deprecated": true
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "apiKey"
+ ]
+ },
+ "CreateDeepgramCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "deepgram"
+ ]
},
- "twilioAccountSid": {
+ "apiKey": {
"type": "string",
- "description": "This is your Twilio Account SID that will be used to handle this phone number."
+ "description": "This is not returned in the API."
},
- "twilioAuthToken": {
+ "apiUrl": {
"type": "string",
- "description": "This is the Twilio Auth Token that will be used to handle this phone number."
+ "description": "This can be used to point to an onprem Deepgram instance. Defaults to api.deepgram.com."
},
"name": {
"type": "string",
- "description": "This is the name of the phone number. This is just for your own reference.",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
"maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "apiKey"
+ ]
+ },
+ "CreateDeepInfraCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "deepinfra"
+ ]
},
- "assistantId": {
+ "apiKey": {
"type": "string",
- "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "description": "This is not returned in the API."
},
- "squadId": {
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "apiKey"
+ ]
+ },
+ "CreateDeepSeekCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
"type": "string",
- "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "enum": [
+ "deep-seek"
+ ]
},
- "server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
- "allOf": [
- {
- "$ref": "#/components/schemas/Server"
- }
+ "apiKey": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "apiKey"
+ ]
+ },
+ "CreateElevenLabsCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "11labs"
]
+ },
+ "apiKey": {
+ "type": "string",
+ "maxLength": 10000,
+ "description": "This is not returned in the API."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
}
},
"required": [
- "twilioPhoneNumber",
- "twilioAccountSid",
- "twilioAuthToken"
+ "provider",
+ "apiKey"
]
},
- "CreateCustomerDTO": {
+ "GcpKey": {
"type": "object",
"properties": {
- "numberE164CheckEnabled": {
- "type": "boolean",
- "description": "This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)",
- "default": true
+ "type": {
+ "type": "string",
+ "description": "This is the type of the key. Most likely, this is \"service_account\"."
},
- "extension": {
+ "projectId": {
"type": "string",
- "description": "This is the extension that will be dialed after the call is answered.",
- "maxLength": 10,
- "example": null
+ "description": "This is the ID of the Google Cloud project associated with this key."
},
- "assistantOverrides": {
- "description": "These are the overrides for the assistant's settings and template variables specific to this customer.\nThis allows customization of the assistant's behavior for individual customers in batch calls.",
+ "privateKeyId": {
+ "type": "string",
+ "description": "This is the unique identifier for the private key."
+ },
+ "privateKey": {
+ "type": "string",
+ "description": "This is the private key in PEM format.\n\nNote: This is not returned in the API."
+ },
+ "clientEmail": {
+ "type": "string",
+ "description": "This is the email address associated with the service account."
+ },
+ "clientId": {
+ "type": "string",
+ "description": "This is the unique identifier for the client."
+ },
+ "authUri": {
+ "type": "string",
+ "description": "This is the URI for the auth provider's authorization endpoint."
+ },
+ "tokenUri": {
+ "type": "string",
+ "description": "This is the URI for the auth provider's token endpoint."
+ },
+ "authProviderX509CertUrl": {
+ "type": "string",
+ "description": "This is the URL of the public x509 certificate for the auth provider."
+ },
+ "clientX509CertUrl": {
+ "type": "string",
+ "description": "This is the URL of the public x509 certificate for the client."
+ },
+ "universeDomain": {
+ "type": "string",
+ "description": "This is the domain associated with the universe this service account belongs to."
+ }
+ },
+ "required": [
+ "type",
+ "projectId",
+ "privateKeyId",
+ "privateKey",
+ "clientEmail",
+ "clientId",
+ "authUri",
+ "tokenUri",
+ "authProviderX509CertUrl",
+ "clientX509CertUrl",
+ "universeDomain"
+ ]
+ },
+ "BucketPlan": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "This is the name of the bucket."
+ },
+ "region": {
+ "type": "string",
+ "description": "This is the region of the bucket.\n\nUsage:\n- If `credential.type` is `aws`, then this is required.\n- If `credential.type` is `gcp`, then this is optional since GCP allows buckets to be accessed without a region but region is required for data residency requirements. Read here: https://cloud.google.com/storage/docs/request-endpoints\n\nThis overrides the `credential.region` field if it is provided."
+ },
+ "path": {
+ "type": "string",
+ "description": "This is the path where call artifacts will be stored.\n\nUsage:\n- To store call artifacts in a specific folder, set this to the full path. Eg. \"/folder-name1/folder-name2\".\n- To store call artifacts in the root of the bucket, leave this blank.\n\n@default \"/\""
+ },
+ "hmacAccessKey": {
+ "type": "string",
+ "description": "This is the HMAC access key offered by GCP for interoperability with S3 clients. Here is the guide on how to create: https://cloud.google.com/storage/docs/authentication/managing-hmackeys#console\n\nUsage:\n- If `credential.type` is `gcp`, then this is required.\n- If `credential.type` is `aws`, then this is not required since credential.awsAccessKeyId is used instead."
+ },
+ "hmacSecret": {
+ "type": "string",
+ "description": "This is the secret for the HMAC access key. Here is the guide on how to create: https://cloud.google.com/storage/docs/authentication/managing-hmackeys#console\n\nUsage:\n- If `credential.type` is `gcp`, then this is required.\n- If `credential.type` is `aws`, then this is not required since credential.awsSecretAccessKey is used instead.\n\nNote: This is not returned in the API."
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "CreateGcpCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "gcp"
+ ]
+ },
+ "fallbackIndex": {
+ "type": "number",
+ "description": "This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.",
+ "minimum": 1
+ },
+ "gcpKey": {
+ "description": "This is the GCP key. This is the JSON that can be generated in the Google Cloud Console at https://console.cloud.google.com/iam-admin/serviceaccounts/details//keys.\n\nThe schema is identical to the JSON that GCP outputs.",
"allOf": [
{
- "$ref": "#/components/schemas/AssistantOverrides"
+ "$ref": "#/components/schemas/GcpKey"
}
]
},
- "number": {
+ "region": {
"type": "string",
- "description": "This is the number of the customer.",
- "minLength": 3,
+ "description": "This is the region of the GCP resource.",
"maxLength": 40
},
- "sipUri": {
- "type": "string",
- "description": "This is the SIP URI of the customer."
+ "bucketPlan": {
+ "$ref": "#/components/schemas/BucketPlan"
},
"name": {
"type": "string",
- "description": "This is the name of the customer. This is just for your own reference.\n\nFor SIP inbound calls, this is extracted from the `From` SIP header with format `\"Display Name\" `.",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
"maxLength": 40
}
- }
+ },
+ "required": [
+ "provider",
+ "gcpKey"
+ ]
},
- "SchedulePlan": {
+ "CreateGladiaCredentialDTO": {
"type": "object",
"properties": {
- "earliestAt": {
- "format": "date-time",
+ "provider": {
"type": "string",
- "description": "This is the ISO 8601 date-time string of the earliest time the call can be scheduled."
+ "enum": [
+ "gladia"
+ ]
},
- "latestAt": {
- "format": "date-time",
+ "apiKey": {
"type": "string",
- "description": "This is the ISO 8601 date-time string of the latest time the call can be scheduled."
+ "description": "This is not returned in the API."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
}
},
"required": [
- "earliestAt"
+ "provider",
+ "apiKey"
]
},
- "Call": {
+ "CreateGoHighLevelCredentialDTO": {
"type": "object",
"properties": {
- "type": {
+ "provider": {
"type": "string",
- "description": "This is the type of call.",
"enum": [
- "inboundPhoneCall",
- "outboundPhoneCall",
- "webCall",
- "vapi.websocketCall"
+ "gohighlevel"
]
},
- "costs": {
- "type": "array",
- "description": "These are the costs of individual components of the call in USD.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransportCost",
- "title": "TransportCost"
- },
- {
- "$ref": "#/components/schemas/TranscriberCost",
- "title": "TranscriberCost"
- },
- {
- "$ref": "#/components/schemas/ModelCost",
- "title": "ModelCost"
- },
- {
- "$ref": "#/components/schemas/VoiceCost",
- "title": "VoiceCost"
- },
- {
- "$ref": "#/components/schemas/VapiCost",
- "title": "VapiCost"
- },
- {
- "$ref": "#/components/schemas/VoicemailDetectionCost",
- "title": "VoicemailDetectionCost"
- },
- {
- "$ref": "#/components/schemas/AnalysisCost",
- "title": "AnalysisCost"
- }
- ]
- }
- },
- "messages": {
- "type": "array",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/UserMessage",
- "title": "UserMessage"
- },
- {
- "$ref": "#/components/schemas/SystemMessage",
- "title": "SystemMessage"
- },
- {
- "$ref": "#/components/schemas/BotMessage",
- "title": "BotMessage"
- },
- {
- "$ref": "#/components/schemas/ToolCallMessage",
- "title": "ToolCallMessage"
- },
- {
- "$ref": "#/components/schemas/ToolCallResultMessage",
- "title": "ToolCallResultMessage"
- }
- ]
- }
+ "apiKey": {
+ "type": "string",
+ "description": "This is not returned in the API."
},
- "phoneCallProvider": {
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "apiKey"
+ ]
+ },
+ "CreateGroqCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
"type": "string",
- "description": "This is the provider of the call.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type.",
"enum": [
- "twilio",
- "vonage",
- "vapi",
- "telnyx"
+ "groq"
]
},
- "phoneCallTransport": {
+ "apiKey": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "apiKey"
+ ]
+ },
+ "CreateLangfuseCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
"type": "string",
- "description": "This is the transport of the phone call.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type.",
"enum": [
- "sip",
- "pstn"
+ "langfuse"
]
},
- "status": {
+ "publicKey": {
+ "type": "string",
+ "description": "The public key for Langfuse project. Eg: pk-lf-..."
+ },
+ "apiKey": {
+ "type": "string",
+ "description": "The secret key for Langfuse project. Eg: sk-lf-... .This is not returned in the API."
+ },
+ "apiUrl": {
+ "type": "string",
+ "description": "The host URL for Langfuse project. Eg: https://cloud.langfuse.com"
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "publicKey",
+ "apiKey",
+ "apiUrl"
+ ]
+ },
+ "CreateLmntCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
"type": "string",
- "description": "This is the status of the call.",
"enum": [
- "scheduled",
- "queued",
- "ringing",
- "in-progress",
- "forwarding",
- "ended"
+ "lmnt"
]
},
- "endedReason": {
+ "apiKey": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "apiKey"
+ ]
+ },
+ "CreateMakeCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
"type": "string",
- "description": "This is the explanation for how the call ended.",
"enum": [
- "call-start-error-neither-assistant-nor-server-set",
- "assistant-request-failed",
+ "make"
+ ]
+ },
+ "teamId": {
+ "type": "string",
+ "description": "Team ID"
+ },
+ "region": {
+ "type": "string",
+ "description": "Region of your application. For example: eu1, eu2, us1, us2"
+ },
+ "apiKey": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "teamId",
+ "region",
+ "apiKey"
+ ]
+ },
+ "CreateOpenAICredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "openai"
+ ]
+ },
+ "apiKey": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "apiKey"
+ ]
+ },
+ "CreateOpenRouterCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "openrouter"
+ ]
+ },
+ "apiKey": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "apiKey"
+ ]
+ },
+ "CreatePerplexityAICredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "perplexity-ai"
+ ]
+ },
+ "apiKey": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "apiKey"
+ ]
+ },
+ "CreatePlayHTCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "playht"
+ ]
+ },
+ "apiKey": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "userId": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "apiKey",
+ "userId"
+ ]
+ },
+ "CreateRimeAICredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "rime-ai"
+ ]
+ },
+ "apiKey": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "apiKey"
+ ]
+ },
+ "CreateRunpodCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "runpod"
+ ]
+ },
+ "apiKey": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "apiKey"
+ ]
+ },
+ "CreateS3CredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "s3"
+ ],
+ "description": "Credential provider. Only allowed value is s3"
+ },
+ "awsAccessKeyId": {
+ "type": "string",
+ "description": "AWS access key ID."
+ },
+ "awsSecretAccessKey": {
+ "type": "string",
+ "description": "AWS access key secret. This is not returned in the API."
+ },
+ "region": {
+ "type": "string",
+ "description": "AWS region in which the S3 bucket is located."
+ },
+ "s3BucketName": {
+ "type": "string",
+ "description": "AWS S3 bucket name."
+ },
+ "s3PathPrefix": {
+ "type": "string",
+ "description": "The path prefix for the uploaded recording. Ex. \"recordings/\""
+ },
+ "fallbackIndex": {
+ "type": "number",
+ "minimum": 1,
+ "description": "This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "awsAccessKeyId",
+ "awsSecretAccessKey",
+ "region",
+ "s3BucketName",
+ "s3PathPrefix"
+ ]
+ },
+ "SupabaseBucketPlan": {
+ "type": "object",
+ "properties": {
+ "region": {
+ "type": "string",
+ "description": "This is the S3 Region. It should look like us-east-1\nIt should be one of the supabase regions defined in the SUPABASE_REGION enum\nCheck https://supabase.com/docs/guides/platform/regions for up to date regions",
+ "enum": [
+ "us-west-1",
+ "us-east-1",
+ "us-east-2",
+ "ca-central-1",
+ "eu-west-1",
+ "eu-west-2",
+ "eu-west-3",
+ "eu-central-1",
+ "eu-central-2",
+ "eu-north-1",
+ "ap-south-1",
+ "ap-southeast-1",
+ "ap-northeast-1",
+ "ap-northeast-2",
+ "ap-southeast-2",
+ "sa-east-1"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "description": "This is the S3 compatible URL for Supabase S3\nThis should look like https://.supabase.co/storage/v1/s3"
+ },
+ "accessKeyId": {
+ "type": "string",
+ "description": "This is the Supabase S3 Access Key ID.\nThe user creates this in the Supabase project Storage settings"
+ },
+ "secretAccessKey": {
+ "type": "string",
+ "description": "This is the Supabase S3 Secret Access Key.\nThe user creates this in the Supabase project Storage settings along with the access key id"
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the Supabase S3 Bucket Name.\nThe user must create this in Supabase under Storage > Buckets\nA bucket that does not exist will not be checked now, but file uploads will fail"
+ },
+ "path": {
+ "type": "string",
+ "description": "This is the Supabase S3 Bucket Folder Path.\nThe user can create this in Supabase under Storage > Buckets\nA path that does not exist will not be checked now, but file uploads will fail\nA Path is like a folder in the bucket\nEg. If the bucket is called \"my-bucket\" and the path is \"my-folder\", the full path is \"my-bucket/my-folder\""
+ }
+ },
+ "required": [
+ "region",
+ "url",
+ "accessKeyId",
+ "secretAccessKey",
+ "name"
+ ]
+ },
+ "CreateSupabaseCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "supabase"
+ ],
+ "description": "This is for supabase storage."
+ },
+ "fallbackIndex": {
+ "type": "number",
+ "minimum": 1,
+ "description": "This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order."
+ },
+ "bucketPlan": {
+ "$ref": "#/components/schemas/SupabaseBucketPlan"
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider"
+ ]
+ },
+ "CreateSmallestAICredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "smallest-ai"
+ ]
+ },
+ "apiKey": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "apiKey"
+ ]
+ },
+ "CreateTavusCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "tavus"
+ ]
+ },
+ "apiKey": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "apiKey"
+ ]
+ },
+ "CreateTogetherAICredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "together-ai"
+ ]
+ },
+ "apiKey": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "apiKey"
+ ]
+ },
+ "CreateTwilioCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "twilio"
+ ]
+ },
+ "authToken": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "apiKey": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "apiSecret": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "accountSid": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "accountSid"
+ ]
+ },
+ "CreateVonageCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "vonage"
+ ]
+ },
+ "apiSecret": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "apiKey": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "apiSecret",
+ "apiKey"
+ ]
+ },
+ "CreateWebhookCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "webhook"
+ ]
+ },
+ "authenticationPlan": {
+ "description": "This is the authentication plan. Currently supports OAuth2 RFC 6749.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OAuth2AuthenticationPlan"
+ }
+ ]
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "authenticationPlan"
+ ]
+ },
+ "CreateXAiCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "description": "This is the api key for Grok in XAi's console. Get it from here: https://console.x.ai",
+ "enum": [
+ "xai"
+ ]
+ },
+ "apiKey": {
+ "type": "string",
+ "maxLength": 10000,
+ "description": "This is not returned in the API."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "apiKey"
+ ]
+ },
+ "CreateGoogleCalendarOAuth2ClientCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "google.calendar.oauth2-client"
+ ]
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider"
+ ]
+ },
+ "CreateGoogleCalendarOAuth2AuthorizationCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "google.calendar.oauth2-authorization"
+ ]
+ },
+ "authorizationId": {
+ "type": "string",
+ "description": "The authorization ID for the OAuth2 authorization"
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "authorizationId"
+ ]
+ },
+ "CreateGoogleSheetsOAuth2AuthorizationCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "google.sheets.oauth2-authorization"
+ ]
+ },
+ "authorizationId": {
+ "type": "string",
+ "description": "The authorization ID for the OAuth2 authorization"
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "authorizationId"
+ ]
+ },
+ "CreateSlackOAuth2AuthorizationCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "slack.oauth2-authorization"
+ ]
+ },
+ "authorizationId": {
+ "type": "string",
+ "description": "The authorization ID for the OAuth2 authorization"
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "authorizationId"
+ ]
+ },
+ "TransferAssistantHookAction": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "This is the type of action - must be \"transfer\"",
+ "enum": [
+ "transfer"
+ ]
+ },
+ "destination": {
+ "description": "This is the destination details for the transfer - can be a phone number or SIP URI",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "NumberTransferDestination"
+ },
+ {
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "SipTransferDestination"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "FunctionCallAssistantHookAction": {
+ "type": "object",
+ "properties": {
+ "messages": {
+ "type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
+ }
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "function"
+ ],
+ "description": "The type of tool. \"function\" for Function tool."
+ },
+ "async": {
+ "type": "boolean",
+ "example": false,
+ "description": "This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`)."
+ },
+ "server": {
+ "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "SayAssistantHookAction": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "This is the type of action - must be \"say\"",
+ "enum": [
+ "say"
+ ]
+ },
+ "exact": {
+ "type": "object",
+ "description": "This is the message to say"
+ }
+ },
+ "required": [
+ "type",
+ "exact"
+ ]
+ },
+ "AssistantHookFilter": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "This is the type of filter - currently only \"oneOf\" is supported",
+ "enum": [
+ "oneOf"
+ ],
+ "maxLength": 1000
+ },
+ "key": {
+ "type": "string",
+ "description": "This is the key to filter on (e.g. \"call.endedReason\")",
+ "maxLength": 1000
+ },
+ "oneOf": {
+ "description": "This is the array of possible values to match against",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "maxLength": 1000
+ }
+ }
+ },
+ "required": [
+ "type",
+ "key",
+ "oneOf"
+ ]
+ },
+ "AssistantHookCallEnding": {
+ "type": "object",
+ "properties": {
+ "on": {
+ "type": "string",
+ "description": "This is the event that triggers this hook",
+ "enum": [
+ "call.ending"
+ ],
+ "maxLength": 1000
+ },
+ "do": {
+ "type": "array",
+ "description": "This is the set of actions to perform when the hook triggers",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TransferAssistantHookAction",
+ "title": "TransferAssistantHookAction"
+ },
+ {
+ "$ref": "#/components/schemas/FunctionCallAssistantHookAction",
+ "title": "FunctionCallAssistantHookAction"
+ }
+ ]
+ }
+ },
+ "filters": {
+ "description": "This is the set of filters that must match for the hook to trigger",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssistantHookFilter"
+ }
+ }
+ },
+ "required": [
+ "on",
+ "do"
+ ]
+ },
+ "AssistantHookAssistantSpeechInterrupted": {
+ "type": "object",
+ "properties": {
+ "on": {
+ "type": "string",
+ "description": "This is the event that triggers this hook",
+ "enum": [
+ "assistant.speech.interrupted"
+ ],
+ "maxLength": 1000
+ },
+ "do": {
+ "type": "array",
+ "description": "This is the set of actions to perform when the hook triggers",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TransferAssistantHookAction",
+ "title": "TransferAssistantHookAction"
+ },
+ {
+ "$ref": "#/components/schemas/FunctionCallAssistantHookAction",
+ "title": "FunctionCallAssistantHookAction"
+ },
+ {
+ "$ref": "#/components/schemas/SayAssistantHookAction",
+ "title": "SayAssistantHookAction"
+ }
+ ]
+ }
+ }
+ },
+ "required": [
+ "on",
+ "do"
+ ]
+ },
+ "AssistantHookCustomerSpeechInterrupted": {
+ "type": "object",
+ "properties": {
+ "on": {
+ "type": "string",
+ "description": "This is the event that triggers this hook",
+ "enum": [
+ "customer.speech.interrupted"
+ ],
+ "maxLength": 1000
+ },
+ "do": {
+ "type": "array",
+ "description": "This is the set of actions to perform when the hook triggers",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TransferAssistantHookAction",
+ "title": "TransferAssistantHookAction"
+ },
+ {
+ "$ref": "#/components/schemas/FunctionCallAssistantHookAction",
+ "title": "FunctionCallAssistantHookAction"
+ },
+ {
+ "$ref": "#/components/schemas/SayAssistantHookAction",
+ "title": "SayAssistantHookAction"
+ }
+ ]
+ }
+ }
+ },
+ "required": [
+ "on",
+ "do"
+ ]
+ },
+ "VoicemailDetectionBackoffPlan": {
+ "type": "object",
+ "properties": {
+ "startAtSeconds": {
+ "type": "number",
+ "description": "This is the number of seconds to wait before starting the first retry attempt.",
+ "minimum": 0,
+ "default": 5
+ },
+ "frequencySeconds": {
+ "type": "number",
+ "description": "This is the interval in seconds between retry attempts.",
+ "minimum": 2.5,
+ "default": 5
+ },
+ "maxRetries": {
+ "type": "number",
+ "description": "This is the maximum number of retry attempts before giving up.",
+ "minimum": 1,
+ "maximum": 10,
+ "default": 6
+ }
+ }
+ },
+ "GoogleVoicemailDetectionPlan": {
+ "type": "object",
+ "properties": {
+ "beepMaxAwaitSeconds": {
+ "type": "number",
+ "description": "This is the maximum duration from the start of the call that we will wait for a voicemail beep, before speaking our message\n\n- If we detect a voicemail beep before this, we will speak the message at that point.\n\n- Setting too low a value means that the bot will start speaking its voicemail message too early. If it does so before the actual beep, it will get cut off. You should definitely tune this to your use case.\n\n@default 30\n@min 0\n@max 60",
+ "minimum": 0,
+ "maximum": 30,
+ "default": 30
+ },
+ "provider": {
+ "type": "string",
+ "description": "This is the provider to use for voicemail detection.",
+ "enum": [
+ "google"
+ ]
+ },
+ "backoffPlan": {
+ "description": "This is the backoff plan for the voicemail detection.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/VoicemailDetectionBackoffPlan"
+ }
+ ]
+ }
+ },
+ "required": [
+ "provider"
+ ]
+ },
+ "OpenAIVoicemailDetectionPlan": {
+ "type": "object",
+ "properties": {
+ "beepMaxAwaitSeconds": {
+ "type": "number",
+ "description": "This is the maximum duration from the start of the call that we will wait for a voicemail beep, before speaking our message\n\n- If we detect a voicemail beep before this, we will speak the message at that point.\n\n- Setting too low a value means that the bot will start speaking its voicemail message too early. If it does so before the actual beep, it will get cut off. You should definitely tune this to your use case.\n\n@default 30\n@min 0\n@max 60",
+ "minimum": 0,
+ "maximum": 30,
+ "default": 30
+ },
+ "provider": {
+ "type": "string",
+ "description": "This is the provider to use for voicemail detection.",
+ "enum": [
+ "openai"
+ ]
+ },
+ "backoffPlan": {
+ "description": "This is the backoff plan for the voicemail detection.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/VoicemailDetectionBackoffPlan"
+ }
+ ]
+ }
+ },
+ "required": [
+ "provider"
+ ]
+ },
+ "TwilioVoicemailDetectionPlan": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "description": "This is the provider to use for voicemail detection.",
+ "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'].\n\n@default {Array} ['machine_end_beep', 'machine_end_silence']",
+ "enum": [
+ "machine_start",
+ "human",
+ "fax",
+ "unknown",
+ "machine_end_beep",
+ "machine_end_silence",
+ "machine_end_other"
+ ],
+ "example": [
+ "machine_end_beep",
+ "machine_end_silence"
+ ],
+ "items": {
+ "type": "string",
+ "enum": [
+ "machine_start",
+ "human",
+ "fax",
+ "unknown",
+ "machine_end_beep",
+ "machine_end_silence",
+ "machine_end_other"
+ ]
+ }
+ },
+ "enabled": {
+ "type": "boolean",
+ "description": "This sets whether the assistant should detect voicemail. Defaults to true.\n\n@default true"
+ },
+ "machineDetectionTimeout": {
+ "type": "number",
+ "description": "The number of seconds that Twilio should attempt to perform answering machine detection before timing out and returning AnsweredBy as unknown. Default is 30 seconds.\n\nIncreasing this value will provide the engine more time to make a determination. This can be useful when DetectMessageEnd is provided in the MachineDetection parameter and there is an expectation of long answering machine greetings that can exceed 30 seconds.\n\nDecreasing this value will reduce the amount of time the engine has to make a determination. This can be particularly useful when the Enable option is provided in the MachineDetection parameter and you want to limit the time for initial detection.\n\nCheck the [Twilio docs](https://www.twilio.com/docs/voice/answering-machine-detection#optional-api-tuning-parameters) for more info.\n\n@default 30",
+ "minimum": 3,
+ "maximum": 59
+ },
+ "machineDetectionSpeechThreshold": {
+ "type": "number",
+ "description": "The number of milliseconds that is used as the measuring stick for the length of the speech activity. Durations lower than this value will be interpreted as a human, longer as a machine. Default is 2400 milliseconds.\n\nIncreasing this value will reduce the chance of a False Machine (detected machine, actually human) for a long human greeting (e.g., a business greeting) but increase the time it takes to detect a machine.\n\nDecreasing this value will reduce the chances of a False Human (detected human, actually machine) for short voicemail greetings. The value of this parameter may need to be reduced by more than 1000ms to detect very short voicemail greetings. A reduction of that significance can result in increased False Machine detections. Adjusting the MachineDetectionSpeechEndThreshold is likely the better approach for short voicemails. Decreasing MachineDetectionSpeechThreshold will also reduce the time it takes to detect a machine.\n\nCheck the [Twilio docs](https://www.twilio.com/docs/voice/answering-machine-detection#optional-api-tuning-parameters) for more info.\n\n@default 2400",
+ "minimum": 1000,
+ "maximum": 6000
+ },
+ "machineDetectionSpeechEndThreshold": {
+ "type": "number",
+ "description": "The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Default is 1200 milliseconds.\n\nIncreasing this value will typically be used to better address the short voicemail greeting scenarios. For short voicemails, there is typically 1000-2000ms of audio followed by 1200-2400ms of silence and then additional audio before the beep. Increasing the MachineDetectionSpeechEndThreshold to ~2500ms will treat the 1200-2400ms of silence as a gap in the greeting but not the end of the greeting and will result in a machine detection. The downsides of such a change include:\n- Increasing the delay for human detection by the amount you increase this parameter, e.g., a change of 1200ms to 2500ms increases human detection delay by 1300ms.\n- Cases where a human has two utterances separated by a period of silence (e.g. a \"Hello\", then 2000ms of silence, and another \"Hello\") may be interpreted as a machine.\n\nDecreasing this value will result in faster human detection. The consequence is that it can lead to increased False Human (detected human, actually machine) detections because a silence gap in a voicemail greeting (not necessarily just in short voicemail scenarios) can be incorrectly interpreted as the end of speech.\n\nCheck the [Twilio docs](https://www.twilio.com/docs/voice/answering-machine-detection#optional-api-tuning-parameters) for more info.\n\n@default 1200",
+ "minimum": 500,
+ "maximum": 5000
+ },
+ "machineDetectionSilenceTimeout": {
+ "type": "number",
+ "description": "The number of milliseconds of initial silence after which an unknown AnsweredBy result will be returned. Default is 5000 milliseconds.\n\nIncreasing this value will result in waiting for a longer period of initial silence before returning an 'unknown' AMD result.\n\nDecreasing this value will result in waiting for a shorter period of initial silence before returning an 'unknown' AMD result.\n\nCheck the [Twilio docs](https://www.twilio.com/docs/voice/answering-machine-detection#optional-api-tuning-parameters) for more info.\n\n@default 5000",
+ "minimum": 2000,
+ "maximum": 10000
+ }
+ },
+ "required": [
+ "provider"
+ ]
+ },
+ "VapiVoicemailDetectionPlan": {
+ "type": "object",
+ "properties": {
+ "beepMaxAwaitSeconds": {
+ "type": "number",
+ "description": "This is the maximum duration from the start of the call that we will wait for a voicemail beep, before speaking our message\n\n- If we detect a voicemail beep before this, we will speak the message at that point.\n\n- Setting too low a value means that the bot will start speaking its voicemail message too early. If it does so before the actual beep, it will get cut off. You should definitely tune this to your use case.\n\n@default 30\n@min 0\n@max 60",
+ "minimum": 0,
+ "maximum": 30,
+ "default": 30
+ },
+ "provider": {
+ "type": "string",
+ "description": "This is the provider to use for voicemail detection.",
+ "enum": [
+ "vapi"
+ ]
+ },
+ "backoffPlan": {
+ "description": "This is the backoff plan for the voicemail detection.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/VoicemailDetectionBackoffPlan"
+ }
+ ]
+ }
+ },
+ "required": [
+ "provider"
+ ]
+ },
+ "MessagePlan": {
+ "type": "object",
+ "properties": {
+ "idleMessages": {
+ "description": "This are the messages that the assistant will speak when the user hasn't responded for `idleTimeoutSeconds`. Each time the timeout is triggered, a random message will be chosen from this array.\n\nUsage:\n- If user gets distracted and doesn't respond for a while, this can be used to grab their attention.\n- If the transcriber doesn't pick up what the user said, this can be used to ask the user to repeat themselves. (From the perspective of the assistant, the conversation is idle since it didn't \"hear\" any user messages.)\n\n@default null (no idle message is spoken)",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "maxLength": 1000
+ }
+ },
+ "idleMessageMaxSpokenCount": {
+ "type": "number",
+ "description": "This determines the maximum number of times `idleMessages` can be spoken during the call.\n\n@default 3",
+ "minimum": 1,
+ "maximum": 10
+ },
+ "idleMessageResetCountOnUserSpeechEnabled": {
+ "type": "boolean",
+ "description": "This determines whether the idle message count is reset whenever the user speaks.\n\n@default false"
+ },
+ "idleTimeoutSeconds": {
+ "type": "number",
+ "description": "This is the timeout in seconds before a message from `idleMessages` is spoken. The clock starts when the assistant finishes speaking and remains active until the user speaks.\n\n@default 10",
+ "minimum": 5,
+ "maximum": 60
+ },
+ "silenceTimeoutMessage": {
+ "type": "string",
+ "description": "This is the message that the assistant will say if the call ends due to silence.\n\nIf unspecified, it will hang up without saying anything.",
+ "maxLength": 1000
+ }
+ }
+ },
+ "KeypadInputPlan": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "This keeps track of whether the user has enabled keypad input.\nBy default, it is off.\n\n@default false"
+ },
+ "timeoutSeconds": {
+ "type": "number",
+ "description": "This is the time in seconds to wait before processing the input.\nIf the input is not received within this time, the input will be ignored.\nIf set to \"off\", the input will be processed when the user enters a delimiter or immediately if no delimiter is used.\n\n@default 2",
+ "minimum": 0,
+ "maximum": 10
+ },
+ "delimiters": {
+ "type": "string",
+ "description": "This is the delimiter(s) that will be used to process the input.\nCan be '#', '*', or an empty array.",
+ "enum": [
+ "#",
+ "*",
+ ""
+ ]
+ }
+ }
+ },
+ "CreateAssistantDTO": {
+ "type": "object",
+ "properties": {
+ "transcriber": {
+ "description": "These are the options for the assistant's transcriber.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AssemblyAITranscriber",
+ "title": "AssemblyAITranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/AzureSpeechTranscriber",
+ "title": "AzureSpeechTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/CustomTranscriber",
+ "title": "CustomTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/DeepgramTranscriber",
+ "title": "DeepgramTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/ElevenLabsTranscriber",
+ "title": "ElevenLabsTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/GladiaTranscriber",
+ "title": "GladiaTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleTranscriber",
+ "title": "GoogleTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/SpeechmaticsTranscriber",
+ "title": "SpeechmaticsTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/TalkscriberTranscriber",
+ "title": "TalkscriberTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAITranscriber",
+ "title": "OpenAITranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/CartesiaTranscriber",
+ "title": "CartesiaTranscriber"
+ }
+ ]
+ },
+ "model": {
+ "description": "These are the options for the assistant's LLM.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AnthropicModel",
+ "title": "Anthropic"
+ },
+ {
+ "$ref": "#/components/schemas/AnyscaleModel",
+ "title": "Anyscale"
+ },
+ {
+ "$ref": "#/components/schemas/CerebrasModel",
+ "title": "Cerebras"
+ },
+ {
+ "$ref": "#/components/schemas/CustomLLMModel",
+ "title": "CustomLLM"
+ },
+ {
+ "$ref": "#/components/schemas/DeepInfraModel",
+ "title": "DeepInfra"
+ },
+ {
+ "$ref": "#/components/schemas/DeepSeekModel",
+ "title": "DeepSeek"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleModel",
+ "title": "Google"
+ },
+ {
+ "$ref": "#/components/schemas/GroqModel",
+ "title": "Groq"
+ },
+ {
+ "$ref": "#/components/schemas/InflectionAIModel",
+ "title": "InflectionAI"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAIModel",
+ "title": "OpenAI"
+ },
+ {
+ "$ref": "#/components/schemas/OpenRouterModel",
+ "title": "OpenRouter"
+ },
+ {
+ "$ref": "#/components/schemas/PerplexityAIModel",
+ "title": "PerplexityAI"
+ },
+ {
+ "$ref": "#/components/schemas/TogetherAIModel",
+ "title": "Together"
+ },
+ {
+ "$ref": "#/components/schemas/XaiModel",
+ "title": "XAI"
+ }
+ ]
+ },
+ "voice": {
+ "description": "These are the options for the assistant's voice.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AzureVoice",
+ "title": "AzureVoice"
+ },
+ {
+ "$ref": "#/components/schemas/CartesiaVoice",
+ "title": "CartesiaVoice"
+ },
+ {
+ "$ref": "#/components/schemas/CustomVoice",
+ "title": "CustomVoice"
+ },
+ {
+ "$ref": "#/components/schemas/DeepgramVoice",
+ "title": "DeepgramVoice"
+ },
+ {
+ "$ref": "#/components/schemas/ElevenLabsVoice",
+ "title": "ElevenLabsVoice"
+ },
+ {
+ "$ref": "#/components/schemas/HumeVoice",
+ "title": "HumeVoice"
+ },
+ {
+ "$ref": "#/components/schemas/LMNTVoice",
+ "title": "LMNTVoice"
+ },
+ {
+ "$ref": "#/components/schemas/NeuphonicVoice",
+ "title": "NeuphonicVoice"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAIVoice",
+ "title": "OpenAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/PlayHTVoice",
+ "title": "PlayHTVoice"
+ },
+ {
+ "$ref": "#/components/schemas/RimeAIVoice",
+ "title": "RimeAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/SmallestAIVoice",
+ "title": "SmallestAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/TavusVoice",
+ "title": "TavusVoice"
+ },
+ {
+ "$ref": "#/components/schemas/VapiVoice",
+ "title": "VapiVoice"
+ },
+ {
+ "$ref": "#/components/schemas/SesameVoice",
+ "title": "SesameVoice"
+ }
+ ]
+ },
+ "firstMessage": {
+ "type": "string",
+ "description": "This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).\n\nIf unspecified, assistant will wait for user to speak and use the model to respond once they speak.",
+ "example": "Hello! How can I help you today?"
+ },
+ "firstMessageInterruptionsEnabled": {
+ "type": "boolean",
+ "default": false
+ },
+ "firstMessageMode": {
+ "type": "string",
+ "description": "This is the mode for the first message. Default is 'assistant-speaks-first'.\n\nUse:\n- 'assistant-speaks-first' to have the assistant speak first.\n- 'assistant-waits-for-user' to have the assistant wait for the user to speak first.\n- 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points).\n\n@default 'assistant-speaks-first'",
+ "enum": [
+ "assistant-speaks-first",
+ "assistant-speaks-first-with-model-generated-message",
+ "assistant-waits-for-user"
+ ],
+ "example": "assistant-speaks-first"
+ },
+ "voicemailDetection": {
+ "description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/GoogleVoicemailDetectionPlan",
+ "title": "Google"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAIVoicemailDetectionPlan",
+ "title": "OpenAI"
+ },
+ {
+ "$ref": "#/components/schemas/TwilioVoicemailDetectionPlan",
+ "title": "Twilio"
+ },
+ {
+ "$ref": "#/components/schemas/VapiVoicemailDetectionPlan",
+ "title": "Vapi"
+ }
+ ]
+ },
+ "clientMessages": {
+ "type": "array",
+ "enum": [
+ "conversation-update",
+ "function-call",
+ "function-call-result",
+ "hang",
+ "language-changed",
+ "metadata",
+ "model-output",
+ "speech-update",
+ "status-update",
+ "transcript",
+ "tool-calls",
+ "tool-calls-result",
+ "tool.completed",
+ "transfer-update",
+ "user-interrupted",
+ "voice-input",
+ "workflow.node.started"
+ ],
+ "example": [
+ "conversation-update",
+ "function-call",
+ "hang",
+ "model-output",
+ "speech-update",
+ "status-update",
+ "transfer-update",
+ "transcript",
+ "tool-calls",
+ "user-interrupted",
+ "voice-input",
+ "workflow.node.started"
+ ],
+ "description": "These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started. You can check the shape of the messages in ClientMessage schema.",
+ "items": {
+ "type": "string",
+ "enum": [
+ "conversation-update",
+ "function-call",
+ "function-call-result",
+ "hang",
+ "language-changed",
+ "metadata",
+ "model-output",
+ "speech-update",
+ "status-update",
+ "transcript",
+ "tool-calls",
+ "tool-calls-result",
+ "tool.completed",
+ "transfer-update",
+ "user-interrupted",
+ "voice-input",
+ "workflow.node.started"
+ ]
+ }
+ },
+ "serverMessages": {
+ "type": "array",
+ "enum": [
+ "conversation-update",
+ "end-of-call-report",
+ "function-call",
+ "hang",
+ "language-changed",
+ "language-change-detected",
+ "model-output",
+ "phone-call-control",
+ "speech-update",
+ "status-update",
+ "transcript",
+ "transcript[transcriptType=\"final\"]",
+ "tool-calls",
+ "transfer-destination-request",
+ "transfer-update",
+ "user-interrupted",
+ "voice-input"
+ ],
+ "example": [
+ "conversation-update",
+ "end-of-call-report",
+ "function-call",
+ "hang",
+ "speech-update",
+ "status-update",
+ "tool-calls",
+ "transfer-destination-request",
+ "user-interrupted"
+ ],
+ "description": "These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,user-interrupted. You can check the shape of the messages in ServerMessage schema.",
+ "items": {
+ "type": "string",
+ "enum": [
+ "conversation-update",
+ "end-of-call-report",
+ "function-call",
+ "hang",
+ "language-changed",
+ "language-change-detected",
+ "model-output",
+ "phone-call-control",
+ "speech-update",
+ "status-update",
+ "transcript",
+ "transcript[transcriptType=\"final\"]",
+ "tool-calls",
+ "transfer-destination-request",
+ "transfer-update",
+ "user-interrupted",
+ "voice-input"
+ ]
+ }
+ },
+ "silenceTimeoutSeconds": {
+ "type": "number",
+ "description": "How many seconds of silence to wait before ending the call. Defaults to 30.\n\n@default 30",
+ "minimum": 10,
+ "maximum": 3600,
+ "example": 30
+ },
+ "maxDurationSeconds": {
+ "type": "number",
+ "description": "This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.\n\n@default 600 (10 minutes)",
+ "minimum": 10,
+ "maximum": 43200,
+ "example": 600
+ },
+ "backgroundSound": {
+ "description": "This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.\nYou can also provide a custom sound by providing a URL to an audio file.",
+ "oneOf": [
+ {
+ "type": "enum",
+ "enum": [
+ "off",
+ "office"
+ ],
+ "example": "office"
+ },
+ {
+ "type": "string",
+ "format": "uri",
+ "example": "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3"
+ }
+ ]
+ },
+ "backgroundDenoisingEnabled": {
+ "type": "boolean",
+ "description": "This enables filtering of noise and background speech while the user is talking.\n\nDefault `false` while in beta.\n\n@default false",
+ "deprecated": true,
+ "example": false
+ },
+ "modelOutputInMessagesEnabled": {
+ "type": "boolean",
+ "description": "This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech.\n\nDefault `false` while in beta.\n\n@default false",
+ "example": false
+ },
+ "transportConfigurations": {
+ "type": "array",
+ "description": "These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TransportConfigurationTwilio",
+ "title": "Twilio"
+ }
+ ]
+ }
+ },
+ "observabilityPlan": {
+ "description": "This is the plan for observability of assistant's calls.\n\nCurrently, only Langfuse is supported.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/LangfuseObservabilityPlan",
+ "title": "Langfuse"
+ }
+ ],
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/LangfuseObservabilityPlan"
+ }
+ ]
+ },
+ "credentials": {
+ "type": "array",
+ "description": "These are dynamic credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateAnthropicCredentialDTO",
+ "title": "AnthropicCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAnyscaleCredentialDTO",
+ "title": "AnyscaleCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAssemblyAICredentialDTO",
+ "title": "AssemblyAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAzureCredentialDTO",
+ "title": "AzureCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAzureOpenAICredentialDTO",
+ "title": "AzureOpenAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
+ "title": "ByoSipTrunkCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCartesiaCredentialDTO",
+ "title": "CartesiaCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCerebrasCredentialDTO",
+ "title": "CerebrasCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCloudflareCredentialDTO",
+ "title": "CloudflareCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCustomLLMCredentialDTO",
+ "title": "CustomLLMCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepgramCredentialDTO",
+ "title": "DeepgramCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepInfraCredentialDTO",
+ "title": "DeepInfraCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepSeekCredentialDTO",
+ "title": "DeepSeekCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateElevenLabsCredentialDTO",
+ "title": "ElevenLabsCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGcpCredentialDTO",
+ "title": "GcpCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGladiaCredentialDTO",
+ "title": "GladiaCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCredentialDTO",
+ "title": "GhlCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCredentialDTO",
+ "title": "GoogleCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGroqCredentialDTO",
+ "title": "GroqCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateHumeCredentialDTO",
+ "title": "HumeCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateInflectionAICredentialDTO",
+ "title": "InflectionAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateLangfuseCredentialDTO",
+ "title": "LangfuseCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateLmntCredentialDTO",
+ "title": "LmntCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMakeCredentialDTO",
+ "title": "MakeCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMistralCredentialDTO",
+ "title": "MistralCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateNeuphonicCredentialDTO",
+ "title": "NeuphonicCredential"
+ },
+ {
+ "$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/CreateS3CredentialDTO",
+ "title": "S3Credential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmallestAICredentialDTO",
+ "title": "SmallestAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
+ "title": "SpeechmaticsCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSupabaseCredentialDTO",
+ "title": "SupabaseCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTavusCredentialDTO",
+ "title": "TavusCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTogetherAICredentialDTO",
+ "title": "TogetherAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTrieveCredentialDTO",
+ "title": "TrieveCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioCredentialDTO",
+ "title": "TwilioCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonageCredentialDTO",
+ "title": "VonageCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateWebhookCredentialDTO",
+ "title": "WebhookCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateXAiCredentialDTO",
+ "title": "XAiCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
+ "title": "GoogleCalendarOAuth2ClientCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
+ "title": "GoogleCalendarOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
+ "title": "GoogleSheetsOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO",
+ "title": "SlackOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelMCPCredentialDTO",
+ "title": "GoHighLevelMCPCredential"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "provider",
+ "mapping": {
+ "11labs": "#/components/schemas/CreateElevenLabsCredentialDTO",
+ "anthropic": "#/components/schemas/CreateAnthropicCredentialDTO",
+ "anyscale": "#/components/schemas/CreateAnyscaleCredentialDTO",
+ "assembly-ai": "#/components/schemas/CreateAssemblyAICredentialDTO",
+ "azure-openai": "#/components/schemas/CreateAzureOpenAICredentialDTO",
+ "azure": "#/components/schemas/CreateAzureCredentialDTO",
+ "byo-sip-trunk": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
+ "cartesia": "#/components/schemas/CreateCartesiaCredentialDTO",
+ "cerebras": "#/components/schemas/CreateCerebrasCredentialDTO",
+ "cloudflare": "#/components/schemas/CreateCloudflareCredentialDTO",
+ "custom-llm": "#/components/schemas/CreateCustomLLMCredentialDTO",
+ "deepgram": "#/components/schemas/CreateDeepgramCredentialDTO",
+ "deepinfra": "#/components/schemas/CreateDeepInfraCredentialDTO",
+ "deep-seek": "#/components/schemas/CreateDeepSeekCredentialDTO",
+ "gcp": "#/components/schemas/CreateGcpCredentialDTO",
+ "gladia": "#/components/schemas/CreateGladiaCredentialDTO",
+ "gohighlevel": "#/components/schemas/CreateGoHighLevelCredentialDTO",
+ "google": "#/components/schemas/CreateGoogleCredentialDTO",
+ "groq": "#/components/schemas/CreateGroqCredentialDTO",
+ "inflection-ai": "#/components/schemas/CreateInflectionAICredentialDTO",
+ "langfuse": "#/components/schemas/CreateLangfuseCredentialDTO",
+ "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",
+ "s3": "#/components/schemas/CreateS3CredentialDTO",
+ "supabase": "#/components/schemas/CreateSupabaseCredentialDTO",
+ "smallest-ai": "#/components/schemas/CreateSmallestAICredentialDTO",
+ "tavus": "#/components/schemas/CreateTavusCredentialDTO",
+ "together-ai": "#/components/schemas/CreateTogetherAICredentialDTO",
+ "twilio": "#/components/schemas/CreateTwilioCredentialDTO",
+ "vonage": "#/components/schemas/CreateVonageCredentialDTO",
+ "webhook": "#/components/schemas/CreateWebhookCredentialDTO",
+ "xai": "#/components/schemas/CreateXAiCredentialDTO",
+ "neuphonic": "#/components/schemas/CreateNeuphonicCredentialDTO",
+ "hume": "#/components/schemas/CreateHumeCredentialDTO",
+ "mistral": "#/components/schemas/CreateMistralCredentialDTO",
+ "speechmatics": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
+ "trieve": "#/components/schemas/CreateTrieveCredentialDTO",
+ "google.calendar.oauth2-client": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
+ "google.calendar.oauth2-authorization": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
+ "google.sheets.oauth2-authorization": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
+ "slack.oauth2-authorization": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO",
+ "ghl.oauth2-authorization": "#/components/schemas/CreateGoHighLevelMCPCredentialDTO"
+ }
+ }
+ }
+ },
+ "hooks": {
+ "type": "array",
+ "description": "This is a set of actions that will be performed on certain events.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AssistantHookCallEnding",
+ "title": "AssistantHookCallEnding"
+ },
+ {
+ "$ref": "#/components/schemas/AssistantHookAssistantSpeechInterrupted",
+ "title": "AssistantHookAssistantSpeechInterrupted"
+ },
+ {
+ "$ref": "#/components/schemas/AssistantHookCustomerSpeechInterrupted",
+ "title": "AssistantHookCustomerSpeechInterrupted"
+ }
+ ]
+ }
+ },
+ "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.",
+ "maxLength": 40
+ },
+ "voicemailMessage": {
+ "type": "string",
+ "description": "This is the message that the assistant will say if the call is forwarded to voicemail.\n\nIf unspecified, it will hang up.",
+ "maxLength": 1000
+ },
+ "endCallMessage": {
+ "type": "string",
+ "description": "This is the message that the assistant will say if it ends the call.\n\nIf unspecified, it will hang up without saying anything.",
+ "maxLength": 1000
+ },
+ "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": 140,
+ "minLength": 2
+ }
+ },
+ "compliancePlan": {
+ "$ref": "#/components/schemas/CompliancePlan"
+ },
+ "metadata": {
+ "type": "object",
+ "description": "This is for metadata you want to store on the assistant."
+ },
+ "backgroundSpeechDenoisingPlan": {
+ "description": "This enables filtering of noise and background speech while the user is talking.\n\nFeatures:\n- Smart denoising using Krisp\n- Fourier denoising\n\nSmart denoising can be combined with or used independently of Fourier denoising.\n\nOrder of precedence:\n- Smart denoising\n- Fourier denoising",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BackgroundSpeechDenoisingPlan"
+ }
+ ]
+ },
+ "analysisPlan": {
+ "description": "This is the plan for analysis of assistant's calls. Stored in `call.analysis`.",
+ "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"
+ }
+ ]
+ },
+ "messagePlan": {
+ "description": "This is the plan for static predefined messages that can be spoken by the assistant during the call, like `idleMessages`.\n\nNote: `firstMessage`, `voicemailMessage`, and `endCallMessage` are currently at the root level. They will be moved to `messagePlan` in the future, but will remain backwards compatible.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MessagePlan"
+ }
+ ]
+ },
+ "startSpeakingPlan": {
+ "description": "This is the plan for when the assistant should start talking.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to start talking after the customer is done speaking.\n- The assistant is too fast to start talking after the customer is done speaking.\n- The assistant is so fast that it's actually interrupting the customer.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/StartSpeakingPlan"
+ }
+ ]
+ },
+ "stopSpeakingPlan": {
+ "description": "This is the plan for when assistant should stop talking on customer interruption.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to recognize customer's interruption.\n- The assistant is too fast to recognize customer's interruption.\n- The assistant is getting interrupted by phrases that are just acknowledgments.\n- The assistant is getting interrupted by background noises.\n- The assistant is not properly stopping -- it starts talking right after getting interrupted.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/StopSpeakingPlan"
+ }
+ ]
+ },
+ "monitorPlan": {
+ "description": "This is the plan for real-time monitoring of the assistant's calls.\n\nUsage:\n- To enable live listening of the assistant's calls, set `monitorPlan.listenEnabled` to `true`.\n- To enable live control of the assistant's calls, set `monitorPlan.controlEnabled` to `true`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MonitorPlan"
+ }
+ ]
+ },
+ "credentialIds": {
+ "description": "These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server.url\n2. phoneNumber.serverUrl\n3. org.serverUrl",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
+ },
+ "keypadInputPlan": {
+ "$ref": "#/components/schemas/KeypadInputPlan"
+ }
+ }
+ },
+ "AssistantOverrides": {
+ "type": "object",
+ "properties": {
+ "transcriber": {
+ "description": "These are the options for the assistant's transcriber.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AssemblyAITranscriber",
+ "title": "AssemblyAITranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/AzureSpeechTranscriber",
+ "title": "AzureSpeechTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/CustomTranscriber",
+ "title": "CustomTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/DeepgramTranscriber",
+ "title": "DeepgramTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/ElevenLabsTranscriber",
+ "title": "ElevenLabsTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/GladiaTranscriber",
+ "title": "GladiaTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleTranscriber",
+ "title": "GoogleTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/SpeechmaticsTranscriber",
+ "title": "SpeechmaticsTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/TalkscriberTranscriber",
+ "title": "TalkscriberTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAITranscriber",
+ "title": "OpenAITranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/CartesiaTranscriber",
+ "title": "CartesiaTranscriber"
+ }
+ ]
+ },
+ "model": {
+ "description": "These are the options for the assistant's LLM.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AnthropicModel",
+ "title": "Anthropic"
+ },
+ {
+ "$ref": "#/components/schemas/AnyscaleModel",
+ "title": "Anyscale"
+ },
+ {
+ "$ref": "#/components/schemas/CerebrasModel",
+ "title": "Cerebras"
+ },
+ {
+ "$ref": "#/components/schemas/CustomLLMModel",
+ "title": "CustomLLM"
+ },
+ {
+ "$ref": "#/components/schemas/DeepInfraModel",
+ "title": "DeepInfra"
+ },
+ {
+ "$ref": "#/components/schemas/DeepSeekModel",
+ "title": "DeepSeek"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleModel",
+ "title": "Google"
+ },
+ {
+ "$ref": "#/components/schemas/GroqModel",
+ "title": "Groq"
+ },
+ {
+ "$ref": "#/components/schemas/InflectionAIModel",
+ "title": "InflectionAI"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAIModel",
+ "title": "OpenAI"
+ },
+ {
+ "$ref": "#/components/schemas/OpenRouterModel",
+ "title": "OpenRouter"
+ },
+ {
+ "$ref": "#/components/schemas/PerplexityAIModel",
+ "title": "PerplexityAI"
+ },
+ {
+ "$ref": "#/components/schemas/TogetherAIModel",
+ "title": "Together"
+ },
+ {
+ "$ref": "#/components/schemas/XaiModel",
+ "title": "XAI"
+ }
+ ]
+ },
+ "voice": {
+ "description": "These are the options for the assistant's voice.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AzureVoice",
+ "title": "AzureVoice"
+ },
+ {
+ "$ref": "#/components/schemas/CartesiaVoice",
+ "title": "CartesiaVoice"
+ },
+ {
+ "$ref": "#/components/schemas/CustomVoice",
+ "title": "CustomVoice"
+ },
+ {
+ "$ref": "#/components/schemas/DeepgramVoice",
+ "title": "DeepgramVoice"
+ },
+ {
+ "$ref": "#/components/schemas/ElevenLabsVoice",
+ "title": "ElevenLabsVoice"
+ },
+ {
+ "$ref": "#/components/schemas/HumeVoice",
+ "title": "HumeVoice"
+ },
+ {
+ "$ref": "#/components/schemas/LMNTVoice",
+ "title": "LMNTVoice"
+ },
+ {
+ "$ref": "#/components/schemas/NeuphonicVoice",
+ "title": "NeuphonicVoice"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAIVoice",
+ "title": "OpenAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/PlayHTVoice",
+ "title": "PlayHTVoice"
+ },
+ {
+ "$ref": "#/components/schemas/RimeAIVoice",
+ "title": "RimeAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/SmallestAIVoice",
+ "title": "SmallestAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/TavusVoice",
+ "title": "TavusVoice"
+ },
+ {
+ "$ref": "#/components/schemas/VapiVoice",
+ "title": "VapiVoice"
+ },
+ {
+ "$ref": "#/components/schemas/SesameVoice",
+ "title": "SesameVoice"
+ }
+ ]
+ },
+ "firstMessage": {
+ "type": "string",
+ "description": "This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).\n\nIf unspecified, assistant will wait for user to speak and use the model to respond once they speak.",
+ "example": "Hello! How can I help you today?"
+ },
+ "firstMessageInterruptionsEnabled": {
+ "type": "boolean",
+ "default": false
+ },
+ "firstMessageMode": {
+ "type": "string",
+ "description": "This is the mode for the first message. Default is 'assistant-speaks-first'.\n\nUse:\n- 'assistant-speaks-first' to have the assistant speak first.\n- 'assistant-waits-for-user' to have the assistant wait for the user to speak first.\n- 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points).\n\n@default 'assistant-speaks-first'",
+ "enum": [
+ "assistant-speaks-first",
+ "assistant-speaks-first-with-model-generated-message",
+ "assistant-waits-for-user"
+ ],
+ "example": "assistant-speaks-first"
+ },
+ "voicemailDetection": {
+ "description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/GoogleVoicemailDetectionPlan",
+ "title": "Google"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAIVoicemailDetectionPlan",
+ "title": "OpenAI"
+ },
+ {
+ "$ref": "#/components/schemas/TwilioVoicemailDetectionPlan",
+ "title": "Twilio"
+ },
+ {
+ "$ref": "#/components/schemas/VapiVoicemailDetectionPlan",
+ "title": "Vapi"
+ }
+ ]
+ },
+ "clientMessages": {
+ "type": "array",
+ "enum": [
+ "conversation-update",
+ "function-call",
+ "function-call-result",
+ "hang",
+ "language-changed",
+ "metadata",
+ "model-output",
+ "speech-update",
+ "status-update",
+ "transcript",
+ "tool-calls",
+ "tool-calls-result",
+ "tool.completed",
+ "transfer-update",
+ "user-interrupted",
+ "voice-input",
+ "workflow.node.started"
+ ],
+ "example": [
+ "conversation-update",
+ "function-call",
+ "hang",
+ "model-output",
+ "speech-update",
+ "status-update",
+ "transfer-update",
+ "transcript",
+ "tool-calls",
+ "user-interrupted",
+ "voice-input",
+ "workflow.node.started"
+ ],
+ "description": "These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started. You can check the shape of the messages in ClientMessage schema.",
+ "items": {
+ "type": "string",
+ "enum": [
+ "conversation-update",
+ "function-call",
+ "function-call-result",
+ "hang",
+ "language-changed",
+ "metadata",
+ "model-output",
+ "speech-update",
+ "status-update",
+ "transcript",
+ "tool-calls",
+ "tool-calls-result",
+ "tool.completed",
+ "transfer-update",
+ "user-interrupted",
+ "voice-input",
+ "workflow.node.started"
+ ]
+ }
+ },
+ "serverMessages": {
+ "type": "array",
+ "enum": [
+ "conversation-update",
+ "end-of-call-report",
+ "function-call",
+ "hang",
+ "language-changed",
+ "language-change-detected",
+ "model-output",
+ "phone-call-control",
+ "speech-update",
+ "status-update",
+ "transcript",
+ "transcript[transcriptType=\"final\"]",
+ "tool-calls",
+ "transfer-destination-request",
+ "transfer-update",
+ "user-interrupted",
+ "voice-input"
+ ],
+ "example": [
+ "conversation-update",
+ "end-of-call-report",
+ "function-call",
+ "hang",
+ "speech-update",
+ "status-update",
+ "tool-calls",
+ "transfer-destination-request",
+ "user-interrupted"
+ ],
+ "description": "These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,user-interrupted. You can check the shape of the messages in ServerMessage schema.",
+ "items": {
+ "type": "string",
+ "enum": [
+ "conversation-update",
+ "end-of-call-report",
+ "function-call",
+ "hang",
+ "language-changed",
+ "language-change-detected",
+ "model-output",
+ "phone-call-control",
+ "speech-update",
+ "status-update",
+ "transcript",
+ "transcript[transcriptType=\"final\"]",
+ "tool-calls",
+ "transfer-destination-request",
+ "transfer-update",
+ "user-interrupted",
+ "voice-input"
+ ]
+ }
+ },
+ "silenceTimeoutSeconds": {
+ "type": "number",
+ "description": "How many seconds of silence to wait before ending the call. Defaults to 30.\n\n@default 30",
+ "minimum": 10,
+ "maximum": 3600,
+ "example": 30
+ },
+ "maxDurationSeconds": {
+ "type": "number",
+ "description": "This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.\n\n@default 600 (10 minutes)",
+ "minimum": 10,
+ "maximum": 43200,
+ "example": 600
+ },
+ "backgroundSound": {
+ "description": "This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.\nYou can also provide a custom sound by providing a URL to an audio file.",
+ "oneOf": [
+ {
+ "type": "enum",
+ "enum": [
+ "off",
+ "office"
+ ],
+ "example": "office"
+ },
+ {
+ "type": "string",
+ "format": "uri",
+ "example": "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3"
+ }
+ ]
+ },
+ "backgroundDenoisingEnabled": {
+ "type": "boolean",
+ "description": "This enables filtering of noise and background speech while the user is talking.\n\nDefault `false` while in beta.\n\n@default false",
+ "deprecated": true,
+ "example": false
+ },
+ "modelOutputInMessagesEnabled": {
+ "type": "boolean",
+ "description": "This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech.\n\nDefault `false` while in beta.\n\n@default false",
+ "example": false
+ },
+ "transportConfigurations": {
+ "type": "array",
+ "description": "These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TransportConfigurationTwilio",
+ "title": "Twilio"
+ }
+ ]
+ }
+ },
+ "observabilityPlan": {
+ "description": "This is the plan for observability of assistant's calls.\n\nCurrently, only Langfuse is supported.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/LangfuseObservabilityPlan",
+ "title": "Langfuse"
+ }
+ ],
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/LangfuseObservabilityPlan"
+ }
+ ]
+ },
+ "credentials": {
+ "type": "array",
+ "description": "These are dynamic credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateAnthropicCredentialDTO",
+ "title": "AnthropicCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAnyscaleCredentialDTO",
+ "title": "AnyscaleCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAssemblyAICredentialDTO",
+ "title": "AssemblyAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAzureCredentialDTO",
+ "title": "AzureCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAzureOpenAICredentialDTO",
+ "title": "AzureOpenAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
+ "title": "ByoSipTrunkCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCartesiaCredentialDTO",
+ "title": "CartesiaCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCerebrasCredentialDTO",
+ "title": "CerebrasCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCloudflareCredentialDTO",
+ "title": "CloudflareCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCustomLLMCredentialDTO",
+ "title": "CustomLLMCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepgramCredentialDTO",
+ "title": "DeepgramCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepInfraCredentialDTO",
+ "title": "DeepInfraCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepSeekCredentialDTO",
+ "title": "DeepSeekCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateElevenLabsCredentialDTO",
+ "title": "ElevenLabsCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGcpCredentialDTO",
+ "title": "GcpCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGladiaCredentialDTO",
+ "title": "GladiaCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCredentialDTO",
+ "title": "GhlCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCredentialDTO",
+ "title": "GoogleCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGroqCredentialDTO",
+ "title": "GroqCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateHumeCredentialDTO",
+ "title": "HumeCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateInflectionAICredentialDTO",
+ "title": "InflectionAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateLangfuseCredentialDTO",
+ "title": "LangfuseCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateLmntCredentialDTO",
+ "title": "LmntCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMakeCredentialDTO",
+ "title": "MakeCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMistralCredentialDTO",
+ "title": "MistralCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateNeuphonicCredentialDTO",
+ "title": "NeuphonicCredential"
+ },
+ {
+ "$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/CreateS3CredentialDTO",
+ "title": "S3Credential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmallestAICredentialDTO",
+ "title": "SmallestAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
+ "title": "SpeechmaticsCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSupabaseCredentialDTO",
+ "title": "SupabaseCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTavusCredentialDTO",
+ "title": "TavusCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTogetherAICredentialDTO",
+ "title": "TogetherAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTrieveCredentialDTO",
+ "title": "TrieveCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioCredentialDTO",
+ "title": "TwilioCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonageCredentialDTO",
+ "title": "VonageCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateWebhookCredentialDTO",
+ "title": "WebhookCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateXAiCredentialDTO",
+ "title": "XAiCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
+ "title": "GoogleCalendarOAuth2ClientCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
+ "title": "GoogleCalendarOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
+ "title": "GoogleSheetsOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO",
+ "title": "SlackOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelMCPCredentialDTO",
+ "title": "GoHighLevelMCPCredential"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "provider",
+ "mapping": {
+ "11labs": "#/components/schemas/CreateElevenLabsCredentialDTO",
+ "anthropic": "#/components/schemas/CreateAnthropicCredentialDTO",
+ "anyscale": "#/components/schemas/CreateAnyscaleCredentialDTO",
+ "assembly-ai": "#/components/schemas/CreateAssemblyAICredentialDTO",
+ "azure-openai": "#/components/schemas/CreateAzureOpenAICredentialDTO",
+ "azure": "#/components/schemas/CreateAzureCredentialDTO",
+ "byo-sip-trunk": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
+ "cartesia": "#/components/schemas/CreateCartesiaCredentialDTO",
+ "cerebras": "#/components/schemas/CreateCerebrasCredentialDTO",
+ "cloudflare": "#/components/schemas/CreateCloudflareCredentialDTO",
+ "custom-llm": "#/components/schemas/CreateCustomLLMCredentialDTO",
+ "deepgram": "#/components/schemas/CreateDeepgramCredentialDTO",
+ "deepinfra": "#/components/schemas/CreateDeepInfraCredentialDTO",
+ "deep-seek": "#/components/schemas/CreateDeepSeekCredentialDTO",
+ "gcp": "#/components/schemas/CreateGcpCredentialDTO",
+ "gladia": "#/components/schemas/CreateGladiaCredentialDTO",
+ "gohighlevel": "#/components/schemas/CreateGoHighLevelCredentialDTO",
+ "google": "#/components/schemas/CreateGoogleCredentialDTO",
+ "groq": "#/components/schemas/CreateGroqCredentialDTO",
+ "inflection-ai": "#/components/schemas/CreateInflectionAICredentialDTO",
+ "langfuse": "#/components/schemas/CreateLangfuseCredentialDTO",
+ "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",
+ "s3": "#/components/schemas/CreateS3CredentialDTO",
+ "supabase": "#/components/schemas/CreateSupabaseCredentialDTO",
+ "smallest-ai": "#/components/schemas/CreateSmallestAICredentialDTO",
+ "tavus": "#/components/schemas/CreateTavusCredentialDTO",
+ "together-ai": "#/components/schemas/CreateTogetherAICredentialDTO",
+ "twilio": "#/components/schemas/CreateTwilioCredentialDTO",
+ "vonage": "#/components/schemas/CreateVonageCredentialDTO",
+ "webhook": "#/components/schemas/CreateWebhookCredentialDTO",
+ "xai": "#/components/schemas/CreateXAiCredentialDTO",
+ "neuphonic": "#/components/schemas/CreateNeuphonicCredentialDTO",
+ "hume": "#/components/schemas/CreateHumeCredentialDTO",
+ "mistral": "#/components/schemas/CreateMistralCredentialDTO",
+ "speechmatics": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
+ "trieve": "#/components/schemas/CreateTrieveCredentialDTO",
+ "google.calendar.oauth2-client": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
+ "google.calendar.oauth2-authorization": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
+ "google.sheets.oauth2-authorization": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
+ "slack.oauth2-authorization": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO",
+ "ghl.oauth2-authorization": "#/components/schemas/CreateGoHighLevelMCPCredentialDTO"
+ }
+ }
+ }
+ },
+ "hooks": {
+ "type": "array",
+ "description": "This is a set of actions that will be performed on certain events.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AssistantHookCallEnding",
+ "title": "AssistantHookCallEnding"
+ },
+ {
+ "$ref": "#/components/schemas/AssistantHookAssistantSpeechInterrupted",
+ "title": "AssistantHookAssistantSpeechInterrupted"
+ },
+ {
+ "$ref": "#/components/schemas/AssistantHookCustomerSpeechInterrupted",
+ "title": "AssistantHookCustomerSpeechInterrupted"
+ }
+ ]
+ }
+ },
+ "variableValues": {
+ "type": "object",
+ "description": "These are values that will be used to replace the template variables in the assistant messages and other text-based fields.\nThis uses LiquidJS syntax. https://liquidjs.com/tutorials/intro-to-liquid.html\n\nSo for example, `{{ name }}` will be replaced with the value of `name` in `variableValues`.\n`{{\"now\" | date: \"%b %d, %Y, %I:%M %p\", \"America/New_York\"}}` will be replaced with the current date and time in New York.\n Some VAPI reserved defaults:\n - *customer* - the customer 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.",
+ "maxLength": 40
+ },
+ "voicemailMessage": {
+ "type": "string",
+ "description": "This is the message that the assistant will say if the call is forwarded to voicemail.\n\nIf unspecified, it will hang up.",
+ "maxLength": 1000
+ },
+ "endCallMessage": {
+ "type": "string",
+ "description": "This is the message that the assistant will say if it ends the call.\n\nIf unspecified, it will hang up without saying anything.",
+ "maxLength": 1000
+ },
+ "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": 140,
+ "minLength": 2
+ }
+ },
+ "compliancePlan": {
+ "$ref": "#/components/schemas/CompliancePlan"
+ },
+ "metadata": {
+ "type": "object",
+ "description": "This is for metadata you want to store on the assistant."
+ },
+ "backgroundSpeechDenoisingPlan": {
+ "description": "This enables filtering of noise and background speech while the user is talking.\n\nFeatures:\n- Smart denoising using Krisp\n- Fourier denoising\n\nSmart denoising can be combined with or used independently of Fourier denoising.\n\nOrder of precedence:\n- Smart denoising\n- Fourier denoising",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BackgroundSpeechDenoisingPlan"
+ }
+ ]
+ },
+ "analysisPlan": {
+ "description": "This is the plan for analysis of assistant's calls. Stored in `call.analysis`.",
+ "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"
+ }
+ ]
+ },
+ "messagePlan": {
+ "description": "This is the plan for static predefined messages that can be spoken by the assistant during the call, like `idleMessages`.\n\nNote: `firstMessage`, `voicemailMessage`, and `endCallMessage` are currently at the root level. They will be moved to `messagePlan` in the future, but will remain backwards compatible.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MessagePlan"
+ }
+ ]
+ },
+ "startSpeakingPlan": {
+ "description": "This is the plan for when the assistant should start talking.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to start talking after the customer is done speaking.\n- The assistant is too fast to start talking after the customer is done speaking.\n- The assistant is so fast that it's actually interrupting the customer.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/StartSpeakingPlan"
+ }
+ ]
+ },
+ "stopSpeakingPlan": {
+ "description": "This is the plan for when assistant should stop talking on customer interruption.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to recognize customer's interruption.\n- The assistant is too fast to recognize customer's interruption.\n- The assistant is getting interrupted by phrases that are just acknowledgments.\n- The assistant is getting interrupted by background noises.\n- The assistant is not properly stopping -- it starts talking right after getting interrupted.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/StopSpeakingPlan"
+ }
+ ]
+ },
+ "monitorPlan": {
+ "description": "This is the plan for real-time monitoring of the assistant's calls.\n\nUsage:\n- To enable live listening of the assistant's calls, set `monitorPlan.listenEnabled` to `true`.\n- To enable live control of the assistant's calls, set `monitorPlan.controlEnabled` to `true`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MonitorPlan"
+ }
+ ]
+ },
+ "credentialIds": {
+ "description": "These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server.url\n2. phoneNumber.serverUrl\n3. org.serverUrl",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
+ },
+ "keypadInputPlan": {
+ "$ref": "#/components/schemas/KeypadInputPlan"
+ }
+ }
+ },
+ "SquadMemberDTO": {
+ "type": "object",
+ "properties": {
+ "assistantId": {
+ "type": "string",
+ "nullable": true,
+ "description": "This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead."
+ },
+ "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"
+ }
+ ]
+ },
+ "assistantOverrides": {
+ "description": "This can be used to override the assistant's settings and provide values for it's template variables.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AssistantOverrides"
+ }
+ ]
+ },
+ "assistantDestinations": {
+ "description": "These are the others assistants that this assistant can transfer to.\n\nIf the assistant already has transfer call tool, these destinations are just appended to existing ones.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TransferDestinationAssistant"
+ }
+ }
+ }
+ },
+ "CreateSquadDTO": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "This is the name of the squad."
+ },
+ "members": {
+ "description": "This is the list of assistants that make up the squad.\n\nThe call will start with the first assistant in the list.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SquadMemberDTO"
+ }
+ },
+ "membersOverrides": {
+ "description": "This can be used to override all the assistants' settings and provide values for their template variables.\n\nBoth `membersOverrides` and `members[n].assistantOverrides` can be used together. First, `members[n].assistantOverrides` is applied. Then, `membersOverrides` is applied as a global override.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AssistantOverrides"
+ }
+ ]
+ }
+ },
+ "required": [
+ "members"
+ ]
+ },
+ "CreateWorkflowDTO": {
+ "type": "object",
+ "properties": {
+ "nodes": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ConversationNode",
+ "title": "ConversationNode"
+ },
+ {
+ "$ref": "#/components/schemas/ToolNode",
+ "title": "ToolNode"
+ }
+ ]
+ }
+ },
+ "transcriber": {
+ "description": "This is the transcriber for the workflow.\n\nThis can be overridden at node level using `nodes[n].transcriber`.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AssemblyAITranscriber",
+ "title": "AssemblyAITranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/AzureSpeechTranscriber",
+ "title": "AzureSpeechTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/CustomTranscriber",
+ "title": "CustomTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/DeepgramTranscriber",
+ "title": "DeepgramTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/ElevenLabsTranscriber",
+ "title": "ElevenLabsTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/GladiaTranscriber",
+ "title": "GladiaTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleTranscriber",
+ "title": "GoogleTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/SpeechmaticsTranscriber",
+ "title": "SpeechmaticsTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/TalkscriberTranscriber",
+ "title": "TalkscriberTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAITranscriber",
+ "title": "OpenAITranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/CartesiaTranscriber",
+ "title": "CartesiaTranscriber"
+ }
+ ]
+ },
+ "voice": {
+ "description": "This is the voice for the workflow.\n\nThis can be overridden at node level using `nodes[n].voice`.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AzureVoice",
+ "title": "AzureVoice"
+ },
+ {
+ "$ref": "#/components/schemas/CartesiaVoice",
+ "title": "CartesiaVoice"
+ },
+ {
+ "$ref": "#/components/schemas/CustomVoice",
+ "title": "CustomVoice"
+ },
+ {
+ "$ref": "#/components/schemas/DeepgramVoice",
+ "title": "DeepgramVoice"
+ },
+ {
+ "$ref": "#/components/schemas/ElevenLabsVoice",
+ "title": "ElevenLabsVoice"
+ },
+ {
+ "$ref": "#/components/schemas/HumeVoice",
+ "title": "HumeVoice"
+ },
+ {
+ "$ref": "#/components/schemas/LMNTVoice",
+ "title": "LMNTVoice"
+ },
+ {
+ "$ref": "#/components/schemas/NeuphonicVoice",
+ "title": "NeuphonicVoice"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAIVoice",
+ "title": "OpenAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/PlayHTVoice",
+ "title": "PlayHTVoice"
+ },
+ {
+ "$ref": "#/components/schemas/RimeAIVoice",
+ "title": "RimeAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/SmallestAIVoice",
+ "title": "SmallestAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/TavusVoice",
+ "title": "TavusVoice"
+ },
+ {
+ "$ref": "#/components/schemas/VapiVoice",
+ "title": "VapiVoice"
+ },
+ {
+ "$ref": "#/components/schemas/SesameVoice",
+ "title": "SesameVoice"
+ }
+ ]
+ },
+ "observabilityPlan": {
+ "description": "This is the plan for observability of workflow's calls.\n\nCurrently, only Langfuse is supported.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/LangfuseObservabilityPlan",
+ "title": "Langfuse"
+ }
+ ],
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/LangfuseObservabilityPlan"
+ }
+ ]
+ },
+ "credentials": {
+ "type": "array",
+ "description": "These are dynamic credentials that will be used for the workflow calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateAnthropicCredentialDTO",
+ "title": "AnthropicCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAnyscaleCredentialDTO",
+ "title": "AnyscaleCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAssemblyAICredentialDTO",
+ "title": "AssemblyAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAzureCredentialDTO",
+ "title": "AzureCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAzureOpenAICredentialDTO",
+ "title": "AzureOpenAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
+ "title": "ByoSipTrunkCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCartesiaCredentialDTO",
+ "title": "CartesiaCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCerebrasCredentialDTO",
+ "title": "CerebrasCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCloudflareCredentialDTO",
+ "title": "CloudflareCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCustomLLMCredentialDTO",
+ "title": "CustomLLMCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepgramCredentialDTO",
+ "title": "DeepgramCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepInfraCredentialDTO",
+ "title": "DeepInfraCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepSeekCredentialDTO",
+ "title": "DeepSeekCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateElevenLabsCredentialDTO",
+ "title": "ElevenLabsCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGcpCredentialDTO",
+ "title": "GcpCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGladiaCredentialDTO",
+ "title": "GladiaCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCredentialDTO",
+ "title": "GhlCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCredentialDTO",
+ "title": "GoogleCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGroqCredentialDTO",
+ "title": "GroqCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateHumeCredentialDTO",
+ "title": "HumeCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateInflectionAICredentialDTO",
+ "title": "InflectionAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateLangfuseCredentialDTO",
+ "title": "LangfuseCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateLmntCredentialDTO",
+ "title": "LmntCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMakeCredentialDTO",
+ "title": "MakeCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMistralCredentialDTO",
+ "title": "MistralCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateNeuphonicCredentialDTO",
+ "title": "NeuphonicCredential"
+ },
+ {
+ "$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/CreateS3CredentialDTO",
+ "title": "S3Credential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmallestAICredentialDTO",
+ "title": "SmallestAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
+ "title": "SpeechmaticsCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSupabaseCredentialDTO",
+ "title": "SupabaseCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTavusCredentialDTO",
+ "title": "TavusCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTogetherAICredentialDTO",
+ "title": "TogetherAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTrieveCredentialDTO",
+ "title": "TrieveCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioCredentialDTO",
+ "title": "TwilioCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonageCredentialDTO",
+ "title": "VonageCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateWebhookCredentialDTO",
+ "title": "WebhookCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateXAiCredentialDTO",
+ "title": "XAiCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
+ "title": "GoogleCalendarOAuth2ClientCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
+ "title": "GoogleCalendarOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
+ "title": "GoogleSheetsOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO",
+ "title": "SlackOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelMCPCredentialDTO",
+ "title": "GoHighLevelMCPCredential"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "provider",
+ "mapping": {
+ "11labs": "#/components/schemas/CreateElevenLabsCredentialDTO",
+ "anthropic": "#/components/schemas/CreateAnthropicCredentialDTO",
+ "anyscale": "#/components/schemas/CreateAnyscaleCredentialDTO",
+ "assembly-ai": "#/components/schemas/CreateAssemblyAICredentialDTO",
+ "azure-openai": "#/components/schemas/CreateAzureOpenAICredentialDTO",
+ "azure": "#/components/schemas/CreateAzureCredentialDTO",
+ "byo-sip-trunk": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
+ "cartesia": "#/components/schemas/CreateCartesiaCredentialDTO",
+ "cerebras": "#/components/schemas/CreateCerebrasCredentialDTO",
+ "cloudflare": "#/components/schemas/CreateCloudflareCredentialDTO",
+ "custom-llm": "#/components/schemas/CreateCustomLLMCredentialDTO",
+ "deepgram": "#/components/schemas/CreateDeepgramCredentialDTO",
+ "deepinfra": "#/components/schemas/CreateDeepInfraCredentialDTO",
+ "deep-seek": "#/components/schemas/CreateDeepSeekCredentialDTO",
+ "gcp": "#/components/schemas/CreateGcpCredentialDTO",
+ "gladia": "#/components/schemas/CreateGladiaCredentialDTO",
+ "gohighlevel": "#/components/schemas/CreateGoHighLevelCredentialDTO",
+ "google": "#/components/schemas/CreateGoogleCredentialDTO",
+ "groq": "#/components/schemas/CreateGroqCredentialDTO",
+ "inflection-ai": "#/components/schemas/CreateInflectionAICredentialDTO",
+ "langfuse": "#/components/schemas/CreateLangfuseCredentialDTO",
+ "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",
+ "s3": "#/components/schemas/CreateS3CredentialDTO",
+ "supabase": "#/components/schemas/CreateSupabaseCredentialDTO",
+ "smallest-ai": "#/components/schemas/CreateSmallestAICredentialDTO",
+ "tavus": "#/components/schemas/CreateTavusCredentialDTO",
+ "together-ai": "#/components/schemas/CreateTogetherAICredentialDTO",
+ "twilio": "#/components/schemas/CreateTwilioCredentialDTO",
+ "vonage": "#/components/schemas/CreateVonageCredentialDTO",
+ "webhook": "#/components/schemas/CreateWebhookCredentialDTO",
+ "xai": "#/components/schemas/CreateXAiCredentialDTO",
+ "neuphonic": "#/components/schemas/CreateNeuphonicCredentialDTO",
+ "hume": "#/components/schemas/CreateHumeCredentialDTO",
+ "mistral": "#/components/schemas/CreateMistralCredentialDTO",
+ "speechmatics": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
+ "trieve": "#/components/schemas/CreateTrieveCredentialDTO",
+ "google.calendar.oauth2-client": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
+ "google.calendar.oauth2-authorization": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
+ "google.sheets.oauth2-authorization": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
+ "slack.oauth2-authorization": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO",
+ "ghl.oauth2-authorization": "#/components/schemas/CreateGoHighLevelMCPCredentialDTO"
+ }
+ }
+ }
+ },
+ "name": {
+ "type": "string",
+ "maxLength": 80
+ },
+ "edges": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Edge"
+ }
+ },
+ "globalPrompt": {
+ "type": "string",
+ "maxLength": 5000
+ },
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. tool.server\n2. workflow.server / assistant.server\n3. phoneNumber.server\n4. org.server",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
+ },
+ "compliancePlan": {
+ "description": "This is the compliance plan for the workflow. It allows you to configure HIPAA and other compliance settings.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CompliancePlan"
+ }
+ ]
+ },
+ "analysisPlan": {
+ "description": "This is the plan for analysis of workflow's calls. Stored in `call.analysis`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AnalysisPlan"
+ }
+ ]
+ },
+ "artifactPlan": {
+ "description": "This is the plan for artifacts generated during workflow's calls. Stored in `call.artifact`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ArtifactPlan"
+ }
+ ]
+ },
+ "startSpeakingPlan": {
+ "description": "This is the plan for when the workflow nodes should start talking.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to start talking after the customer is done speaking.\n- The assistant is too fast to start talking after the customer is done speaking.\n- The assistant is so fast that it's actually interrupting the customer.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/StartSpeakingPlan"
+ }
+ ]
+ },
+ "stopSpeakingPlan": {
+ "description": "This is the plan for when workflow nodes should stop talking on customer interruption.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to recognize customer's interruption.\n- The assistant is too fast to recognize customer's interruption.\n- The assistant is getting interrupted by phrases that are just acknowledgments.\n- The assistant is getting interrupted by background noises.\n- The assistant is not properly stopping -- it starts talking right after getting interrupted.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/StopSpeakingPlan"
+ }
+ ]
+ },
+ "monitorPlan": {
+ "description": "This is the plan for real-time monitoring of the workflow's calls.\n\nUsage:\n- To enable live listening of the workflow's calls, set `monitorPlan.listenEnabled` to `true`.\n- To enable live control of the workflow's calls, set `monitorPlan.controlEnabled` to `true`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MonitorPlan"
+ }
+ ]
+ },
+ "backgroundSpeechDenoisingPlan": {
+ "description": "This enables filtering of noise and background speech while the user is talking.\n\nFeatures:\n- Smart denoising using Krisp\n- Fourier denoising\n\nBoth can be used together. Order of precedence:\n- Smart denoising\n- Fourier denoising",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BackgroundSpeechDenoisingPlan"
+ }
+ ]
+ },
+ "credentialIds": {
+ "description": "These are the credentials that will be used for the workflow calls. By default, all the credentials are available for use in the call but you can provide a subset using this.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "nodes",
+ "name",
+ "edges"
+ ]
+ },
+ "WorkflowOverrides": {
+ "type": "object",
+ "properties": {
+ "variableValues": {
+ "type": "object",
+ "description": "These are values that will be used to replace the template variables in the workflow messages and other text-based fields.\nThis uses LiquidJS syntax. https://liquidjs.com/tutorials/intro-to-liquid.html\n\nSo for example, `{{ name }}` will be replaced with the value of `name` in `variableValues`.\n`{{\"now\" | date: \"%b %d, %Y, %I:%M %p\", \"America/New_York\"}}` will be replaced with the current date and time in New York.\n Some VAPI reserved defaults:\n - *customer* - the customer object"
+ }
+ }
+ },
+ "TransferPhoneNumberHookAction": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "This is the type of action - must be \"transfer\"",
+ "enum": [
+ "transfer"
+ ]
+ },
+ "destination": {
+ "description": "This is the destination details for the transfer - can be a phone number or SIP URI",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "NumberTransferDestination"
+ },
+ {
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "SipTransferDestination"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "SayPhoneNumberHookAction": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "This is the type of action - must be \"say\"",
+ "enum": [
+ "say"
+ ]
+ },
+ "exact": {
+ "type": "string",
+ "description": "This is the message to say",
+ "maxLength": 4000
+ }
+ },
+ "required": [
+ "type",
+ "exact"
+ ]
+ },
+ "PhoneNumberHookCallRinging": {
+ "type": "object",
+ "properties": {
+ "on": {
+ "type": "string",
+ "description": "This is the event to trigger the hook on",
+ "enum": [
+ "call.ringing"
+ ],
+ "maxLength": 1000
+ },
+ "do": {
+ "type": "array",
+ "description": "This is the set of actions to perform when the hook triggers",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TransferPhoneNumberHookAction",
+ "title": "TransferPhoneNumberHookAction"
+ },
+ {
+ "$ref": "#/components/schemas/SayPhoneNumberHookAction",
+ "title": "SayPhoneNumberHookAction"
+ }
+ ]
+ }
+ }
+ },
+ "required": [
+ "on",
+ "do"
+ ]
+ },
+ "ImportTwilioPhoneNumberDTO": {
+ "type": "object",
+ "properties": {
+ "fallbackDestination": {
+ "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "NumberTransferDestination"
+ },
+ {
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "SipTransferDestination"
+ }
+ ]
+ },
+ "hooks": {
+ "type": "array",
+ "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
+ "title": "PhoneNumberHookCallRinging"
+ }
+ ]
+ }
+ },
+ "smsEnabled": {
+ "type": "boolean",
+ "description": "Controls whether Vapi sets the messaging webhook URL on the Twilio number during import.\n\nIf set to `false`, Vapi will not update the Twilio messaging URL, leaving it as is.\nIf `true` or omitted (default), Vapi will configure both the voice and messaging URLs.\n\n@default true",
+ "default": true
+ },
+ "twilioPhoneNumber": {
+ "type": "string",
+ "description": "These are the digits of the phone number you own on your Twilio.",
+ "deprecated": true
+ },
+ "twilioAccountSid": {
+ "type": "string",
+ "description": "This is your Twilio Account SID that will be used to handle this phone number."
+ },
+ "twilioAuthToken": {
+ "type": "string",
+ "description": "This is the Twilio Auth Token that will be used to handle this phone number."
+ },
+ "twilioApiKey": {
+ "type": "string",
+ "description": "This is the Twilio API Key that will be used to handle this phone number. If AuthToken is provided, this will be ignored."
+ },
+ "twilioApiSecret": {
+ "type": "string",
+ "description": "This is the Twilio API Secret that will be used to handle this phone number. If AuthToken is provided, this will be ignored."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of the phone number. This is just for your own reference.",
+ "maxLength": 40
+ },
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "squadId": {
+ "type": "string",
+ "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
+ }
+ },
+ "required": [
+ "twilioPhoneNumber",
+ "twilioAccountSid"
+ ]
+ },
+ "CreateCustomerDTO": {
+ "type": "object",
+ "properties": {
+ "numberE164CheckEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)",
+ "default": true
+ },
+ "extension": {
+ "type": "string",
+ "description": "This is the extension that will be dialed after the call is answered.",
+ "maxLength": 10,
+ "example": null
+ },
+ "assistantOverrides": {
+ "description": "These are the overrides for the assistant's settings and template variables specific to this customer.\nThis allows customization of the assistant's behavior for individual customers in batch calls.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AssistantOverrides"
+ }
+ ]
+ },
+ "number": {
+ "type": "string",
+ "description": "This is the number of the customer.",
+ "minLength": 3,
+ "maxLength": 40
+ },
+ "sipUri": {
+ "type": "string",
+ "description": "This is the SIP URI of the customer."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of the customer. This is just for your own reference.\n\nFor SIP inbound calls, this is extracted from the `From` SIP header with format `\"Display Name\" `.",
+ "maxLength": 40
+ }
+ }
+ },
+ "SchedulePlan": {
+ "type": "object",
+ "properties": {
+ "earliestAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of the earliest time the call can be scheduled."
+ },
+ "latestAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of the latest time the call can be scheduled."
+ }
+ },
+ "required": [
+ "earliestAt"
+ ]
+ },
+ "Call": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "This is the type of call.",
+ "enum": [
+ "inboundPhoneCall",
+ "outboundPhoneCall",
+ "webCall",
+ "vapi.websocketCall"
+ ]
+ },
+ "costs": {
+ "type": "array",
+ "description": "These are the costs of individual components of the call in USD.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TransportCost",
+ "title": "TransportCost"
+ },
+ {
+ "$ref": "#/components/schemas/TranscriberCost",
+ "title": "TranscriberCost"
+ },
+ {
+ "$ref": "#/components/schemas/ModelCost",
+ "title": "ModelCost"
+ },
+ {
+ "$ref": "#/components/schemas/VoiceCost",
+ "title": "VoiceCost"
+ },
+ {
+ "$ref": "#/components/schemas/VapiCost",
+ "title": "VapiCost"
+ },
+ {
+ "$ref": "#/components/schemas/VoicemailDetectionCost",
+ "title": "VoicemailDetectionCost"
+ },
+ {
+ "$ref": "#/components/schemas/AnalysisCost",
+ "title": "AnalysisCost"
+ },
+ {
+ "$ref": "#/components/schemas/KnowledgeBaseCost",
+ "title": "KnowledgeBaseCost"
+ }
+ ]
+ }
+ },
+ "messages": {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/UserMessage",
+ "title": "UserMessage"
+ },
+ {
+ "$ref": "#/components/schemas/SystemMessage",
+ "title": "SystemMessage"
+ },
+ {
+ "$ref": "#/components/schemas/BotMessage",
+ "title": "BotMessage"
+ },
+ {
+ "$ref": "#/components/schemas/ToolCallMessage",
+ "title": "ToolCallMessage"
+ },
+ {
+ "$ref": "#/components/schemas/ToolCallResultMessage",
+ "title": "ToolCallResultMessage"
+ }
+ ]
+ }
+ },
+ "phoneCallProvider": {
+ "type": "string",
+ "description": "This is the provider of the call.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type.",
+ "deprecated": true,
+ "enum": [
+ "twilio",
+ "vonage",
+ "vapi",
+ "telnyx"
+ ]
+ },
+ "phoneCallTransport": {
+ "type": "string",
+ "description": "This is the transport of the phone call.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type.",
+ "enum": [
+ "sip",
+ "pstn"
+ ]
+ },
+ "status": {
+ "type": "string",
+ "description": "This is the status of the call.",
+ "enum": [
+ "scheduled",
+ "queued",
+ "ringing",
+ "in-progress",
+ "forwarding",
+ "ended"
+ ]
+ },
+ "endedReason": {
+ "type": "string",
+ "description": "This is the explanation for how the call ended.",
+ "enum": [
+ "call-start-error-neither-assistant-nor-server-set",
+ "assistant-request-failed",
"assistant-request-returned-error",
"assistant-request-returned-unspeakable-error",
"assistant-request-returned-invalid-assistant",
"assistant-request-returned-no-assistant",
"assistant-request-returned-forwarding-phone-number",
- "call.start.error-get-org",
- "call.start.error-get-subscription",
+ "scheduled-call-deleted",
+ "call.start.error-vapifault-get-org",
+ "call.start.error-vapifault-get-subscription",
"call.start.error-get-assistant",
"call.start.error-get-phone-number",
"call.start.error-get-customer",
@@ -18321,6 +24246,11 @@
"call.start.error-vapi-number-international",
"call.start.error-vapi-number-outbound-daily-limit",
"call.start.error-get-transport",
+ "call.start.error-subscription-wallet-does-not-exist",
+ "call.start.error-subscription-frozen",
+ "call.start.error-subscription-insufficient-credits",
+ "call.start.error-subscription-upgrade-failed",
+ "call.start.error-subscription-concurrency-limit-reached",
"assistant-not-valid",
"database-error",
"assistant-not-found",
@@ -18388,7 +24318,6 @@
"call.in-progress.error-vapifault-azure-speech-transcriber-failed",
"call.in-progress.error-pipeline-no-available-llm-model",
"worker-shutdown",
- "unknown-error",
"vonage-disconnected",
"vonage-failed-to-connect-call",
"vonage-completed",
@@ -18398,6 +24327,9 @@
"call.in-progress.error-vapifault-transport-never-connected",
"call.in-progress.error-vapifault-transport-connected-but-call-not-active",
"call.in-progress.error-vapifault-call-started-but-connection-to-transport-missing",
+ "call.in-progress.error-vapifault-worker-died",
+ "call.in-progress.twilio-completed-call",
+ "call.in-progress.sip-completed-call",
"call.in-progress.error-vapifault-openai-llm-failed",
"call.in-progress.error-vapifault-azure-openai-llm-failed",
"call.in-progress.error-vapifault-groq-llm-failed",
@@ -18407,6 +24339,7 @@
"call.in-progress.error-vapifault-inflection-ai-llm-failed",
"call.in-progress.error-vapifault-cerebras-llm-failed",
"call.in-progress.error-vapifault-deep-seek-llm-failed",
+ "call.in-progress.error-vapifault-chat-pipeline-failed-to-start",
"pipeline-error-openai-400-bad-request-validation-failed",
"pipeline-error-openai-401-unauthorized",
"pipeline-error-openai-401-incorrect-api-key",
@@ -18674,6 +24607,7 @@
"pipeline-error-cartesia-socket-hang-up",
"pipeline-error-cartesia-requested-payment",
"pipeline-error-cartesia-500-server-error",
+ "pipeline-error-cartesia-502-server-error",
"pipeline-error-cartesia-503-server-error",
"pipeline-error-cartesia-522-server-error",
"call.in-progress.error-vapifault-cartesia-socket-hang-up",
@@ -18694,6 +24628,7 @@
"pipeline-error-eleven-labs-invalid-api-key",
"pipeline-error-eleven-labs-invalid-voice-samples",
"pipeline-error-eleven-labs-voice-disabled-by-owner",
+ "pipeline-error-eleven-labs-vapi-voice-disabled-by-owner",
"pipeline-error-eleven-labs-blocked-account-in-probation",
"pipeline-error-eleven-labs-blocked-content-against-their-policy",
"pipeline-error-eleven-labs-missing-samples-for-voice-clone",
@@ -18702,6 +24637,7 @@
"pipeline-error-eleven-labs-max-character-limit-exceeded",
"pipeline-error-eleven-labs-blocked-voice-potentially-against-terms-of-service-and-awaiting-verification",
"pipeline-error-eleven-labs-500-server-error",
+ "pipeline-error-eleven-labs-503-server-error",
"call.in-progress.error-vapifault-eleven-labs-voice-not-found",
"call.in-progress.error-vapifault-eleven-labs-quota-exceeded",
"call.in-progress.error-vapifault-eleven-labs-unauthorized-access",
@@ -18723,6 +24659,7 @@
"call.in-progress.error-vapifault-eleven-labs-max-character-limit-exceeded",
"call.in-progress.error-vapifault-eleven-labs-blocked-voice-potentially-against-terms-of-service-and-awaiting-verification",
"call.in-progress.error-providerfault-eleven-labs-500-server-error",
+ "call.in-progress.error-providerfault-eleven-labs-503-server-error",
"pipeline-error-playht-request-timed-out",
"pipeline-error-playht-invalid-voice",
"pipeline-error-playht-unexpected-error",
@@ -18758,6 +24695,7 @@
"pipeline-error-deepgram-returning-500-invalid-json",
"pipeline-error-deepgram-returning-502-network-error",
"pipeline-error-deepgram-returning-502-bad-gateway-ehostunreach",
+ "pipeline-error-deepgram-returning-econnreset",
"call.in-progress.error-vapifault-deepgram-returning-400-no-such-model-language-tier-combination",
"call.in-progress.error-vapifault-deepgram-returning-401-invalid-credentials",
"call.in-progress.error-vapifault-deepgram-returning-404-not-found",
@@ -18776,6 +24714,7 @@
"assistant-forwarded-call",
"assistant-join-timed-out",
"call.in-progress.error-assistant-did-not-receive-customer-audio",
+ "call.in-progress.error-transfer-failed",
"customer-busy",
"customer-ended-call",
"customer-did-not-answer",
@@ -18785,17 +24724,3821 @@
"phone-call-provider-closed-websocket",
"call.forwarding.operator-busy",
"silence-timed-out",
- "call.in-progress.error-sip-telephony-provider-failed-to-connect-call",
+ "call.in-progress.error-sip-inbound-call-failed-to-connect",
+ "call.in-progress.error-providerfault-outbound-sip-403-forbidden",
+ "call.in-progress.error-providerfault-outbound-sip-407-proxy-authentication-required",
+ "call.in-progress.error-providerfault-outbound-sip-503-service-unavailable",
+ "call.in-progress.error-providerfault-outbound-sip-480-temporarily-unavailable",
+ "call.in-progress.error-sip-outbound-call-failed-to-connect",
"call.ringing.hook-executed-say",
"call.ringing.hook-executed-transfer",
+ "call.ringing.sip-inbound-caller-hungup-before-call-connect",
+ "call.ringing.error-sip-inbound-call-failed-to-connect",
"twilio-failed-to-connect-call",
"twilio-reported-customer-misdialed",
"vonage-rejected",
"voicemail"
]
},
- "destination": {
- "description": "This is the destination where the call ended up being transferred to. If the call was not transferred, this will be empty.",
+ "destination": {
+ "description": "This is the destination where the call ended up being transferred to. If the call was not transferred, this will be empty.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "NumberTransferDestination"
+ },
+ {
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "SipTransferDestination"
+ }
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "This is the unique identifier for the call."
+ },
+ "orgId": {
+ "type": "string",
+ "description": "This is the unique identifier for the org that this call belongs to."
+ },
+ "createdAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the call was created."
+ },
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the call was last updated."
+ },
+ "startedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the call was started."
+ },
+ "endedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the call was ended."
+ },
+ "cost": {
+ "type": "number",
+ "description": "This is the cost of the call in USD."
+ },
+ "costBreakdown": {
+ "description": "This is the cost of the call in USD.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CostBreakdown"
+ }
+ ]
+ },
+ "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"
+ }
+ ]
+ },
+ "analysis": {
+ "description": "This is the analysis of the call. Configure in `assistant.analysisPlan`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Analysis"
+ }
+ ]
+ },
+ "monitor": {
+ "description": "This is to real-time monitor the call. Configure in `assistant.monitorPlan`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Monitor"
+ }
+ ]
+ },
+ "artifact": {
+ "description": "These are the artifacts created from the call. Configure in `assistant.artifactPlan`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Artifact"
+ }
+ ]
+ },
+ "phoneCallProviderId": {
+ "type": "string",
+ "description": "The ID of the call as provided by the phone number service. callSid in Twilio. conversationUuid in Vonage. callControlId in Telnyx.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type.",
+ "deprecated": true
+ },
+ "campaignId": {
+ "type": "string",
+ "description": "This is the campaign ID that the call belongs to."
+ },
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant ID that will be used for the call. To use a transient assistant, use `assistant` instead.\n\nTo start a call with:\n- Assistant, use `assistantId` or `assistant`\n- Squad, use `squadId` or `squad`\n- Workflow, use `workflowId` or `workflow`"
+ },
+ "assistant": {
+ "description": "This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead.\n\nTo start a call with:\n- Assistant, use `assistant`\n- Squad, use `squad`\n- Workflow, use `workflow`",
+ "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"
+ }
+ ]
+ },
+ "squadId": {
+ "type": "string",
+ "description": "This is the squad that will be used for the call. To use a transient squad, use `squad` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`"
+ },
+ "squad": {
+ "description": "This is a squad that will be used for the call. To use an existing squad, use `squadId` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateSquadDTO"
+ }
+ ]
+ },
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow that will be used for the call. To use a transient workflow, use `workflow` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`"
+ },
+ "workflow": {
+ "description": "This is a workflow that will be used for the call. To use an existing workflow, use `workflowId` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateWorkflowDTO"
+ }
+ ]
+ },
+ "workflowOverrides": {
+ "description": "These are the overrides for the `workflow` or `workflowId`'s settings and template variables.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/WorkflowOverrides"
+ }
+ ]
+ },
+ "phoneNumberId": {
+ "type": "string",
+ "description": "This is the phone number that will be used for the call. To use a transient number, use `phoneNumber` instead.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type."
+ },
+ "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"
+ }
+ ]
+ },
+ "customerId": {
+ "type": "string",
+ "description": "This is the customer that will be called. To call a transient customer , use `customer` instead.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type."
+ },
+ "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"
+ }
+ ]
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of the call. This is just for your own reference.",
+ "maxLength": 40
+ },
+ "schedulePlan": {
+ "description": "This is the schedule plan of the call.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SchedulePlan"
+ }
+ ]
+ },
+ "transport": {
+ "type": "object",
+ "description": "This is the transport of the call."
+ }
+ },
+ "required": [
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt"
+ ]
+ },
+ "CallBatchError": {
+ "type": "object",
+ "properties": {
+ "customer": {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ },
+ "error": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "customer",
+ "error"
+ ]
+ },
+ "CallBatchResponse": {
+ "type": "object",
+ "properties": {
+ "results": {
+ "description": "This is the list of calls that were created.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Call"
+ }
+ },
+ "errors": {
+ "description": "This is the list of calls that failed to be created.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CallBatchError"
+ }
+ }
+ },
+ "required": [
+ "results",
+ "errors"
+ ]
+ },
+ "CreateCallDTO": {
+ "type": "object",
+ "properties": {
+ "customers": {
+ "description": "This is used to issue batch calls to multiple customers.\n\nOnly relevant for `outboundPhoneCall`. To call a single customer, use `customer` instead.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ }
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of the call. This is just for your own reference.",
+ "maxLength": 40
+ },
+ "schedulePlan": {
+ "description": "This is the schedule plan of the call.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SchedulePlan"
+ }
+ ]
+ },
+ "transport": {
+ "type": "object",
+ "description": "This is the transport of the call."
+ },
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant ID that will be used for the call. To use a transient assistant, use `assistant` instead.\n\nTo start a call with:\n- Assistant, use `assistantId` or `assistant`\n- Squad, use `squadId` or `squad`\n- Workflow, use `workflowId` or `workflow`"
+ },
+ "assistant": {
+ "description": "This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead.\n\nTo start a call with:\n- Assistant, use `assistant`\n- Squad, use `squad`\n- Workflow, use `workflow`",
+ "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"
+ }
+ ]
+ },
+ "squadId": {
+ "type": "string",
+ "description": "This is the squad that will be used for the call. To use a transient squad, use `squad` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`"
+ },
+ "squad": {
+ "description": "This is a squad that will be used for the call. To use an existing squad, use `squadId` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateSquadDTO"
+ }
+ ]
+ },
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow that will be used for the call. To use a transient workflow, use `workflow` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`"
+ },
+ "workflow": {
+ "description": "This is a workflow that will be used for the call. To use an existing workflow, use `workflowId` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateWorkflowDTO"
+ }
+ ]
+ },
+ "workflowOverrides": {
+ "description": "These are the overrides for the `workflow` or `workflowId`'s settings and template variables.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/WorkflowOverrides"
+ }
+ ]
+ },
+ "phoneNumberId": {
+ "type": "string",
+ "description": "This is the phone number that will be used for the call. To use a transient number, use `phoneNumber` instead.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type."
+ },
+ "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"
+ }
+ ]
+ },
+ "customerId": {
+ "type": "string",
+ "description": "This is the customer that will be called. To call a transient customer , use `customer` instead.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type."
+ },
+ "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"
+ }
+ ]
+ }
+ }
+ },
+ "PaginationMeta": {
+ "type": "object",
+ "properties": {
+ "itemsPerPage": {
+ "type": "number"
+ },
+ "totalItems": {
+ "type": "number"
+ },
+ "currentPage": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "itemsPerPage",
+ "totalItems",
+ "currentPage"
+ ]
+ },
+ "CallPaginatedResponse": {
+ "type": "object",
+ "properties": {
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Call"
+ }
+ },
+ "metadata": {
+ "$ref": "#/components/schemas/PaginationMeta"
+ }
+ },
+ "required": [
+ "results",
+ "metadata"
+ ]
+ },
+ "CreateOutboundCallDTO": {
+ "type": "object",
+ "properties": {
+ "customers": {
+ "description": "This is used to issue batch calls to multiple customers.\n\nOnly relevant for `outboundPhoneCall`. To call a single customer, use `customer` instead.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ }
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of the call. This is just for your own reference.",
+ "maxLength": 40
+ },
+ "schedulePlan": {
+ "description": "This is the schedule plan of the call.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SchedulePlan"
+ }
+ ]
+ },
+ "transport": {
+ "type": "object",
+ "description": "This is the transport of the call."
+ },
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant ID that will be used for the call. To use a transient assistant, use `assistant` instead.\n\nTo start a call with:\n- Assistant, use `assistantId` or `assistant`\n- Squad, use `squadId` or `squad`\n- Workflow, use `workflowId` or `workflow`"
+ },
+ "assistant": {
+ "description": "This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead.\n\nTo start a call with:\n- Assistant, use `assistant`\n- Squad, use `squad`\n- Workflow, use `workflow`",
+ "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"
+ }
+ ]
+ },
+ "squadId": {
+ "type": "string",
+ "description": "This is the squad that will be used for the call. To use a transient squad, use `squad` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`"
+ },
+ "squad": {
+ "description": "This is a squad that will be used for the call. To use an existing squad, use `squadId` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateSquadDTO"
+ }
+ ]
+ },
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow that will be used for the call. To use a transient workflow, use `workflow` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`"
+ },
+ "workflow": {
+ "description": "This is a workflow that will be used for the call. To use an existing workflow, use `workflowId` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateWorkflowDTO"
+ }
+ ]
+ },
+ "workflowOverrides": {
+ "description": "These are the overrides for the `workflow` or `workflowId`'s settings and template variables.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/WorkflowOverrides"
+ }
+ ]
+ },
+ "phoneNumberId": {
+ "type": "string",
+ "description": "This is the phone number that will be used for the call. To use a transient number, use `phoneNumber` instead.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type."
+ },
+ "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"
+ }
+ ]
+ },
+ "customerId": {
+ "type": "string",
+ "description": "This is the customer that will be called. To call a transient customer , use `customer` instead.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type."
+ },
+ "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"
+ }
+ ]
+ }
+ }
+ },
+ "CreateWebCallDTO": {
+ "type": "object",
+ "properties": {
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant ID that will be used for the call. To use a transient assistant, use `assistant` instead.\n\nTo start a call with:\n- Assistant, use `assistantId` or `assistant`\n- Squad, use `squadId` or `squad`\n- Workflow, use `workflowId` or `workflow`"
+ },
+ "assistant": {
+ "description": "This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead.\n\nTo start a call with:\n- Assistant, use `assistant`\n- Squad, use `squad`\n- Workflow, use `workflow`",
+ "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"
+ }
+ ]
+ },
+ "squadId": {
+ "type": "string",
+ "description": "This is the squad that will be used for the call. To use a transient squad, use `squad` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`"
+ },
+ "squad": {
+ "description": "This is a squad that will be used for the call. To use an existing squad, use `squadId` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateSquadDTO"
+ }
+ ]
+ },
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow that will be used for the call. To use a transient workflow, use `workflow` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`"
+ },
+ "workflow": {
+ "description": "This is a workflow that will be used for the call. To use an existing workflow, use `workflowId` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateWorkflowDTO"
+ }
+ ]
+ },
+ "workflowOverrides": {
+ "description": "These are the overrides for the `workflow` or `workflowId`'s settings and template variables.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/WorkflowOverrides"
+ }
+ ]
+ }
+ }
+ },
+ "UpdateCallDTO": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "This is the name of the call. This is just for your own reference.",
+ "maxLength": 40
+ }
+ }
+ },
+ "DeveloperMessage": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "description": "This is the role of the message author",
+ "default": "developer",
+ "enum": [
+ "developer"
+ ]
+ },
+ "content": {
+ "type": "string",
+ "description": "This is the content of the developer message",
+ "maxLength": 10000
+ },
+ "name": {
+ "type": "string",
+ "description": "This is an optional name for the participant",
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "role",
+ "content"
+ ]
+ },
+ "SystemMessage": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "description": "The role of the system in the conversation."
+ },
+ "message": {
+ "type": "string",
+ "description": "The message content from the system."
+ },
+ "time": {
+ "type": "number",
+ "description": "The timestamp when the message was sent."
+ },
+ "secondsFromStart": {
+ "type": "number",
+ "description": "The number of seconds from the start of the conversation."
+ }
+ },
+ "required": [
+ "role",
+ "message",
+ "time",
+ "secondsFromStart"
+ ]
+ },
+ "UserMessage": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "description": "The role of the user in the conversation."
+ },
+ "message": {
+ "type": "string",
+ "description": "The message content from the user."
+ },
+ "time": {
+ "type": "number",
+ "description": "The timestamp when the message was sent."
+ },
+ "endTime": {
+ "type": "number",
+ "description": "The timestamp when the message ended."
+ },
+ "secondsFromStart": {
+ "type": "number",
+ "description": "The number of seconds from the start of the conversation."
+ },
+ "duration": {
+ "type": "number",
+ "description": "The duration of the message in seconds."
+ }
+ },
+ "required": [
+ "role",
+ "message",
+ "time",
+ "endTime",
+ "secondsFromStart"
+ ]
+ },
+ "ToolCallFunction": {
+ "type": "object",
+ "properties": {
+ "arguments": {
+ "type": "string",
+ "description": "This is the arguments to call the function with"
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of the function to call",
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "arguments",
+ "name"
+ ]
+ },
+ "ToolCall": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This is the ID of the tool call"
+ },
+ "type": {
+ "type": "string",
+ "description": "This is the type of tool"
+ },
+ "function": {
+ "description": "This is the function that was called",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ToolCallFunction"
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "type",
+ "function"
+ ]
+ },
+ "AssistantMessage": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "description": "This is the role of the message author",
+ "default": "assistant",
+ "enum": [
+ "assistant"
+ ]
+ },
+ "content": {
+ "type": "string",
+ "description": "This is the content of the assistant message",
+ "maxLength": 10000
+ },
+ "refusal": {
+ "type": "string",
+ "description": "This is the refusal message generated by the model",
+ "maxLength": 10000
+ },
+ "tool_calls": {
+ "description": "This is the tool calls generated by the model",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ToolCall"
+ }
+ },
+ "name": {
+ "type": "string",
+ "description": "This is an optional name for the participant",
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "role"
+ ]
+ },
+ "ToolMessage": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "description": "This is the role of the message author",
+ "default": "tool",
+ "enum": [
+ "tool"
+ ]
+ },
+ "content": {
+ "type": "string",
+ "description": "This is the content of the tool message",
+ "maxLength": 10000
+ },
+ "tool_call_id": {
+ "type": "string",
+ "description": "This is the ID of the tool call this message is responding to"
+ },
+ "name": {
+ "type": "string",
+ "description": "This is an optional name for the participant",
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "role",
+ "content",
+ "tool_call_id"
+ ]
+ },
+ "FunctionCall": {
+ "type": "object",
+ "properties": {
+ "arguments": {
+ "type": "string",
+ "description": "This is the arguments to call the function with"
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of the function to call",
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "arguments",
+ "name"
+ ]
+ },
+ "Chat": {
+ "type": "object",
+ "properties": {
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant that will be used for the chat. To use an existing assistant, use `assistantId` instead."
+ },
+ "assistant": {
+ "description": "This is the assistant that will be used for the chat. To use an existing assistant, use `assistantId` instead.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateAssistantDTO"
+ }
+ ]
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of the chat. This is just for your own reference.",
+ "maxLength": 40
+ },
+ "sessionId": {
+ "type": "string",
+ "description": "This is the ID of the session that will be used for the chat.\nMutually exclusive with previousChatId."
+ },
+ "input": {
+ "description": "This is the input text for the chat.\nCan be a string or an array of chat messages.",
+ "oneOf": [
+ {
+ "type": "string",
+ "title": "String"
+ },
+ {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/SystemMessage",
+ "title": "SystemMessage"
+ },
+ {
+ "$ref": "#/components/schemas/UserMessage",
+ "title": "UserMessage"
+ },
+ {
+ "$ref": "#/components/schemas/AssistantMessage",
+ "title": "AssistantMessage"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessage",
+ "title": "ToolMessage"
+ },
+ {
+ "$ref": "#/components/schemas/DeveloperMessage",
+ "title": "DeveloperMessage"
+ }
+ ]
+ },
+ "title": "MessageArray"
+ }
+ ],
+ "examples": [
+ "Hello, how can you help me?",
+ [
+ {
+ "role": "user",
+ "content": "Hello, how can you help me?"
+ }
+ ]
+ ]
+ },
+ "stream": {
+ "type": "boolean",
+ "description": "This is a flag that determines whether the response should be streamed.\nWhen true, the response will be sent as chunks of text.",
+ "default": false
+ },
+ "previousChatId": {
+ "type": "string",
+ "description": "This is the ID of the chat that will be used as context for the new chat.\nThe messages from the previous chat will be used as context.\nMutually exclusive with sessionId."
+ },
+ "id": {
+ "type": "string",
+ "description": "This is the unique identifier for the chat."
+ },
+ "orgId": {
+ "type": "string",
+ "description": "This is the unique identifier for the org that this chat belongs to."
+ },
+ "messages": {
+ "type": "array",
+ "description": "This is an array of messages used as context for the chat.\nUsed to provide message history for multi-turn conversations.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/SystemMessage",
+ "title": "SystemMessage"
+ },
+ {
+ "$ref": "#/components/schemas/UserMessage",
+ "title": "UserMessage"
+ },
+ {
+ "$ref": "#/components/schemas/AssistantMessage",
+ "title": "AssistantMessage"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessage",
+ "title": "ToolMessage"
+ },
+ {
+ "$ref": "#/components/schemas/DeveloperMessage",
+ "title": "DeveloperMessage"
+ }
+ ]
+ }
+ },
+ "output": {
+ "type": "array",
+ "description": "This is the output messages generated by the system in response to the input.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/SystemMessage",
+ "title": "SystemMessage"
+ },
+ {
+ "$ref": "#/components/schemas/UserMessage",
+ "title": "UserMessage"
+ },
+ {
+ "$ref": "#/components/schemas/AssistantMessage",
+ "title": "AssistantMessage"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessage",
+ "title": "ToolMessage"
+ },
+ {
+ "$ref": "#/components/schemas/DeveloperMessage",
+ "title": "DeveloperMessage"
+ }
+ ]
+ }
+ },
+ "createdAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the chat was created."
+ },
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the chat was last updated."
+ },
+ "costs": {
+ "type": "array",
+ "description": "These are the costs of individual components of the chat in USD.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ModelCost",
+ "title": "ModelCost"
+ },
+ {
+ "$ref": "#/components/schemas/ChatCost",
+ "title": "ChatCost"
+ }
+ ]
+ }
+ },
+ "assistantOverrides": {
+ "description": "These are the overrides for the `assistant` or `assistantId`'s settings and template variables.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AssistantOverrides"
+ }
+ ]
+ },
+ "cost": {
+ "type": "number",
+ "description": "This is the cost of the chat in USD."
+ }
+ },
+ "required": [
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt"
+ ]
+ },
+ "CreateChatDTO": {
+ "type": "object",
+ "properties": {
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant that will be used for the chat. To use an existing assistant, use `assistantId` instead."
+ },
+ "assistant": {
+ "description": "This is the assistant that will be used for the chat. To use an existing assistant, use `assistantId` instead.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateAssistantDTO"
+ }
+ ]
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of the chat. This is just for your own reference.",
+ "maxLength": 40
+ },
+ "sessionId": {
+ "type": "string",
+ "description": "This is the ID of the session that will be used for the chat.\nMutually exclusive with previousChatId."
+ },
+ "input": {
+ "description": "This is the input text for the chat.\nCan be a string or an array of chat messages.\nThis field is REQUIRED for chat creation.",
+ "oneOf": [
+ {
+ "type": "string",
+ "title": "String"
+ },
+ {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/SystemMessage",
+ "title": "SystemMessage"
+ },
+ {
+ "$ref": "#/components/schemas/UserMessage",
+ "title": "UserMessage"
+ },
+ {
+ "$ref": "#/components/schemas/AssistantMessage",
+ "title": "AssistantMessage"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessage",
+ "title": "ToolMessage"
+ },
+ {
+ "$ref": "#/components/schemas/DeveloperMessage",
+ "title": "DeveloperMessage"
+ }
+ ]
+ },
+ "title": "MessageArray"
+ }
+ ],
+ "examples": [
+ "Hello, how can you help me?",
+ [
+ {
+ "role": "user",
+ "content": "Hello, how can you help me?"
+ }
+ ]
+ ]
+ },
+ "stream": {
+ "type": "boolean",
+ "description": "This is a flag that determines whether the response should be streamed.\nWhen true, the response will be sent as chunks of text.",
+ "default": false
+ },
+ "previousChatId": {
+ "type": "string",
+ "description": "This is the ID of the chat that will be used as context for the new chat.\nThe messages from the previous chat will be used as context.\nMutually exclusive with sessionId."
+ },
+ "assistantOverrides": {
+ "description": "These are the overrides for the `assistant` or `assistantId`'s settings and template variables.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AssistantOverrides"
+ }
+ ]
+ }
+ },
+ "required": [
+ "input"
+ ]
+ },
+ "GetChatPaginatedDTO": {
+ "type": "object",
+ "properties": {
+ "assistantId": {
+ "type": "string",
+ "description": "This is the unique identifier for the assistant that will be used for the chat."
+ },
+ "workflowId": {
+ "type": "string",
+ "description": "This is the unique identifier for the workflow that will be used for the chat."
+ },
+ "sessionId": {
+ "type": "string",
+ "description": "This is the unique identifier for the session that will be used for the chat."
+ },
+ "page": {
+ "type": "number",
+ "description": "This is the page number to return. Defaults to 1.",
+ "minimum": 1
+ },
+ "sortOrder": {
+ "type": "string",
+ "description": "This is the sort order for pagination. Defaults to 'DESC'.",
+ "enum": [
+ "ASC",
+ "DESC"
+ ]
+ },
+ "limit": {
+ "type": "number",
+ "description": "This is the maximum number of items to return. Defaults to 100.",
+ "minimum": 0,
+ "maximum": 1000
+ },
+ "createdAtGt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This will return items where the createdAt is greater than the specified value."
+ },
+ "createdAtLt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This will return items where the createdAt is less than the specified value."
+ },
+ "createdAtGe": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This will return items where the createdAt is greater than or equal to the specified value."
+ },
+ "createdAtLe": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This will return items where the createdAt is less than or equal to the specified value."
+ },
+ "updatedAtGt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This will return items where the updatedAt is greater than the specified value."
+ },
+ "updatedAtLt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This will return items where the updatedAt is less than the specified value."
+ },
+ "updatedAtGe": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This will return items where the updatedAt is greater than or equal to the specified value."
+ },
+ "updatedAtLe": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This will return items where the updatedAt is less than or equal to the specified value."
+ }
+ }
+ },
+ "ChatPaginatedResponse": {
+ "type": "object",
+ "properties": {
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Chat"
+ }
+ },
+ "metadata": {
+ "$ref": "#/components/schemas/PaginationMeta"
+ }
+ },
+ "required": [
+ "results",
+ "metadata"
+ ]
+ },
+ "CreateChatStreamResponse": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This is the unique identifier for the streaming response."
+ },
+ "path": {
+ "type": "string",
+ "description": "This is the path to the content being updated.\nFormat: `chat.output[{contentIndex}].content` where contentIndex identifies the specific content item.",
+ "example": "chat.output[0].content"
+ },
+ "delta": {
+ "type": "string",
+ "description": "This is the incremental content chunk being streamed."
+ }
+ },
+ "required": [
+ "id",
+ "path",
+ "delta"
+ ]
+ },
+ "OpenAIResponsesRequest": {
+ "type": "object",
+ "properties": {
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant that will be used for the chat. To use an existing assistant, use `assistantId` instead."
+ },
+ "assistant": {
+ "description": "This is the assistant that will be used for the chat. To use an existing assistant, use `assistantId` instead.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateAssistantDTO"
+ }
+ ]
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of the chat. This is just for your own reference.",
+ "maxLength": 40
+ },
+ "sessionId": {
+ "type": "string",
+ "description": "This is the ID of the session that will be used for the chat.\nMutually exclusive with previousChatId."
+ },
+ "input": {
+ "description": "This is the input text for the chat.\nCan be a string or an array of chat messages.\nThis field is REQUIRED for chat creation.",
+ "oneOf": [
+ {
+ "type": "string",
+ "title": "String"
+ },
+ {
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/SystemMessage",
+ "title": "SystemMessage"
+ },
+ {
+ "$ref": "#/components/schemas/UserMessage",
+ "title": "UserMessage"
+ },
+ {
+ "$ref": "#/components/schemas/AssistantMessage",
+ "title": "AssistantMessage"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessage",
+ "title": "ToolMessage"
+ },
+ {
+ "$ref": "#/components/schemas/DeveloperMessage",
+ "title": "DeveloperMessage"
+ }
+ ]
+ },
+ "title": "MessageArray"
+ }
+ ],
+ "examples": [
+ "Hello, how can you help me?",
+ [
+ {
+ "role": "user",
+ "content": "Hello, how can you help me?"
+ }
+ ]
+ ]
+ },
+ "stream": {
+ "type": "boolean",
+ "description": "Whether to stream the response or not.",
+ "default": true
+ },
+ "previousChatId": {
+ "type": "string",
+ "description": "This is the ID of the chat that will be used as context for the new chat.\nThe messages from the previous chat will be used as context.\nMutually exclusive with sessionId."
+ },
+ "assistantOverrides": {
+ "description": "These are the overrides for the `assistant` or `assistantId`'s settings and template variables.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AssistantOverrides"
+ }
+ ]
+ }
+ },
+ "required": [
+ "input"
+ ]
+ },
+ "ResponseOutputText": {
+ "type": "object",
+ "properties": {
+ "annotations": {
+ "default": [],
+ "description": "Annotations in the text output",
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ },
+ "text": {
+ "type": "string",
+ "description": "The text output from the model"
+ },
+ "type": {
+ "type": "string",
+ "default": "output_text",
+ "description": "The type of the output text",
+ "enum": [
+ "output_text"
+ ]
+ }
+ },
+ "required": [
+ "annotations",
+ "text",
+ "type"
+ ]
+ },
+ "ResponseOutputMessage": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The unique ID of the output message"
+ },
+ "content": {
+ "description": "Content of the output message",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ResponseOutputText"
+ }
+ },
+ "role": {
+ "type": "string",
+ "default": "assistant",
+ "description": "The role of the output message",
+ "enum": [
+ "assistant"
+ ]
+ },
+ "status": {
+ "type": "string",
+ "description": "The status of the message",
+ "enum": [
+ "in_progress",
+ "completed",
+ "incomplete"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "default": "message",
+ "description": "The type of the output message",
+ "enum": [
+ "message"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "content",
+ "role",
+ "status",
+ "type"
+ ]
+ },
+ "ResponseObject": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique identifier for this Response"
+ },
+ "object": {
+ "type": "string",
+ "default": "response",
+ "description": "The object type",
+ "enum": [
+ "response"
+ ]
+ },
+ "created_at": {
+ "type": "number",
+ "description": "Unix timestamp (in seconds) of when this Response was created"
+ },
+ "status": {
+ "type": "string",
+ "description": "Status of the response",
+ "enum": [
+ "completed",
+ "failed",
+ "in_progress",
+ "incomplete"
+ ]
+ },
+ "error": {
+ "type": "string",
+ "nullable": true,
+ "default": null,
+ "description": "Error message if the response failed"
+ },
+ "output": {
+ "description": "Output messages from the model",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ResponseOutputMessage"
+ }
+ }
+ },
+ "required": [
+ "id",
+ "object",
+ "created_at",
+ "status",
+ "output"
+ ]
+ },
+ "ResponseTextDeltaEvent": {
+ "type": "object",
+ "properties": {
+ "content_index": {
+ "type": "number",
+ "description": "Index of the content part"
+ },
+ "delta": {
+ "type": "string",
+ "description": "Text delta being added"
+ },
+ "item_id": {
+ "type": "string",
+ "description": "ID of the output item"
+ },
+ "output_index": {
+ "type": "number",
+ "description": "Index of the output item"
+ },
+ "type": {
+ "type": "string",
+ "default": "response.output_text.delta",
+ "description": "Event type",
+ "enum": [
+ "response.output_text.delta"
+ ]
+ }
+ },
+ "required": [
+ "content_index",
+ "delta",
+ "item_id",
+ "output_index",
+ "type"
+ ]
+ },
+ "ResponseTextDoneEvent": {
+ "type": "object",
+ "properties": {
+ "content_index": {
+ "type": "number",
+ "description": "Index of the content part"
+ },
+ "item_id": {
+ "type": "string",
+ "description": "ID of the output item"
+ },
+ "output_index": {
+ "type": "number",
+ "description": "Index of the output item"
+ },
+ "text": {
+ "type": "string",
+ "description": "Complete text content"
+ },
+ "type": {
+ "type": "string",
+ "default": "response.output_text.done",
+ "description": "Event type",
+ "enum": [
+ "response.output_text.done"
+ ]
+ }
+ },
+ "required": [
+ "content_index",
+ "item_id",
+ "output_index",
+ "text",
+ "type"
+ ]
+ },
+ "ResponseCompletedEvent": {
+ "type": "object",
+ "properties": {
+ "response": {
+ "description": "The completed response",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ResponseObject"
+ }
+ ]
+ },
+ "type": {
+ "type": "string",
+ "default": "response.completed",
+ "description": "Event type",
+ "enum": [
+ "response.completed"
+ ]
+ }
+ },
+ "required": [
+ "response",
+ "type"
+ ]
+ },
+ "ResponseErrorEvent": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "default": "error",
+ "description": "Event type",
+ "enum": [
+ "error"
+ ]
+ },
+ "code": {
+ "type": "string",
+ "description": "Error code",
+ "example": "ERR_SOMETHING"
+ },
+ "message": {
+ "type": "string",
+ "description": "Error message",
+ "example": "Something went wrong"
+ },
+ "param": {
+ "type": "string",
+ "nullable": true,
+ "description": "Parameter that caused the error"
+ },
+ "sequence_number": {
+ "type": "number",
+ "description": "Sequence number of the event",
+ "example": 1
+ }
+ },
+ "required": [
+ "type",
+ "code",
+ "message",
+ "sequence_number"
+ ]
+ },
+ "CreateCampaignDTO": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "This is the name of the campaign. This is just for your own reference.",
+ "example": "Q2 Sales Campaign"
+ },
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant ID that will be used for the campaign calls. Note: Either assistantId or workflowId can be used, but not both."
+ },
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow ID that will be used for the campaign calls. Note: Either assistantId or workflowId can be used, but not both."
+ },
+ "phoneNumberId": {
+ "type": "string",
+ "description": "This is the phone number ID that will be used for the campaign calls."
+ },
+ "schedulePlan": {
+ "description": "This is the schedule plan for the campaign.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SchedulePlan"
+ }
+ ]
+ },
+ "customers": {
+ "description": "These are the customers that will be called in the campaign.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ }
+ }
+ },
+ "required": [
+ "name",
+ "phoneNumberId",
+ "schedulePlan",
+ "customers"
+ ]
+ },
+ "Campaign": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "This is the status of the campaign.",
+ "enum": [
+ "scheduled",
+ "in-progress",
+ "ended"
+ ]
+ },
+ "endedReason": {
+ "type": "string",
+ "description": "This is the explanation for how the campaign ended.",
+ "enum": [
+ "campaign.scheduled.ended-by-user",
+ "campaign.in-progress.ended-by-user",
+ "campaign.ended.success"
+ ]
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of the campaign. This is just for your own reference.",
+ "example": "Q2 Sales Campaign"
+ },
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant ID that will be used for the campaign calls. Note: Either assistantId or workflowId can be used, but not both."
+ },
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow ID that will be used for the campaign calls. Note: Either assistantId or workflowId can be used, but not both."
+ },
+ "phoneNumberId": {
+ "type": "string",
+ "description": "This is the phone number ID that will be used for the campaign calls."
+ },
+ "schedulePlan": {
+ "description": "This is the schedule plan for the campaign.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SchedulePlan"
+ }
+ ]
+ },
+ "customers": {
+ "description": "These are the customers that will be called in the campaign.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ }
+ },
+ "id": {
+ "type": "string",
+ "description": "This is the unique identifier for the campaign."
+ },
+ "orgId": {
+ "type": "string",
+ "description": "This is the unique identifier for the org that this campaign belongs to."
+ },
+ "createdAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the campaign was created."
+ },
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the campaign was last updated."
+ },
+ "calls": {
+ "type": "object",
+ "description": "This is a map of call IDs to campaign call details."
+ },
+ "callsCounterScheduled": {
+ "type": "number",
+ "description": "This is the number of calls that have been scheduled."
+ },
+ "callsCounterQueued": {
+ "type": "number",
+ "description": "This is the number of calls that have been queued."
+ },
+ "callsCounterInProgress": {
+ "type": "number",
+ "description": "This is the number of calls that have been in progress."
+ },
+ "callsCounterEndedVoicemail": {
+ "type": "number",
+ "description": "This is the number of calls whose ended reason is 'voicemail'."
+ },
+ "callsCounterEnded": {
+ "type": "number",
+ "description": "This is the number of calls that have ended."
+ }
+ },
+ "required": [
+ "status",
+ "name",
+ "phoneNumberId",
+ "schedulePlan",
+ "customers",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt",
+ "calls",
+ "callsCounterScheduled",
+ "callsCounterQueued",
+ "callsCounterInProgress",
+ "callsCounterEndedVoicemail",
+ "callsCounterEnded"
+ ]
+ },
+ "UpdateCampaignDTO": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "This is the name of the campaign. This is just for your own reference."
+ },
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant ID that will be used for the campaign calls.\nCan only be updated if campaign is not in progress or has ended."
+ },
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow ID that will be used for the campaign calls.\nCan only be updated if campaign is not in progress or has ended."
+ },
+ "phoneNumberId": {
+ "type": "string",
+ "description": "This is the phone number ID that will be used for the campaign calls.\nCan only be updated if campaign is not in progress or has ended."
+ },
+ "schedulePlan": {
+ "description": "This is the schedule plan for the campaign.\nCan only be updated if campaign is not in progress or has ended.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SchedulePlan"
+ }
+ ]
+ },
+ "status": {
+ "type": "string",
+ "description": "This is the status of the campaign.\nCan only be updated to 'ended' if you want to end the campaign.\nWhen set to 'ended', it will delete all scheduled calls. Calls in progress will be allowed to complete.",
+ "enum": [
+ "ended"
+ ]
+ }
+ }
+ },
+ "Session": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This is the unique identifier for the session."
+ },
+ "orgId": {
+ "type": "string",
+ "description": "This is the unique identifier for the organization that owns this session."
+ },
+ "createdAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 timestamp indicating when the session was created."
+ },
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 timestamp indicating when the session was last updated."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is a user-defined name for the session. Maximum length is 40 characters.",
+ "maxLength": 40
+ },
+ "status": {
+ "type": "string",
+ "description": "This is the current status of the session. Can be either 'active' or 'completed'.",
+ "enum": [
+ "active",
+ "completed"
+ ]
+ },
+ "expirationSeconds": {
+ "type": "number",
+ "description": "Session expiration time in seconds. Defaults to 24 hours (86400 seconds) if not set.",
+ "minimum": 60,
+ "maximum": 2592000,
+ "example": 86400
+ },
+ "assistantId": {
+ "type": "string",
+ "description": "This is the ID of the assistant associated with this session. Use this when referencing an existing assistant."
+ },
+ "assistant": {
+ "description": "This is the assistant configuration for this session. Use this when creating a new assistant configuration.\nIf assistantId is provided, this will be ignored.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateAssistantDTO"
+ }
+ ]
+ },
+ "messages": {
+ "type": "array",
+ "description": "This is an array of chat messages in the session.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/SystemMessage",
+ "title": "SystemMessage"
+ },
+ {
+ "$ref": "#/components/schemas/UserMessage",
+ "title": "UserMessage"
+ },
+ {
+ "$ref": "#/components/schemas/AssistantMessage",
+ "title": "AssistantMessage"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessage",
+ "title": "ToolMessage"
+ },
+ {
+ "$ref": "#/components/schemas/DeveloperMessage",
+ "title": "DeveloperMessage"
+ }
+ ]
+ }
+ },
+ "customer": {
+ "description": "This is the customer information associated with this session.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ }
+ ]
+ },
+ "phoneNumberId": {
+ "type": "string",
+ "description": "This is the ID of the phone number associated with this session."
+ },
+ "phoneNumber": {
+ "description": "This is the phone number configuration for this session.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ImportTwilioPhoneNumberDTO"
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt"
+ ]
+ },
+ "CreateSessionDTO": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "This is a user-defined name for the session. Maximum length is 40 characters.",
+ "maxLength": 40
+ },
+ "status": {
+ "type": "string",
+ "description": "This is the current status of the session. Can be either 'active' or 'completed'.",
+ "enum": [
+ "active",
+ "completed"
+ ]
+ },
+ "expirationSeconds": {
+ "type": "number",
+ "description": "Session expiration time in seconds. Defaults to 24 hours (86400 seconds) if not set.",
+ "minimum": 60,
+ "maximum": 2592000,
+ "example": 86400
+ },
+ "assistantId": {
+ "type": "string",
+ "description": "This is the ID of the assistant associated with this session. Use this when referencing an existing assistant."
+ },
+ "assistant": {
+ "description": "This is the assistant configuration for this session. Use this when creating a new assistant configuration.\nIf assistantId is provided, this will be ignored.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateAssistantDTO"
+ }
+ ]
+ },
+ "messages": {
+ "type": "array",
+ "description": "This is an array of chat messages in the session.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/SystemMessage",
+ "title": "SystemMessage"
+ },
+ {
+ "$ref": "#/components/schemas/UserMessage",
+ "title": "UserMessage"
+ },
+ {
+ "$ref": "#/components/schemas/AssistantMessage",
+ "title": "AssistantMessage"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessage",
+ "title": "ToolMessage"
+ },
+ {
+ "$ref": "#/components/schemas/DeveloperMessage",
+ "title": "DeveloperMessage"
+ }
+ ]
+ }
+ },
+ "customer": {
+ "description": "This is the customer information associated with this session.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ }
+ ]
+ },
+ "phoneNumberId": {
+ "type": "string",
+ "description": "This is the ID of the phone number associated with this session."
+ },
+ "phoneNumber": {
+ "description": "This is the phone number configuration for this session.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ImportTwilioPhoneNumberDTO"
+ }
+ ]
+ }
+ }
+ },
+ "UpdateSessionDTO": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "This is the new name for the session. Maximum length is 40 characters.",
+ "maxLength": 40
+ },
+ "status": {
+ "type": "string",
+ "description": "This is the new status for the session.",
+ "enum": [
+ "active",
+ "completed"
+ ]
+ },
+ "expirationSeconds": {
+ "type": "number",
+ "description": "Session expiration time in seconds. Defaults to 24 hours (86400 seconds) if not set.",
+ "minimum": 60,
+ "maximum": 2592000,
+ "example": 86400
+ },
+ "messages": {
+ "type": "array",
+ "description": "This is the updated array of chat messages.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/SystemMessage",
+ "title": "SystemMessage"
+ },
+ {
+ "$ref": "#/components/schemas/UserMessage",
+ "title": "UserMessage"
+ },
+ {
+ "$ref": "#/components/schemas/AssistantMessage",
+ "title": "AssistantMessage"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessage",
+ "title": "ToolMessage"
+ },
+ {
+ "$ref": "#/components/schemas/DeveloperMessage",
+ "title": "DeveloperMessage"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "GetSessionPaginatedDTO": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "This is the name of the session to filter by."
+ },
+ "assistantId": {
+ "type": "string",
+ "description": "This is the ID of the assistant to filter sessions by."
+ },
+ "workflowId": {
+ "type": "string",
+ "description": "This is the ID of the workflow to filter sessions by."
+ },
+ "page": {
+ "type": "number",
+ "description": "This is the page number to return. Defaults to 1.",
+ "minimum": 1
+ },
+ "sortOrder": {
+ "type": "string",
+ "description": "This is the sort order for pagination. Defaults to 'DESC'.",
+ "enum": [
+ "ASC",
+ "DESC"
+ ]
+ },
+ "limit": {
+ "type": "number",
+ "description": "This is the maximum number of items to return. Defaults to 100.",
+ "minimum": 0,
+ "maximum": 1000
+ },
+ "createdAtGt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This will return items where the createdAt is greater than the specified value."
+ },
+ "createdAtLt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This will return items where the createdAt is less than the specified value."
+ },
+ "createdAtGe": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This will return items where the createdAt is greater than or equal to the specified value."
+ },
+ "createdAtLe": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This will return items where the createdAt is less than or equal to the specified value."
+ },
+ "updatedAtGt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This will return items where the updatedAt is greater than the specified value."
+ },
+ "updatedAtLt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This will return items where the updatedAt is less than the specified value."
+ },
+ "updatedAtGe": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This will return items where the updatedAt is greater than or equal to the specified value."
+ },
+ "updatedAtLe": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This will return items where the updatedAt is less than or equal to the specified value."
+ }
+ }
+ },
+ "SessionPaginatedResponse": {
+ "type": "object",
+ "properties": {
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Session"
+ }
+ },
+ "metadata": {
+ "$ref": "#/components/schemas/PaginationMeta"
+ }
+ },
+ "required": [
+ "results",
+ "metadata"
+ ]
+ },
+ "Assistant": {
+ "type": "object",
+ "properties": {
+ "transcriber": {
+ "description": "These are the options for the assistant's transcriber.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AssemblyAITranscriber",
+ "title": "AssemblyAITranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/AzureSpeechTranscriber",
+ "title": "AzureSpeechTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/CustomTranscriber",
+ "title": "CustomTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/DeepgramTranscriber",
+ "title": "DeepgramTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/ElevenLabsTranscriber",
+ "title": "ElevenLabsTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/GladiaTranscriber",
+ "title": "GladiaTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleTranscriber",
+ "title": "GoogleTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/SpeechmaticsTranscriber",
+ "title": "SpeechmaticsTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/TalkscriberTranscriber",
+ "title": "TalkscriberTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAITranscriber",
+ "title": "OpenAITranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/CartesiaTranscriber",
+ "title": "CartesiaTranscriber"
+ }
+ ]
+ },
+ "model": {
+ "description": "These are the options for the assistant's LLM.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AnthropicModel",
+ "title": "Anthropic"
+ },
+ {
+ "$ref": "#/components/schemas/AnyscaleModel",
+ "title": "Anyscale"
+ },
+ {
+ "$ref": "#/components/schemas/CerebrasModel",
+ "title": "Cerebras"
+ },
+ {
+ "$ref": "#/components/schemas/CustomLLMModel",
+ "title": "CustomLLM"
+ },
+ {
+ "$ref": "#/components/schemas/DeepInfraModel",
+ "title": "DeepInfra"
+ },
+ {
+ "$ref": "#/components/schemas/DeepSeekModel",
+ "title": "DeepSeek"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleModel",
+ "title": "Google"
+ },
+ {
+ "$ref": "#/components/schemas/GroqModel",
+ "title": "Groq"
+ },
+ {
+ "$ref": "#/components/schemas/InflectionAIModel",
+ "title": "InflectionAI"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAIModel",
+ "title": "OpenAI"
+ },
+ {
+ "$ref": "#/components/schemas/OpenRouterModel",
+ "title": "OpenRouter"
+ },
+ {
+ "$ref": "#/components/schemas/PerplexityAIModel",
+ "title": "PerplexityAI"
+ },
+ {
+ "$ref": "#/components/schemas/TogetherAIModel",
+ "title": "Together"
+ },
+ {
+ "$ref": "#/components/schemas/XaiModel",
+ "title": "XAI"
+ }
+ ]
+ },
+ "voice": {
+ "description": "These are the options for the assistant's voice.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AzureVoice",
+ "title": "AzureVoice"
+ },
+ {
+ "$ref": "#/components/schemas/CartesiaVoice",
+ "title": "CartesiaVoice"
+ },
+ {
+ "$ref": "#/components/schemas/CustomVoice",
+ "title": "CustomVoice"
+ },
+ {
+ "$ref": "#/components/schemas/DeepgramVoice",
+ "title": "DeepgramVoice"
+ },
+ {
+ "$ref": "#/components/schemas/ElevenLabsVoice",
+ "title": "ElevenLabsVoice"
+ },
+ {
+ "$ref": "#/components/schemas/HumeVoice",
+ "title": "HumeVoice"
+ },
+ {
+ "$ref": "#/components/schemas/LMNTVoice",
+ "title": "LMNTVoice"
+ },
+ {
+ "$ref": "#/components/schemas/NeuphonicVoice",
+ "title": "NeuphonicVoice"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAIVoice",
+ "title": "OpenAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/PlayHTVoice",
+ "title": "PlayHTVoice"
+ },
+ {
+ "$ref": "#/components/schemas/RimeAIVoice",
+ "title": "RimeAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/SmallestAIVoice",
+ "title": "SmallestAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/TavusVoice",
+ "title": "TavusVoice"
+ },
+ {
+ "$ref": "#/components/schemas/VapiVoice",
+ "title": "VapiVoice"
+ },
+ {
+ "$ref": "#/components/schemas/SesameVoice",
+ "title": "SesameVoice"
+ }
+ ]
+ },
+ "firstMessage": {
+ "type": "string",
+ "description": "This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).\n\nIf unspecified, assistant will wait for user to speak and use the model to respond once they speak.",
+ "example": "Hello! How can I help you today?"
+ },
+ "firstMessageInterruptionsEnabled": {
+ "type": "boolean",
+ "default": false
+ },
+ "firstMessageMode": {
+ "type": "string",
+ "description": "This is the mode for the first message. Default is 'assistant-speaks-first'.\n\nUse:\n- 'assistant-speaks-first' to have the assistant speak first.\n- 'assistant-waits-for-user' to have the assistant wait for the user to speak first.\n- 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points).\n\n@default 'assistant-speaks-first'",
+ "enum": [
+ "assistant-speaks-first",
+ "assistant-speaks-first-with-model-generated-message",
+ "assistant-waits-for-user"
+ ],
+ "example": "assistant-speaks-first"
+ },
+ "voicemailDetection": {
+ "description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/GoogleVoicemailDetectionPlan",
+ "title": "Google"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAIVoicemailDetectionPlan",
+ "title": "OpenAI"
+ },
+ {
+ "$ref": "#/components/schemas/TwilioVoicemailDetectionPlan",
+ "title": "Twilio"
+ },
+ {
+ "$ref": "#/components/schemas/VapiVoicemailDetectionPlan",
+ "title": "Vapi"
+ }
+ ]
+ },
+ "clientMessages": {
+ "type": "array",
+ "enum": [
+ "conversation-update",
+ "function-call",
+ "function-call-result",
+ "hang",
+ "language-changed",
+ "metadata",
+ "model-output",
+ "speech-update",
+ "status-update",
+ "transcript",
+ "tool-calls",
+ "tool-calls-result",
+ "tool.completed",
+ "transfer-update",
+ "user-interrupted",
+ "voice-input",
+ "workflow.node.started"
+ ],
+ "example": [
+ "conversation-update",
+ "function-call",
+ "hang",
+ "model-output",
+ "speech-update",
+ "status-update",
+ "transfer-update",
+ "transcript",
+ "tool-calls",
+ "user-interrupted",
+ "voice-input",
+ "workflow.node.started"
+ ],
+ "description": "These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started. You can check the shape of the messages in ClientMessage schema.",
+ "items": {
+ "type": "string",
+ "enum": [
+ "conversation-update",
+ "function-call",
+ "function-call-result",
+ "hang",
+ "language-changed",
+ "metadata",
+ "model-output",
+ "speech-update",
+ "status-update",
+ "transcript",
+ "tool-calls",
+ "tool-calls-result",
+ "tool.completed",
+ "transfer-update",
+ "user-interrupted",
+ "voice-input",
+ "workflow.node.started"
+ ]
+ }
+ },
+ "serverMessages": {
+ "type": "array",
+ "enum": [
+ "conversation-update",
+ "end-of-call-report",
+ "function-call",
+ "hang",
+ "language-changed",
+ "language-change-detected",
+ "model-output",
+ "phone-call-control",
+ "speech-update",
+ "status-update",
+ "transcript",
+ "transcript[transcriptType=\"final\"]",
+ "tool-calls",
+ "transfer-destination-request",
+ "transfer-update",
+ "user-interrupted",
+ "voice-input"
+ ],
+ "example": [
+ "conversation-update",
+ "end-of-call-report",
+ "function-call",
+ "hang",
+ "speech-update",
+ "status-update",
+ "tool-calls",
+ "transfer-destination-request",
+ "user-interrupted"
+ ],
+ "description": "These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,user-interrupted. You can check the shape of the messages in ServerMessage schema.",
+ "items": {
+ "type": "string",
+ "enum": [
+ "conversation-update",
+ "end-of-call-report",
+ "function-call",
+ "hang",
+ "language-changed",
+ "language-change-detected",
+ "model-output",
+ "phone-call-control",
+ "speech-update",
+ "status-update",
+ "transcript",
+ "transcript[transcriptType=\"final\"]",
+ "tool-calls",
+ "transfer-destination-request",
+ "transfer-update",
+ "user-interrupted",
+ "voice-input"
+ ]
+ }
+ },
+ "silenceTimeoutSeconds": {
+ "type": "number",
+ "description": "How many seconds of silence to wait before ending the call. Defaults to 30.\n\n@default 30",
+ "minimum": 10,
+ "maximum": 3600,
+ "example": 30
+ },
+ "maxDurationSeconds": {
+ "type": "number",
+ "description": "This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.\n\n@default 600 (10 minutes)",
+ "minimum": 10,
+ "maximum": 43200,
+ "example": 600
+ },
+ "backgroundSound": {
+ "description": "This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.\nYou can also provide a custom sound by providing a URL to an audio file.",
+ "oneOf": [
+ {
+ "type": "enum",
+ "enum": [
+ "off",
+ "office"
+ ],
+ "example": "office"
+ },
+ {
+ "type": "string",
+ "format": "uri",
+ "example": "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3"
+ }
+ ]
+ },
+ "backgroundDenoisingEnabled": {
+ "type": "boolean",
+ "description": "This enables filtering of noise and background speech while the user is talking.\n\nDefault `false` while in beta.\n\n@default false",
+ "deprecated": true,
+ "example": false
+ },
+ "modelOutputInMessagesEnabled": {
+ "type": "boolean",
+ "description": "This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech.\n\nDefault `false` while in beta.\n\n@default false",
+ "example": false
+ },
+ "transportConfigurations": {
+ "type": "array",
+ "description": "These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TransportConfigurationTwilio",
+ "title": "Twilio"
+ }
+ ]
+ }
+ },
+ "observabilityPlan": {
+ "description": "This is the plan for observability of assistant's calls.\n\nCurrently, only Langfuse is supported.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/LangfuseObservabilityPlan",
+ "title": "Langfuse"
+ }
+ ],
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/LangfuseObservabilityPlan"
+ }
+ ]
+ },
+ "credentials": {
+ "type": "array",
+ "description": "These are dynamic credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateAnthropicCredentialDTO",
+ "title": "AnthropicCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAnyscaleCredentialDTO",
+ "title": "AnyscaleCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAssemblyAICredentialDTO",
+ "title": "AssemblyAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAzureCredentialDTO",
+ "title": "AzureCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAzureOpenAICredentialDTO",
+ "title": "AzureOpenAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
+ "title": "ByoSipTrunkCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCartesiaCredentialDTO",
+ "title": "CartesiaCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCerebrasCredentialDTO",
+ "title": "CerebrasCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCloudflareCredentialDTO",
+ "title": "CloudflareCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCustomLLMCredentialDTO",
+ "title": "CustomLLMCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepgramCredentialDTO",
+ "title": "DeepgramCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepInfraCredentialDTO",
+ "title": "DeepInfraCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepSeekCredentialDTO",
+ "title": "DeepSeekCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateElevenLabsCredentialDTO",
+ "title": "ElevenLabsCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGcpCredentialDTO",
+ "title": "GcpCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGladiaCredentialDTO",
+ "title": "GladiaCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCredentialDTO",
+ "title": "GhlCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCredentialDTO",
+ "title": "GoogleCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGroqCredentialDTO",
+ "title": "GroqCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateHumeCredentialDTO",
+ "title": "HumeCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateInflectionAICredentialDTO",
+ "title": "InflectionAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateLangfuseCredentialDTO",
+ "title": "LangfuseCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateLmntCredentialDTO",
+ "title": "LmntCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMakeCredentialDTO",
+ "title": "MakeCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMistralCredentialDTO",
+ "title": "MistralCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateNeuphonicCredentialDTO",
+ "title": "NeuphonicCredential"
+ },
+ {
+ "$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/CreateS3CredentialDTO",
+ "title": "S3Credential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmallestAICredentialDTO",
+ "title": "SmallestAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
+ "title": "SpeechmaticsCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSupabaseCredentialDTO",
+ "title": "SupabaseCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTavusCredentialDTO",
+ "title": "TavusCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTogetherAICredentialDTO",
+ "title": "TogetherAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTrieveCredentialDTO",
+ "title": "TrieveCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioCredentialDTO",
+ "title": "TwilioCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonageCredentialDTO",
+ "title": "VonageCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateWebhookCredentialDTO",
+ "title": "WebhookCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateXAiCredentialDTO",
+ "title": "XAiCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
+ "title": "GoogleCalendarOAuth2ClientCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
+ "title": "GoogleCalendarOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
+ "title": "GoogleSheetsOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO",
+ "title": "SlackOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelMCPCredentialDTO",
+ "title": "GoHighLevelMCPCredential"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "provider",
+ "mapping": {
+ "11labs": "#/components/schemas/CreateElevenLabsCredentialDTO",
+ "anthropic": "#/components/schemas/CreateAnthropicCredentialDTO",
+ "anyscale": "#/components/schemas/CreateAnyscaleCredentialDTO",
+ "assembly-ai": "#/components/schemas/CreateAssemblyAICredentialDTO",
+ "azure-openai": "#/components/schemas/CreateAzureOpenAICredentialDTO",
+ "azure": "#/components/schemas/CreateAzureCredentialDTO",
+ "byo-sip-trunk": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
+ "cartesia": "#/components/schemas/CreateCartesiaCredentialDTO",
+ "cerebras": "#/components/schemas/CreateCerebrasCredentialDTO",
+ "cloudflare": "#/components/schemas/CreateCloudflareCredentialDTO",
+ "custom-llm": "#/components/schemas/CreateCustomLLMCredentialDTO",
+ "deepgram": "#/components/schemas/CreateDeepgramCredentialDTO",
+ "deepinfra": "#/components/schemas/CreateDeepInfraCredentialDTO",
+ "deep-seek": "#/components/schemas/CreateDeepSeekCredentialDTO",
+ "gcp": "#/components/schemas/CreateGcpCredentialDTO",
+ "gladia": "#/components/schemas/CreateGladiaCredentialDTO",
+ "gohighlevel": "#/components/schemas/CreateGoHighLevelCredentialDTO",
+ "google": "#/components/schemas/CreateGoogleCredentialDTO",
+ "groq": "#/components/schemas/CreateGroqCredentialDTO",
+ "inflection-ai": "#/components/schemas/CreateInflectionAICredentialDTO",
+ "langfuse": "#/components/schemas/CreateLangfuseCredentialDTO",
+ "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",
+ "s3": "#/components/schemas/CreateS3CredentialDTO",
+ "supabase": "#/components/schemas/CreateSupabaseCredentialDTO",
+ "smallest-ai": "#/components/schemas/CreateSmallestAICredentialDTO",
+ "tavus": "#/components/schemas/CreateTavusCredentialDTO",
+ "together-ai": "#/components/schemas/CreateTogetherAICredentialDTO",
+ "twilio": "#/components/schemas/CreateTwilioCredentialDTO",
+ "vonage": "#/components/schemas/CreateVonageCredentialDTO",
+ "webhook": "#/components/schemas/CreateWebhookCredentialDTO",
+ "xai": "#/components/schemas/CreateXAiCredentialDTO",
+ "neuphonic": "#/components/schemas/CreateNeuphonicCredentialDTO",
+ "hume": "#/components/schemas/CreateHumeCredentialDTO",
+ "mistral": "#/components/schemas/CreateMistralCredentialDTO",
+ "speechmatics": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
+ "trieve": "#/components/schemas/CreateTrieveCredentialDTO",
+ "google.calendar.oauth2-client": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
+ "google.calendar.oauth2-authorization": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
+ "google.sheets.oauth2-authorization": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
+ "slack.oauth2-authorization": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO",
+ "ghl.oauth2-authorization": "#/components/schemas/CreateGoHighLevelMCPCredentialDTO"
+ }
+ }
+ }
+ },
+ "hooks": {
+ "type": "array",
+ "description": "This is a set of actions that will be performed on certain events.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AssistantHookCallEnding",
+ "title": "AssistantHookCallEnding"
+ },
+ {
+ "$ref": "#/components/schemas/AssistantHookAssistantSpeechInterrupted",
+ "title": "AssistantHookAssistantSpeechInterrupted"
+ },
+ {
+ "$ref": "#/components/schemas/AssistantHookCustomerSpeechInterrupted",
+ "title": "AssistantHookCustomerSpeechInterrupted"
+ }
+ ]
+ }
+ },
+ "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.",
+ "maxLength": 40
+ },
+ "voicemailMessage": {
+ "type": "string",
+ "description": "This is the message that the assistant will say if the call is forwarded to voicemail.\n\nIf unspecified, it will hang up.",
+ "maxLength": 1000
+ },
+ "endCallMessage": {
+ "type": "string",
+ "description": "This is the message that the assistant will say if it ends the call.\n\nIf unspecified, it will hang up without saying anything.",
+ "maxLength": 1000
+ },
+ "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": 140,
+ "minLength": 2
+ }
+ },
+ "compliancePlan": {
+ "$ref": "#/components/schemas/CompliancePlan"
+ },
+ "metadata": {
+ "type": "object",
+ "description": "This is for metadata you want to store on the assistant."
+ },
+ "backgroundSpeechDenoisingPlan": {
+ "description": "This enables filtering of noise and background speech while the user is talking.\n\nFeatures:\n- Smart denoising using Krisp\n- Fourier denoising\n\nSmart denoising can be combined with or used independently of Fourier denoising.\n\nOrder of precedence:\n- Smart denoising\n- Fourier denoising",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BackgroundSpeechDenoisingPlan"
+ }
+ ]
+ },
+ "analysisPlan": {
+ "description": "This is the plan for analysis of assistant's calls. Stored in `call.analysis`.",
+ "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"
+ }
+ ]
+ },
+ "messagePlan": {
+ "description": "This is the plan for static predefined messages that can be spoken by the assistant during the call, like `idleMessages`.\n\nNote: `firstMessage`, `voicemailMessage`, and `endCallMessage` are currently at the root level. They will be moved to `messagePlan` in the future, but will remain backwards compatible.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MessagePlan"
+ }
+ ]
+ },
+ "startSpeakingPlan": {
+ "description": "This is the plan for when the assistant should start talking.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to start talking after the customer is done speaking.\n- The assistant is too fast to start talking after the customer is done speaking.\n- The assistant is so fast that it's actually interrupting the customer.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/StartSpeakingPlan"
+ }
+ ]
+ },
+ "stopSpeakingPlan": {
+ "description": "This is the plan for when assistant should stop talking on customer interruption.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to recognize customer's interruption.\n- The assistant is too fast to recognize customer's interruption.\n- The assistant is getting interrupted by phrases that are just acknowledgments.\n- The assistant is getting interrupted by background noises.\n- The assistant is not properly stopping -- it starts talking right after getting interrupted.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/StopSpeakingPlan"
+ }
+ ]
+ },
+ "monitorPlan": {
+ "description": "This is the plan for real-time monitoring of the assistant's calls.\n\nUsage:\n- To enable live listening of the assistant's calls, set `monitorPlan.listenEnabled` to `true`.\n- To enable live control of the assistant's calls, set `monitorPlan.controlEnabled` to `true`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MonitorPlan"
+ }
+ ]
+ },
+ "credentialIds": {
+ "description": "These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server.url\n2. phoneNumber.serverUrl\n3. org.serverUrl",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
+ },
+ "keypadInputPlan": {
+ "$ref": "#/components/schemas/KeypadInputPlan"
+ },
+ "id": {
+ "type": "string",
+ "description": "This is the unique identifier for the assistant."
+ },
+ "orgId": {
+ "type": "string",
+ "description": "This is the unique identifier for the org that this assistant belongs to."
+ },
+ "createdAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the assistant was created."
+ },
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the assistant was last updated."
+ }
+ },
+ "required": [
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt"
+ ]
+ },
+ "AssistantPaginatedResponse": {
+ "type": "object",
+ "properties": {
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Assistant"
+ }
+ },
+ "metadata": {
+ "$ref": "#/components/schemas/PaginationMeta"
+ }
+ },
+ "required": [
+ "results",
+ "metadata"
+ ]
+ },
+ "AssistantVersionPaginatedResponse": {
+ "type": "object",
+ "properties": {
+ "results": {
+ "type": "array"
+ },
+ "metadata": {
+ "$ref": "#/components/schemas/PaginationMeta"
+ },
+ "nextPageState": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "results",
+ "metadata"
+ ]
+ },
+ "UpdateAssistantDTO": {
+ "type": "object",
+ "properties": {
+ "transcriber": {
+ "description": "These are the options for the assistant's transcriber.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AssemblyAITranscriber",
+ "title": "AssemblyAITranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/AzureSpeechTranscriber",
+ "title": "AzureSpeechTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/CustomTranscriber",
+ "title": "CustomTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/DeepgramTranscriber",
+ "title": "DeepgramTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/ElevenLabsTranscriber",
+ "title": "ElevenLabsTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/GladiaTranscriber",
+ "title": "GladiaTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleTranscriber",
+ "title": "GoogleTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/SpeechmaticsTranscriber",
+ "title": "SpeechmaticsTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/TalkscriberTranscriber",
+ "title": "TalkscriberTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAITranscriber",
+ "title": "OpenAITranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/CartesiaTranscriber",
+ "title": "CartesiaTranscriber"
+ }
+ ]
+ },
+ "model": {
+ "description": "These are the options for the assistant's LLM.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AnthropicModel",
+ "title": "Anthropic"
+ },
+ {
+ "$ref": "#/components/schemas/AnyscaleModel",
+ "title": "Anyscale"
+ },
+ {
+ "$ref": "#/components/schemas/CerebrasModel",
+ "title": "Cerebras"
+ },
+ {
+ "$ref": "#/components/schemas/CustomLLMModel",
+ "title": "CustomLLM"
+ },
+ {
+ "$ref": "#/components/schemas/DeepInfraModel",
+ "title": "DeepInfra"
+ },
+ {
+ "$ref": "#/components/schemas/DeepSeekModel",
+ "title": "DeepSeek"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleModel",
+ "title": "Google"
+ },
+ {
+ "$ref": "#/components/schemas/GroqModel",
+ "title": "Groq"
+ },
+ {
+ "$ref": "#/components/schemas/InflectionAIModel",
+ "title": "InflectionAI"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAIModel",
+ "title": "OpenAI"
+ },
+ {
+ "$ref": "#/components/schemas/OpenRouterModel",
+ "title": "OpenRouter"
+ },
+ {
+ "$ref": "#/components/schemas/PerplexityAIModel",
+ "title": "PerplexityAI"
+ },
+ {
+ "$ref": "#/components/schemas/TogetherAIModel",
+ "title": "Together"
+ },
+ {
+ "$ref": "#/components/schemas/XaiModel",
+ "title": "XAI"
+ }
+ ]
+ },
+ "voice": {
+ "description": "These are the options for the assistant's voice.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AzureVoice",
+ "title": "AzureVoice"
+ },
+ {
+ "$ref": "#/components/schemas/CartesiaVoice",
+ "title": "CartesiaVoice"
+ },
+ {
+ "$ref": "#/components/schemas/CustomVoice",
+ "title": "CustomVoice"
+ },
+ {
+ "$ref": "#/components/schemas/DeepgramVoice",
+ "title": "DeepgramVoice"
+ },
+ {
+ "$ref": "#/components/schemas/ElevenLabsVoice",
+ "title": "ElevenLabsVoice"
+ },
+ {
+ "$ref": "#/components/schemas/HumeVoice",
+ "title": "HumeVoice"
+ },
+ {
+ "$ref": "#/components/schemas/LMNTVoice",
+ "title": "LMNTVoice"
+ },
+ {
+ "$ref": "#/components/schemas/NeuphonicVoice",
+ "title": "NeuphonicVoice"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAIVoice",
+ "title": "OpenAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/PlayHTVoice",
+ "title": "PlayHTVoice"
+ },
+ {
+ "$ref": "#/components/schemas/RimeAIVoice",
+ "title": "RimeAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/SmallestAIVoice",
+ "title": "SmallestAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/TavusVoice",
+ "title": "TavusVoice"
+ },
+ {
+ "$ref": "#/components/schemas/VapiVoice",
+ "title": "VapiVoice"
+ },
+ {
+ "$ref": "#/components/schemas/SesameVoice",
+ "title": "SesameVoice"
+ }
+ ]
+ },
+ "firstMessage": {
+ "type": "string",
+ "description": "This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).\n\nIf unspecified, assistant will wait for user to speak and use the model to respond once they speak.",
+ "example": "Hello! How can I help you today?"
+ },
+ "firstMessageInterruptionsEnabled": {
+ "type": "boolean",
+ "default": false
+ },
+ "firstMessageMode": {
+ "type": "string",
+ "description": "This is the mode for the first message. Default is 'assistant-speaks-first'.\n\nUse:\n- 'assistant-speaks-first' to have the assistant speak first.\n- 'assistant-waits-for-user' to have the assistant wait for the user to speak first.\n- 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points).\n\n@default 'assistant-speaks-first'",
+ "enum": [
+ "assistant-speaks-first",
+ "assistant-speaks-first-with-model-generated-message",
+ "assistant-waits-for-user"
+ ],
+ "example": "assistant-speaks-first"
+ },
+ "voicemailDetection": {
+ "description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/GoogleVoicemailDetectionPlan",
+ "title": "Google"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAIVoicemailDetectionPlan",
+ "title": "OpenAI"
+ },
+ {
+ "$ref": "#/components/schemas/TwilioVoicemailDetectionPlan",
+ "title": "Twilio"
+ },
+ {
+ "$ref": "#/components/schemas/VapiVoicemailDetectionPlan",
+ "title": "Vapi"
+ }
+ ]
+ },
+ "clientMessages": {
+ "type": "array",
+ "enum": [
+ "conversation-update",
+ "function-call",
+ "function-call-result",
+ "hang",
+ "language-changed",
+ "metadata",
+ "model-output",
+ "speech-update",
+ "status-update",
+ "transcript",
+ "tool-calls",
+ "tool-calls-result",
+ "tool.completed",
+ "transfer-update",
+ "user-interrupted",
+ "voice-input",
+ "workflow.node.started"
+ ],
+ "example": [
+ "conversation-update",
+ "function-call",
+ "hang",
+ "model-output",
+ "speech-update",
+ "status-update",
+ "transfer-update",
+ "transcript",
+ "tool-calls",
+ "user-interrupted",
+ "voice-input",
+ "workflow.node.started"
+ ],
+ "description": "These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started. You can check the shape of the messages in ClientMessage schema.",
+ "items": {
+ "type": "string",
+ "enum": [
+ "conversation-update",
+ "function-call",
+ "function-call-result",
+ "hang",
+ "language-changed",
+ "metadata",
+ "model-output",
+ "speech-update",
+ "status-update",
+ "transcript",
+ "tool-calls",
+ "tool-calls-result",
+ "tool.completed",
+ "transfer-update",
+ "user-interrupted",
+ "voice-input",
+ "workflow.node.started"
+ ]
+ }
+ },
+ "serverMessages": {
+ "type": "array",
+ "enum": [
+ "conversation-update",
+ "end-of-call-report",
+ "function-call",
+ "hang",
+ "language-changed",
+ "language-change-detected",
+ "model-output",
+ "phone-call-control",
+ "speech-update",
+ "status-update",
+ "transcript",
+ "transcript[transcriptType=\"final\"]",
+ "tool-calls",
+ "transfer-destination-request",
+ "transfer-update",
+ "user-interrupted",
+ "voice-input"
+ ],
+ "example": [
+ "conversation-update",
+ "end-of-call-report",
+ "function-call",
+ "hang",
+ "speech-update",
+ "status-update",
+ "tool-calls",
+ "transfer-destination-request",
+ "user-interrupted"
+ ],
+ "description": "These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,user-interrupted. You can check the shape of the messages in ServerMessage schema.",
+ "items": {
+ "type": "string",
+ "enum": [
+ "conversation-update",
+ "end-of-call-report",
+ "function-call",
+ "hang",
+ "language-changed",
+ "language-change-detected",
+ "model-output",
+ "phone-call-control",
+ "speech-update",
+ "status-update",
+ "transcript",
+ "transcript[transcriptType=\"final\"]",
+ "tool-calls",
+ "transfer-destination-request",
+ "transfer-update",
+ "user-interrupted",
+ "voice-input"
+ ]
+ }
+ },
+ "silenceTimeoutSeconds": {
+ "type": "number",
+ "description": "How many seconds of silence to wait before ending the call. Defaults to 30.\n\n@default 30",
+ "minimum": 10,
+ "maximum": 3600,
+ "example": 30
+ },
+ "maxDurationSeconds": {
+ "type": "number",
+ "description": "This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.\n\n@default 600 (10 minutes)",
+ "minimum": 10,
+ "maximum": 43200,
+ "example": 600
+ },
+ "backgroundSound": {
+ "description": "This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.\nYou can also provide a custom sound by providing a URL to an audio file.",
+ "oneOf": [
+ {
+ "type": "enum",
+ "enum": [
+ "off",
+ "office"
+ ],
+ "example": "office"
+ },
+ {
+ "type": "string",
+ "format": "uri",
+ "example": "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3"
+ }
+ ]
+ },
+ "backgroundDenoisingEnabled": {
+ "type": "boolean",
+ "description": "This enables filtering of noise and background speech while the user is talking.\n\nDefault `false` while in beta.\n\n@default false",
+ "deprecated": true,
+ "example": false
+ },
+ "modelOutputInMessagesEnabled": {
+ "type": "boolean",
+ "description": "This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech.\n\nDefault `false` while in beta.\n\n@default false",
+ "example": false
+ },
+ "transportConfigurations": {
+ "type": "array",
+ "description": "These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TransportConfigurationTwilio",
+ "title": "Twilio"
+ }
+ ]
+ }
+ },
+ "observabilityPlan": {
+ "description": "This is the plan for observability of assistant's calls.\n\nCurrently, only Langfuse is supported.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/LangfuseObservabilityPlan",
+ "title": "Langfuse"
+ }
+ ],
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/LangfuseObservabilityPlan"
+ }
+ ]
+ },
+ "credentials": {
+ "type": "array",
+ "description": "These are dynamic credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateAnthropicCredentialDTO",
+ "title": "AnthropicCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAnyscaleCredentialDTO",
+ "title": "AnyscaleCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAssemblyAICredentialDTO",
+ "title": "AssemblyAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAzureCredentialDTO",
+ "title": "AzureCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAzureOpenAICredentialDTO",
+ "title": "AzureOpenAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
+ "title": "ByoSipTrunkCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCartesiaCredentialDTO",
+ "title": "CartesiaCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCerebrasCredentialDTO",
+ "title": "CerebrasCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCloudflareCredentialDTO",
+ "title": "CloudflareCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCustomLLMCredentialDTO",
+ "title": "CustomLLMCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepgramCredentialDTO",
+ "title": "DeepgramCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepInfraCredentialDTO",
+ "title": "DeepInfraCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepSeekCredentialDTO",
+ "title": "DeepSeekCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateElevenLabsCredentialDTO",
+ "title": "ElevenLabsCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGcpCredentialDTO",
+ "title": "GcpCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGladiaCredentialDTO",
+ "title": "GladiaCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCredentialDTO",
+ "title": "GhlCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCredentialDTO",
+ "title": "GoogleCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGroqCredentialDTO",
+ "title": "GroqCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateHumeCredentialDTO",
+ "title": "HumeCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateInflectionAICredentialDTO",
+ "title": "InflectionAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateLangfuseCredentialDTO",
+ "title": "LangfuseCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateLmntCredentialDTO",
+ "title": "LmntCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMakeCredentialDTO",
+ "title": "MakeCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMistralCredentialDTO",
+ "title": "MistralCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateNeuphonicCredentialDTO",
+ "title": "NeuphonicCredential"
+ },
+ {
+ "$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/CreateS3CredentialDTO",
+ "title": "S3Credential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmallestAICredentialDTO",
+ "title": "SmallestAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
+ "title": "SpeechmaticsCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSupabaseCredentialDTO",
+ "title": "SupabaseCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTavusCredentialDTO",
+ "title": "TavusCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTogetherAICredentialDTO",
+ "title": "TogetherAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTrieveCredentialDTO",
+ "title": "TrieveCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioCredentialDTO",
+ "title": "TwilioCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonageCredentialDTO",
+ "title": "VonageCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateWebhookCredentialDTO",
+ "title": "WebhookCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateXAiCredentialDTO",
+ "title": "XAiCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
+ "title": "GoogleCalendarOAuth2ClientCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
+ "title": "GoogleCalendarOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
+ "title": "GoogleSheetsOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO",
+ "title": "SlackOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelMCPCredentialDTO",
+ "title": "GoHighLevelMCPCredential"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "provider",
+ "mapping": {
+ "11labs": "#/components/schemas/CreateElevenLabsCredentialDTO",
+ "anthropic": "#/components/schemas/CreateAnthropicCredentialDTO",
+ "anyscale": "#/components/schemas/CreateAnyscaleCredentialDTO",
+ "assembly-ai": "#/components/schemas/CreateAssemblyAICredentialDTO",
+ "azure-openai": "#/components/schemas/CreateAzureOpenAICredentialDTO",
+ "azure": "#/components/schemas/CreateAzureCredentialDTO",
+ "byo-sip-trunk": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
+ "cartesia": "#/components/schemas/CreateCartesiaCredentialDTO",
+ "cerebras": "#/components/schemas/CreateCerebrasCredentialDTO",
+ "cloudflare": "#/components/schemas/CreateCloudflareCredentialDTO",
+ "custom-llm": "#/components/schemas/CreateCustomLLMCredentialDTO",
+ "deepgram": "#/components/schemas/CreateDeepgramCredentialDTO",
+ "deepinfra": "#/components/schemas/CreateDeepInfraCredentialDTO",
+ "deep-seek": "#/components/schemas/CreateDeepSeekCredentialDTO",
+ "gcp": "#/components/schemas/CreateGcpCredentialDTO",
+ "gladia": "#/components/schemas/CreateGladiaCredentialDTO",
+ "gohighlevel": "#/components/schemas/CreateGoHighLevelCredentialDTO",
+ "google": "#/components/schemas/CreateGoogleCredentialDTO",
+ "groq": "#/components/schemas/CreateGroqCredentialDTO",
+ "inflection-ai": "#/components/schemas/CreateInflectionAICredentialDTO",
+ "langfuse": "#/components/schemas/CreateLangfuseCredentialDTO",
+ "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",
+ "s3": "#/components/schemas/CreateS3CredentialDTO",
+ "supabase": "#/components/schemas/CreateSupabaseCredentialDTO",
+ "smallest-ai": "#/components/schemas/CreateSmallestAICredentialDTO",
+ "tavus": "#/components/schemas/CreateTavusCredentialDTO",
+ "together-ai": "#/components/schemas/CreateTogetherAICredentialDTO",
+ "twilio": "#/components/schemas/CreateTwilioCredentialDTO",
+ "vonage": "#/components/schemas/CreateVonageCredentialDTO",
+ "webhook": "#/components/schemas/CreateWebhookCredentialDTO",
+ "xai": "#/components/schemas/CreateXAiCredentialDTO",
+ "neuphonic": "#/components/schemas/CreateNeuphonicCredentialDTO",
+ "hume": "#/components/schemas/CreateHumeCredentialDTO",
+ "mistral": "#/components/schemas/CreateMistralCredentialDTO",
+ "speechmatics": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
+ "trieve": "#/components/schemas/CreateTrieveCredentialDTO",
+ "google.calendar.oauth2-client": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
+ "google.calendar.oauth2-authorization": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
+ "google.sheets.oauth2-authorization": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
+ "slack.oauth2-authorization": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO",
+ "ghl.oauth2-authorization": "#/components/schemas/CreateGoHighLevelMCPCredentialDTO"
+ }
+ }
+ }
+ },
+ "hooks": {
+ "type": "array",
+ "description": "This is a set of actions that will be performed on certain events.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AssistantHookCallEnding",
+ "title": "AssistantHookCallEnding"
+ },
+ {
+ "$ref": "#/components/schemas/AssistantHookAssistantSpeechInterrupted",
+ "title": "AssistantHookAssistantSpeechInterrupted"
+ },
+ {
+ "$ref": "#/components/schemas/AssistantHookCustomerSpeechInterrupted",
+ "title": "AssistantHookCustomerSpeechInterrupted"
+ }
+ ]
+ }
+ },
+ "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.",
+ "maxLength": 40
+ },
+ "voicemailMessage": {
+ "type": "string",
+ "description": "This is the message that the assistant will say if the call is forwarded to voicemail.\n\nIf unspecified, it will hang up.",
+ "maxLength": 1000
+ },
+ "endCallMessage": {
+ "type": "string",
+ "description": "This is the message that the assistant will say if it ends the call.\n\nIf unspecified, it will hang up without saying anything.",
+ "maxLength": 1000
+ },
+ "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": 140,
+ "minLength": 2
+ }
+ },
+ "compliancePlan": {
+ "$ref": "#/components/schemas/CompliancePlan"
+ },
+ "metadata": {
+ "type": "object",
+ "description": "This is for metadata you want to store on the assistant."
+ },
+ "backgroundSpeechDenoisingPlan": {
+ "description": "This enables filtering of noise and background speech while the user is talking.\n\nFeatures:\n- Smart denoising using Krisp\n- Fourier denoising\n\nSmart denoising can be combined with or used independently of Fourier denoising.\n\nOrder of precedence:\n- Smart denoising\n- Fourier denoising",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BackgroundSpeechDenoisingPlan"
+ }
+ ]
+ },
+ "analysisPlan": {
+ "description": "This is the plan for analysis of assistant's calls. Stored in `call.analysis`.",
+ "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"
+ }
+ ]
+ },
+ "messagePlan": {
+ "description": "This is the plan for static predefined messages that can be spoken by the assistant during the call, like `idleMessages`.\n\nNote: `firstMessage`, `voicemailMessage`, and `endCallMessage` are currently at the root level. They will be moved to `messagePlan` in the future, but will remain backwards compatible.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MessagePlan"
+ }
+ ]
+ },
+ "startSpeakingPlan": {
+ "description": "This is the plan for when the assistant should start talking.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to start talking after the customer is done speaking.\n- The assistant is too fast to start talking after the customer is done speaking.\n- The assistant is so fast that it's actually interrupting the customer.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/StartSpeakingPlan"
+ }
+ ]
+ },
+ "stopSpeakingPlan": {
+ "description": "This is the plan for when assistant should stop talking on customer interruption.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to recognize customer's interruption.\n- The assistant is too fast to recognize customer's interruption.\n- The assistant is getting interrupted by phrases that are just acknowledgments.\n- The assistant is getting interrupted by background noises.\n- The assistant is not properly stopping -- it starts talking right after getting interrupted.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/StopSpeakingPlan"
+ }
+ ]
+ },
+ "monitorPlan": {
+ "description": "This is the plan for real-time monitoring of the assistant's calls.\n\nUsage:\n- To enable live listening of the assistant's calls, set `monitorPlan.listenEnabled` to `true`.\n- To enable live control of the assistant's calls, set `monitorPlan.controlEnabled` to `true`.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MonitorPlan"
+ }
+ ]
+ },
+ "credentialIds": {
+ "description": "These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server.url\n2. phoneNumber.serverUrl\n3. org.serverUrl",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
+ },
+ "keypadInputPlan": {
+ "$ref": "#/components/schemas/KeypadInputPlan"
+ }
+ }
+ },
+ "ByoPhoneNumber": {
+ "type": "object",
+ "properties": {
+ "fallbackDestination": {
+ "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "NumberTransferDestination"
+ },
+ {
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "SipTransferDestination"
+ }
+ ]
+ },
+ "hooks": {
+ "type": "array",
+ "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
+ "title": "PhoneNumberHookCallRinging"
+ }
+ ]
+ }
+ },
+ "provider": {
+ "type": "string",
+ "description": "This is to bring your own phone numbers from your own SIP trunks or Carriers.",
+ "enum": [
+ "byo-phone-number"
+ ]
+ },
+ "numberE164CheckEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)",
+ "default": true
+ },
+ "id": {
+ "type": "string",
+ "description": "This is the unique identifier for the phone number."
+ },
+ "orgId": {
+ "type": "string",
+ "description": "This is the unique identifier for the org that this phone number belongs to."
+ },
+ "createdAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the phone number was created."
+ },
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the phone number was last updated."
+ },
+ "status": {
+ "type": "string",
+ "description": "This is the status of the phone number.",
+ "enum": [
+ "active",
+ "activating",
+ "blocked"
+ ]
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of the phone number. This is just for your own reference.",
+ "maxLength": 40
+ },
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "squadId": {
+ "type": "string",
+ "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
+ },
+ "number": {
+ "type": "string",
+ "description": "This is the number of the customer.",
+ "minLength": 3,
+ "maxLength": 40
+ },
+ "credentialId": {
+ "type": "string",
+ "description": "This is the credential of your own SIP trunk or Carrier (type `byo-sip-trunk`) which can be used to make calls to this phone number.\n\nYou can add the SIP trunk or Carrier credential in the Provider Credentials page on the Dashboard to get the credentialId."
+ }
+ },
+ "required": [
+ "provider",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt",
+ "credentialId"
+ ]
+ },
+ "TwilioPhoneNumber": {
+ "type": "object",
+ "properties": {
+ "fallbackDestination": {
+ "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
"oneOf": [
{
"$ref": "#/components/schemas/TransferDestinationNumber",
@@ -18807,3783 +28550,3490 @@
}
]
},
+ "hooks": {
+ "type": "array",
+ "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
+ "title": "PhoneNumberHookCallRinging"
+ }
+ ]
+ }
+ },
+ "provider": {
+ "type": "string",
+ "description": "This is to use numbers bought on Twilio.",
+ "enum": [
+ "twilio"
+ ]
+ },
+ "smsEnabled": {
+ "type": "boolean",
+ "description": "Controls whether Vapi sets the messaging webhook URL on the Twilio number during import.\n\nIf set to `false`, Vapi will not update the Twilio messaging URL, leaving it as is.\nIf `true` or omitted (default), Vapi will configure both the voice and messaging URLs.\n\n@default true",
+ "default": true
+ },
"id": {
"type": "string",
- "description": "This is the unique identifier for the call."
+ "description": "This is the unique identifier for the phone number."
},
"orgId": {
"type": "string",
- "description": "This is the unique identifier for the org that this call belongs to."
+ "description": "This is the unique identifier for the org that this phone number belongs to."
},
"createdAt": {
"format": "date-time",
"type": "string",
- "description": "This is the ISO 8601 date-time string of when the call was created."
+ "description": "This is the ISO 8601 date-time string of when the phone number was created."
},
"updatedAt": {
"format": "date-time",
"type": "string",
- "description": "This is the ISO 8601 date-time string of when the call was last updated."
+ "description": "This is the ISO 8601 date-time string of when the phone number was last updated."
},
- "startedAt": {
- "format": "date-time",
+ "status": {
"type": "string",
- "description": "This is the ISO 8601 date-time string of when the call was started."
+ "description": "This is the status of the phone number.",
+ "enum": [
+ "active",
+ "activating",
+ "blocked"
+ ]
},
- "endedAt": {
- "format": "date-time",
+ "twilioAuthToken": {
"type": "string",
- "description": "This is the ISO 8601 date-time string of when the call was ended."
+ "description": "This is the Twilio Auth Token for the phone number."
},
- "cost": {
- "type": "number",
- "description": "This is the cost of the call in USD."
+ "twilioApiKey": {
+ "type": "string",
+ "description": "This is the Twilio API Key for the phone number."
},
- "costBreakdown": {
- "description": "This is the cost of the call in USD.",
- "allOf": [
- {
- "$ref": "#/components/schemas/CostBreakdown"
- }
- ]
+ "twilioApiSecret": {
+ "type": "string",
+ "description": "This is the Twilio API Secret for the phone number."
},
- "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"
- }
- ]
+ "name": {
+ "type": "string",
+ "description": "This is the name of the phone number. This is just for your own reference.",
+ "maxLength": 40
},
- "analysis": {
- "description": "This is the analysis of the call. Configure in `assistant.analysisPlan`.",
- "allOf": [
- {
- "$ref": "#/components/schemas/Analysis"
- }
- ]
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
},
- "monitor": {
- "description": "This is to real-time monitor the call. Configure in `assistant.monitorPlan`.",
- "allOf": [
- {
- "$ref": "#/components/schemas/Monitor"
- }
- ]
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
},
- "artifact": {
- "description": "These are the artifacts created from the call. Configure in `assistant.artifactPlan`.",
+ "squadId": {
+ "type": "string",
+ "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
"allOf": [
{
- "$ref": "#/components/schemas/Artifact"
+ "$ref": "#/components/schemas/Server"
}
]
},
- "phoneCallProviderId": {
+ "number": {
"type": "string",
- "description": "The ID of the call as provided by the phone number service. callSid in Twilio. conversationUuid in Vonage. callControlId in Telnyx.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type."
+ "description": "These are the digits of the phone number you own on your Twilio."
},
- "assistantId": {
+ "twilioAccountSid": {
"type": "string",
- "description": "This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead."
- },
- "assistant": {
- "description": "This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead.",
- "allOf": [
+ "description": "This is the Twilio Account SID for the phone number."
+ }
+ },
+ "required": [
+ "provider",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt",
+ "number",
+ "twilioAccountSid"
+ ]
+ },
+ "VonagePhoneNumber": {
+ "type": "object",
+ "properties": {
+ "fallbackDestination": {
+ "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
+ "oneOf": [
{
- "$ref": "#/components/schemas/CreateAssistantDTO"
- }
- ]
- },
- "assistantOverrides": {
- "description": "These are the overrides for the `assistant` or `assistantId`'s settings and template variables.",
- "allOf": [
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "NumberTransferDestination"
+ },
{
- "$ref": "#/components/schemas/AssistantOverrides"
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "SipTransferDestination"
}
]
},
- "squadId": {
- "type": "string",
- "description": "This is the squad that will be used for the call. To use a transient squad, use `squad` instead."
+ "hooks": {
+ "type": "array",
+ "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
+ "title": "PhoneNumberHookCallRinging"
+ }
+ ]
+ }
},
- "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"
- }
+ "provider": {
+ "type": "string",
+ "description": "This is to use numbers bought on Vonage.",
+ "enum": [
+ "vonage"
]
},
- "phoneNumberId": {
+ "id": {
"type": "string",
- "description": "This is the phone number that will be used for the call. To use a transient number, use `phoneNumber` instead.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type."
+ "description": "This is the unique identifier for the phone number."
},
- "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"
- }
- ]
+ "orgId": {
+ "type": "string",
+ "description": "This is the unique identifier for the org that this phone number belongs to."
},
- "customerId": {
+ "createdAt": {
+ "format": "date-time",
"type": "string",
- "description": "This is the customer that will be called. To call a transient customer , use `customer` instead.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type."
+ "description": "This is the ISO 8601 date-time string of when the phone number was created."
},
- "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"
- }
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the phone number was last updated."
+ },
+ "status": {
+ "type": "string",
+ "description": "This is the status of the phone number.",
+ "enum": [
+ "active",
+ "activating",
+ "blocked"
]
},
"name": {
"type": "string",
- "description": "This is the name of the call. This is just for your own reference.",
+ "description": "This is the name of the phone number. This is just for your own reference.",
"maxLength": 40
},
- "schedulePlan": {
- "description": "This is the schedule plan of the call.",
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "squadId": {
+ "type": "string",
+ "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
"allOf": [
{
- "$ref": "#/components/schemas/SchedulePlan"
+ "$ref": "#/components/schemas/Server"
}
]
},
- "transport": {
- "type": "object",
- "description": "This is the transport of the call."
+ "number": {
+ "type": "string",
+ "description": "These are the digits of the phone number you own on your Vonage."
+ },
+ "credentialId": {
+ "type": "string",
+ "description": "This is the credential you added in dashboard.vapi.ai/keys. This is used to configure the number to send inbound calls to Vapi, make outbound calls and do live call updates like transfers and hangups."
}
},
"required": [
+ "provider",
"id",
"orgId",
"createdAt",
- "updatedAt"
+ "updatedAt",
+ "number",
+ "credentialId"
]
},
- "CallBatchError": {
+ "SipAuthentication": {
"type": "object",
"properties": {
- "customer": {
- "$ref": "#/components/schemas/CreateCustomerDTO"
+ "realm": {
+ "type": "string",
+ "description": "This will be expected in the `realm` field of the `authorization` header of the SIP INVITE. Defaults to sip.vapi.ai."
},
- "error": {
- "type": "string"
- }
- },
- "required": [
- "customer",
- "error"
- ]
- },
- "CallBatchResponse": {
- "type": "object",
- "properties": {
- "results": {
- "description": "This is the list of calls that were created.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Call"
- }
+ "username": {
+ "type": "string",
+ "description": "This will be expected in the `username` field of the `authorization` header of the SIP INVITE.",
+ "minLength": 20,
+ "maxLength": 40
},
- "errors": {
- "description": "This is the list of calls that failed to be created.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CallBatchError"
- }
+ "password": {
+ "type": "string",
+ "description": "This will be expected to generate the `response` field of the `authorization` header of the SIP INVITE, through digest authentication.",
+ "minLength": 20,
+ "maxLength": 40
}
},
"required": [
- "results",
- "errors"
+ "username",
+ "password"
]
},
- "CreateCallDTO": {
+ "VapiPhoneNumber": {
"type": "object",
"properties": {
- "customers": {
- "description": "This is used to issue batch calls to multiple customers.\n\nOnly relevant for `outboundPhoneCall`. To call a single customer, use `customer` instead.",
+ "fallbackDestination": {
+ "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "NumberTransferDestination"
+ },
+ {
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "SipTransferDestination"
+ }
+ ]
+ },
+ "hooks": {
"type": "array",
+ "description": "This is the hooks that will be used for incoming calls to this phone number.",
"items": {
- "$ref": "#/components/schemas/CreateCustomerDTO"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
+ "title": "PhoneNumberHookCallRinging"
+ }
+ ]
}
},
- "name": {
+ "provider": {
"type": "string",
- "description": "This is the name of the call. This is just for your own reference.",
- "maxLength": 40
- },
- "schedulePlan": {
- "description": "This is the schedule plan of the call.",
- "allOf": [
- {
- "$ref": "#/components/schemas/SchedulePlan"
- }
+ "description": "This is to create free SIP phone numbers on Vapi.",
+ "enum": [
+ "vapi"
]
},
- "transport": {
- "type": "object",
- "description": "This is the transport of the call."
+ "id": {
+ "type": "string",
+ "description": "This is the unique identifier for the phone number."
},
- "assistantId": {
+ "orgId": {
"type": "string",
- "description": "This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead."
+ "description": "This is the unique identifier for the org that this phone number belongs to."
},
- "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"
- }
- ]
+ "createdAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the phone number was created."
},
- "assistantOverrides": {
- "description": "These are the overrides for the `assistant` or `assistantId`'s settings and template variables.",
- "allOf": [
- {
- "$ref": "#/components/schemas/AssistantOverrides"
- }
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the phone number was last updated."
+ },
+ "status": {
+ "type": "string",
+ "description": "This is the status of the phone number.",
+ "enum": [
+ "active",
+ "activating",
+ "blocked"
]
},
- "squadId": {
+ "number": {
"type": "string",
- "description": "This is the squad that will be used for the call. To use a transient squad, use `squad` instead."
+ "description": "These are the digits of the phone number you purchased from Vapi."
},
- "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"
- }
- ]
+ "name": {
+ "type": "string",
+ "description": "This is the name of the phone number. This is just for your own reference.",
+ "maxLength": 40
},
- "phoneNumberId": {
+ "assistantId": {
"type": "string",
- "description": "This is the phone number that will be used for the call. To use a transient number, use `phoneNumber` instead.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type."
+ "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
},
- "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.",
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "squadId": {
+ "type": "string",
+ "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
"allOf": [
{
- "$ref": "#/components/schemas/ImportTwilioPhoneNumberDTO"
+ "$ref": "#/components/schemas/Server"
}
]
},
- "customerId": {
+ "numberDesiredAreaCode": {
"type": "string",
- "description": "This is the customer that will be called. To call a transient customer , use `customer` instead.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type."
+ "description": "This is the area code of the phone number to purchase.",
+ "minLength": 3,
+ "maxLength": 3
},
- "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.",
+ "sipUri": {
+ "type": "string",
+ "description": "This is the SIP URI of the phone number. You can SIP INVITE this. The assistant attached to this number will answer.\n\nThis is case-insensitive."
+ },
+ "authentication": {
+ "description": "This enables authentication for incoming SIP INVITE requests to the `sipUri`.\n\nIf not set, any username/password to the 401 challenge of the SIP INVITE will be accepted.",
"allOf": [
{
- "$ref": "#/components/schemas/CreateCustomerDTO"
+ "$ref": "#/components/schemas/SipAuthentication"
}
]
}
- }
- },
- "PaginationMeta": {
- "type": "object",
- "properties": {
- "itemsPerPage": {
- "type": "number"
- },
- "totalItems": {
- "type": "number"
- },
- "currentPage": {
- "type": "number"
- }
},
"required": [
- "itemsPerPage",
- "totalItems",
- "currentPage"
+ "provider",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt"
]
},
- "CallPaginatedResponse": {
+ "TelnyxPhoneNumber": {
"type": "object",
"properties": {
- "results": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Call"
- }
+ "fallbackDestination": {
+ "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "NumberTransferDestination"
+ },
+ {
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "SipTransferDestination"
+ }
+ ]
},
- "metadata": {
- "$ref": "#/components/schemas/PaginationMeta"
- }
- },
- "required": [
- "results",
- "metadata"
- ]
- },
- "CreateOutboundCallDTO": {
- "type": "object",
- "properties": {
- "customers": {
- "description": "This is used to issue batch calls to multiple customers.\n\nOnly relevant for `outboundPhoneCall`. To call a single customer, use `customer` instead.",
+ "hooks": {
"type": "array",
+ "description": "This is the hooks that will be used for incoming calls to this phone number.",
"items": {
- "$ref": "#/components/schemas/CreateCustomerDTO"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
+ "title": "PhoneNumberHookCallRinging"
+ }
+ ]
}
},
- "name": {
+ "provider": {
"type": "string",
- "description": "This is the name of the call. This is just for your own reference.",
- "maxLength": 40
- },
- "schedulePlan": {
- "description": "This is the schedule plan of the call.",
- "allOf": [
- {
- "$ref": "#/components/schemas/SchedulePlan"
- }
+ "description": "This is to use numbers bought on Telnyx.",
+ "enum": [
+ "telnyx"
]
},
- "transport": {
- "type": "object",
- "description": "This is the transport of the call."
- },
- "assistantId": {
+ "id": {
"type": "string",
- "description": "This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead."
+ "description": "This is the unique identifier for the phone number."
},
- "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"
- }
- ]
+ "orgId": {
+ "type": "string",
+ "description": "This is the unique identifier for the org that this phone number belongs to."
},
- "assistantOverrides": {
- "description": "These are the overrides for the `assistant` or `assistantId`'s settings and template variables.",
- "allOf": [
- {
- "$ref": "#/components/schemas/AssistantOverrides"
- }
- ]
+ "createdAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the phone number was created."
},
- "squadId": {
+ "updatedAt": {
+ "format": "date-time",
"type": "string",
- "description": "This is the squad that will be used for the call. To use a transient squad, use `squad` instead."
+ "description": "This is the ISO 8601 date-time string of when the phone number was last updated."
},
- "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"
- }
+ "status": {
+ "type": "string",
+ "description": "This is the status of the phone number.",
+ "enum": [
+ "active",
+ "activating",
+ "blocked"
]
},
- "phoneNumberId": {
+ "name": {
"type": "string",
- "description": "This is the phone number that will be used for the call. To use a transient number, use `phoneNumber` instead.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type."
+ "description": "This is the name of the phone number. This is just for your own reference.",
+ "maxLength": 40
},
- "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"
- }
- ]
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
},
- "customerId": {
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "squadId": {
"type": "string",
- "description": "This is the customer that will be called. To call a transient customer , use `customer` instead.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type."
+ "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
},
- "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.",
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
"allOf": [
{
- "$ref": "#/components/schemas/CreateCustomerDTO"
+ "$ref": "#/components/schemas/Server"
}
]
+ },
+ "number": {
+ "type": "string",
+ "description": "These are the digits of the phone number you own on your Telnyx."
+ },
+ "credentialId": {
+ "type": "string",
+ "description": "This is the credential you added in dashboard.vapi.ai/keys. This is used to configure the number to send inbound calls to Vapi, make outbound calls and do live call updates like transfers and hangups."
}
- }
+ },
+ "required": [
+ "provider",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt",
+ "number",
+ "credentialId"
+ ]
},
- "CreateWebCallDTO": {
+ "CreateByoPhoneNumberDTO": {
"type": "object",
"properties": {
- "assistantId": {
- "type": "string",
- "description": "This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead."
- },
- "assistant": {
- "description": "This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead.",
- "allOf": [
+ "fallbackDestination": {
+ "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
+ "oneOf": [
{
- "$ref": "#/components/schemas/CreateAssistantDTO"
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "NumberTransferDestination"
+ },
+ {
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "SipTransferDestination"
}
]
},
- "assistantOverrides": {
- "description": "These are the overrides for the `assistant` or `assistantId`'s settings and template variables.",
- "allOf": [
- {
- "$ref": "#/components/schemas/AssistantOverrides"
- }
+ "hooks": {
+ "type": "array",
+ "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
+ "title": "PhoneNumberHookCallRinging"
+ }
+ ]
+ }
+ },
+ "provider": {
+ "type": "string",
+ "description": "This is to bring your own phone numbers from your own SIP trunks or Carriers.",
+ "enum": [
+ "byo-phone-number"
]
},
- "squadId": {
+ "numberE164CheckEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)",
+ "default": true
+ },
+ "number": {
"type": "string",
- "description": "This is the squad that will be used for the call. To use a transient squad, use `squad` instead."
+ "description": "This is the number of the customer.",
+ "minLength": 3,
+ "maxLength": 40
+ },
+ "credentialId": {
+ "type": "string",
+ "description": "This is the credential of your own SIP trunk or Carrier (type `byo-sip-trunk`) which can be used to make calls to this phone number.\n\nYou can add the SIP trunk or Carrier credential in the Provider Credentials page on the Dashboard to get the credentialId."
},
- "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"
- }
- ]
- }
- }
- },
- "UpdateCallDTO": {
- "type": "object",
- "properties": {
"name": {
"type": "string",
- "description": "This is the name of the call. This is just for your own reference.",
+ "description": "This is the name of the phone number. This is just for your own reference.",
"maxLength": 40
- }
- }
- },
- "ChatServiceResponse": {
- "type": "object",
- "properties": {}
- },
- "ChatCompletionMessageMetadata": {
- "type": "object",
- "properties": {
- "taskName": {
- "type": "string"
},
- "taskType": {
- "type": "string"
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
},
- "taskOutput": {
- "type": "string"
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
},
- "taskState": {
- "type": "object"
+ "squadId": {
+ "type": "string",
+ "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
},
- "nodeTrace": {
- "type": "array",
- "items": {
- "type": "string"
- }
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
}
},
"required": [
- "taskName",
- "taskType",
- "taskOutput"
+ "provider",
+ "credentialId"
]
},
- "ChatCompletionMessageWorkflows": {
+ "CreateTwilioPhoneNumberDTO": {
"type": "object",
"properties": {
- "role": {
- "type": "object"
+ "fallbackDestination": {
+ "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "NumberTransferDestination"
+ },
+ {
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "SipTransferDestination"
+ }
+ ]
},
- "content": {
- "type": "string",
- "nullable": true
+ "hooks": {
+ "type": "array",
+ "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
+ "title": "PhoneNumberHookCallRinging"
+ }
+ ]
+ }
},
- "metadata": {
- "$ref": "#/components/schemas/ChatCompletionMessageMetadata"
- }
- },
- "required": [
- "role",
- "content"
- ]
- },
- "Say": {
- "type": "object",
- "properties": {
- "type": {
+ "provider": {
"type": "string",
+ "description": "This is to use numbers bought on Twilio.",
"enum": [
- "say"
+ "twilio"
]
},
- "exact": {
+ "smsEnabled": {
+ "type": "boolean",
+ "description": "Controls whether Vapi sets the messaging webhook URL on the Twilio number during import.\n\nIf set to `false`, Vapi will not update the Twilio messaging URL, leaving it as is.\nIf `true` or omitted (default), Vapi will configure both the voice and messaging URLs.\n\n@default true",
+ "default": true
+ },
+ "number": {
"type": "string",
- "maxLength": 1000
+ "description": "These are the digits of the phone number you own on your Twilio."
},
- "prompt": {
+ "twilioAccountSid": {
"type": "string",
- "maxLength": 1000
+ "description": "This is the Twilio Account SID for the phone number."
},
- "name": {
+ "twilioAuthToken": {
"type": "string",
- "maxLength": 80
+ "description": "This is the Twilio Auth Token for the phone number."
},
- "metadata": {
- "type": "object",
- "description": "This is for metadata you want to store on the task."
- }
- },
- "required": [
- "type",
- "name"
- ]
- },
- "SayHook": {
- "type": "object",
- "properties": {
- "type": {
+ "twilioApiKey": {
"type": "string",
- "enum": [
- "say"
- ]
+ "description": "This is the Twilio API Key for the phone number."
},
- "metadata": {
- "type": "object",
- "description": "This is for metadata you want to store on the task."
+ "twilioApiSecret": {
+ "type": "string",
+ "description": "This is the Twilio API Secret for the phone number."
},
- "exact": {
+ "name": {
"type": "string",
- "maxLength": 1000
+ "description": "This is the name of the phone number. This is just for your own reference.",
+ "maxLength": 40
},
- "prompt": {
+ "assistantId": {
"type": "string",
- "maxLength": 1000
- }
- },
- "required": [
- "type"
- ]
- },
- "Hook": {
- "type": "object",
- "properties": {
- "on": {
+ "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "workflowId": {
"type": "string",
- "enum": [
- "task.start",
- "task.output.confirmation",
- "task.delayed"
- ],
- "maxLength": 80
+ "description": "This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
},
- "do": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/SayHook"
- }
+ "squadId": {
+ "type": "string",
+ "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
}
},
"required": [
- "on",
- "do"
+ "provider",
+ "number",
+ "twilioAccountSid"
]
},
- "Gather": {
+ "CreateVonagePhoneNumberDTO": {
"type": "object",
"properties": {
- "type": {
- "type": "string",
- "enum": [
- "gather"
+ "fallbackDestination": {
+ "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "NumberTransferDestination"
+ },
+ {
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "SipTransferDestination"
+ }
]
},
- "output": {
- "$ref": "#/components/schemas/JsonSchema"
- },
- "confirmContent": {
- "type": "boolean",
- "description": "This is whether or not the workflow should read back the gathered data to the user, and ask about its correctness."
- },
"hooks": {
- "description": "This is a list of hooks for a task.\nEach hook is a list of tasks to run on a trigger (such as on start, on failure, etc).\nOnly Say is supported for now.",
"type": "array",
+ "description": "This is the hooks that will be used for incoming calls to this phone number.",
"items": {
- "$ref": "#/components/schemas/Hook"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
+ "title": "PhoneNumberHookCallRinging"
+ }
+ ]
}
},
- "maxRetries": {
- "type": "number",
- "description": "This is the number of times we should try to gather the information from the user before we failover to the fail path. An example of this would be a user refusing to give their phone number for privacy reasons, and then going down a different path on account of this"
+ "provider": {
+ "type": "string",
+ "description": "This is to use numbers bought on Vonage.",
+ "enum": [
+ "vonage"
+ ]
+ },
+ "number": {
+ "type": "string",
+ "description": "These are the digits of the phone number you own on your Vonage."
},
- "literalTemplate": {
+ "credentialId": {
"type": "string",
- "description": "This is a liquid templating string. On the first call to Gather, the template will be filled out with variables from the context, and will be spoken verbatim to the user. An example would be \"Base on your zipcode, it looks like you could be in one of these counties: {{ counties | join: \", \" }}. Which one do you live in?\""
+ "description": "This is the credential you added in dashboard.vapi.ai/keys. This is used to configure the number to send inbound calls to Vapi, make outbound calls and do live call updates like transfers and hangups."
},
"name": {
"type": "string",
- "maxLength": 80
+ "description": "This is the name of the phone number. This is just for your own reference.",
+ "maxLength": 40
},
- "metadata": {
- "type": "object",
- "description": "This is for metadata you want to store on the task."
- }
- },
- "required": [
- "type",
- "output",
- "name"
- ]
- },
- "ApiRequest": {
- "type": "object",
- "properties": {
- "type": {
+ "assistantId": {
"type": "string",
- "enum": [
- "apiRequest"
- ]
+ "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
},
- "method": {
+ "workflowId": {
"type": "string",
- "enum": [
- "POST",
- "GET"
- ]
+ "description": "This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
},
- "url": {
+ "squadId": {
"type": "string",
- "description": "Api endpoint to send requests to."
+ "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
},
- "headers": {
- "description": "These are the custom headers to include in the Api Request sent.\n\nEach key-value pair represents a header name and its value.",
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
"allOf": [
{
- "$ref": "#/components/schemas/JsonSchema"
+ "$ref": "#/components/schemas/Server"
}
]
- },
- "body": {
- "description": "This defined the JSON body of your Api Request. For example, if `body_schema`\nincluded \"my_field\": \"my_gather_statement.user_age\", then the json body sent to the server would have that particular value assign to it.\nRight now, only data from gather statements are supported.",
- "allOf": [
+ }
+ },
+ "required": [
+ "provider",
+ "number",
+ "credentialId"
+ ]
+ },
+ "CreateVapiPhoneNumberDTO": {
+ "type": "object",
+ "properties": {
+ "fallbackDestination": {
+ "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
+ "oneOf": [
{
- "$ref": "#/components/schemas/JsonSchema"
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "NumberTransferDestination"
+ },
+ {
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "SipTransferDestination"
}
]
},
- "mode": {
- "type": "string",
- "description": "This is the mode of the Api Request.\nWe only support BLOCKING and BACKGROUND for now.",
- "enum": [
- "blocking",
- "background"
- ]
- },
"hooks": {
- "description": "This is a list of hooks for a task.\nEach hook is a list of tasks to run on a trigger (such as on start, on failure, etc).\nOnly Say is supported for now.",
"type": "array",
+ "description": "This is the hooks that will be used for incoming calls to this phone number.",
"items": {
- "$ref": "#/components/schemas/Hook"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
+ "title": "PhoneNumberHookCallRinging"
+ }
+ ]
}
},
- "output": {
- "description": "This is the schema for the outputs of the Api Request.",
- "allOf": [
- {
- "$ref": "#/components/schemas/JsonSchema"
- }
+ "provider": {
+ "type": "string",
+ "description": "This is to create free SIP phone numbers on Vapi.",
+ "enum": [
+ "vapi"
]
},
- "name": {
+ "numberDesiredAreaCode": {
"type": "string",
- "maxLength": 80
+ "description": "This is the area code of the phone number to purchase.",
+ "minLength": 3,
+ "maxLength": 3
},
- "metadata": {
- "type": "object",
- "description": "This is for metadata you want to store on the task."
- }
- },
- "required": [
- "type",
- "method",
- "url",
- "mode",
- "name"
- ]
- },
- "Hangup": {
- "type": "object",
- "properties": {
- "type": {
+ "sipUri": {
"type": "string",
- "enum": [
- "hangup"
+ "description": "This is the SIP URI of the phone number. You can SIP INVITE this. The assistant attached to this number will answer.\n\nThis is case-insensitive."
+ },
+ "authentication": {
+ "description": "This enables authentication for incoming SIP INVITE requests to the `sipUri`.\n\nIf not set, any username/password to the 401 challenge of the SIP INVITE will be accepted.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SipAuthentication"
+ }
]
},
"name": {
"type": "string",
- "maxLength": 80
+ "description": "This is the name of the phone number. This is just for your own reference.",
+ "maxLength": 40
},
- "metadata": {
- "type": "object",
- "description": "This is for metadata you want to store on the task."
- }
- },
- "required": [
- "type",
- "name"
- ]
- },
- "Transfer": {
- "type": "object",
- "properties": {
- "type": {
+ "assistantId": {
"type": "string",
- "enum": [
- "transfer"
- ]
+ "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
},
- "destination": {
- "type": "object"
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
},
- "name": {
+ "squadId": {
"type": "string",
- "maxLength": 80
+ "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
},
- "metadata": {
- "type": "object",
- "description": "This is for metadata you want to store on the task."
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
}
},
"required": [
- "type",
- "destination",
- "name"
+ "provider"
]
},
- "CreateWorkflowDTO": {
+ "CreateTelnyxPhoneNumberDTO": {
"type": "object",
"properties": {
- "nodes": {
- "type": "array",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/Say",
- "title": "Say"
- },
- {
- "$ref": "#/components/schemas/Gather",
- "title": "Gather"
- },
- {
- "$ref": "#/components/schemas/ApiRequest",
- "title": "ApiRequest"
- },
- {
- "$ref": "#/components/schemas/Hangup",
- "title": "Hangup"
- },
- {
- "$ref": "#/components/schemas/Transfer",
- "title": "Transfer"
- }
- ]
- }
- },
- "model": {
- "description": "These are the options for the workflow's LLM.",
+ "fallbackDestination": {
+ "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
"oneOf": [
{
- "$ref": "#/components/schemas/AnthropicModel",
- "title": "Anthropic"
- },
- {
- "$ref": "#/components/schemas/AnyscaleModel",
- "title": "Anyscale"
- },
- {
- "$ref": "#/components/schemas/CerebrasModel",
- "title": "Cerebras"
- },
- {
- "$ref": "#/components/schemas/CustomLLMModel",
- "title": "CustomLLM"
- },
- {
- "$ref": "#/components/schemas/DeepInfraModel",
- "title": "DeepInfra"
- },
- {
- "$ref": "#/components/schemas/DeepSeekModel",
- "title": "DeepSeek"
- },
- {
- "$ref": "#/components/schemas/GoogleModel",
- "title": "Google"
- },
- {
- "$ref": "#/components/schemas/GroqModel",
- "title": "Groq"
- },
- {
- "$ref": "#/components/schemas/InflectionAIModel",
- "title": "InflectionAI"
- },
- {
- "$ref": "#/components/schemas/OpenAIModel",
- "title": "OpenAI"
- },
- {
- "$ref": "#/components/schemas/OpenRouterModel",
- "title": "OpenRouter"
- },
- {
- "$ref": "#/components/schemas/PerplexityAIModel",
- "title": "PerplexityAI"
- },
- {
- "$ref": "#/components/schemas/TogetherAIModel",
- "title": "Together"
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "NumberTransferDestination"
},
{
- "$ref": "#/components/schemas/XaiModel",
- "title": "XAI"
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "SipTransferDestination"
}
]
},
- "name": {
- "type": "string",
- "maxLength": 80
- },
- "edges": {
+ "hooks": {
"type": "array",
+ "description": "This is the hooks that will be used for incoming calls to this phone number.",
"items": {
- "$ref": "#/components/schemas/Edge"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
+ "title": "PhoneNumberHookCallRinging"
+ }
+ ]
}
+ },
+ "provider": {
+ "type": "string",
+ "description": "This is to use numbers bought on Telnyx.",
+ "enum": [
+ "telnyx"
+ ]
+ },
+ "number": {
+ "type": "string",
+ "description": "These are the digits of the phone number you own on your Telnyx."
+ },
+ "credentialId": {
+ "type": "string",
+ "description": "This is the credential you added in dashboard.vapi.ai/keys. This is used to configure the number to send inbound calls to Vapi, make outbound calls and do live call updates like transfers and hangups."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of the phone number. This is just for your own reference.",
+ "maxLength": 40
+ },
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "squadId": {
+ "type": "string",
+ "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
}
},
"required": [
- "nodes",
- "name",
- "edges"
+ "provider",
+ "number",
+ "credentialId"
]
},
- "ChatCompletionsDTO": {
+ "UpdateByoPhoneNumberDTO": {
"type": "object",
"properties": {
- "messages": {
+ "fallbackDestination": {
+ "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "NumberTransferDestination"
+ },
+ {
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "SipTransferDestination"
+ }
+ ]
+ },
+ "hooks": {
"type": "array",
+ "description": "This is the hooks that will be used for incoming calls to this phone number.",
"items": {
- "$ref": "#/components/schemas/ChatCompletionMessageWorkflows"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
+ "title": "PhoneNumberHookCallRinging"
+ }
+ ]
}
},
+ "numberE164CheckEnabled": {
+ "type": "boolean",
+ "description": "This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)",
+ "default": true
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of the phone number. This is just for your own reference.",
+ "maxLength": 40
+ },
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
"workflowId": {
- "type": "string"
+ "type": "string",
+ "description": "This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
},
- "workflow": {
- "$ref": "#/components/schemas/CreateWorkflowDTO"
+ "squadId": {
+ "type": "string",
+ "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
+ },
+ "number": {
+ "type": "string",
+ "description": "This is the number of the customer.",
+ "minLength": 3,
+ "maxLength": 40
+ },
+ "credentialId": {
+ "type": "string",
+ "description": "This is the credential of your own SIP trunk or Carrier (type `byo-sip-trunk`) which can be used to make calls to this phone number.\n\nYou can add the SIP trunk or Carrier credential in the Provider Credentials page on the Dashboard to get the credentialId."
}
- },
- "required": [
- "messages"
- ]
+ }
},
- "Assistant": {
+ "UpdateTwilioPhoneNumberDTO": {
"type": "object",
"properties": {
- "transcriber": {
- "description": "These are the options for the assistant's transcriber.",
+ "fallbackDestination": {
+ "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
"oneOf": [
{
- "$ref": "#/components/schemas/AssemblyAITranscriber",
- "title": "AssemblyAI"
- },
- {
- "$ref": "#/components/schemas/AzureSpeechTranscriber",
- "title": "Azure"
- },
- {
- "$ref": "#/components/schemas/CustomTranscriber",
- "title": "CustomTranscriber"
- },
- {
- "$ref": "#/components/schemas/DeepgramTranscriber",
- "title": "Deepgram"
- },
- {
- "$ref": "#/components/schemas/ElevenLabsTranscriber",
- "title": "ElevenLabs"
- },
- {
- "$ref": "#/components/schemas/GladiaTranscriber",
- "title": "Gladia"
- },
- {
- "$ref": "#/components/schemas/SpeechmaticsTranscriber",
- "title": "Speechmatics"
- },
- {
- "$ref": "#/components/schemas/TalkscriberTranscriber",
- "title": "Talkscriber"
- },
- {
- "$ref": "#/components/schemas/GoogleTranscriber",
- "title": "Google"
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "NumberTransferDestination"
},
{
- "$ref": "#/components/schemas/OpenAITranscriber",
- "title": "OpenAI"
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "SipTransferDestination"
}
]
},
- "model": {
- "description": "These are the options for the assistant's LLM.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/AnyscaleModel",
- "title": "Anyscale"
- },
- {
- "$ref": "#/components/schemas/AnthropicModel",
- "title": "Anthropic"
- },
- {
- "$ref": "#/components/schemas/CerebrasModel",
- "title": "Cerebras"
- },
- {
- "$ref": "#/components/schemas/CustomLLMModel",
- "title": "CustomLLM"
- },
- {
- "$ref": "#/components/schemas/DeepInfraModel",
- "title": "DeepInfra"
- },
- {
- "$ref": "#/components/schemas/DeepSeekModel",
- "title": "DeepSeek"
- },
- {
- "$ref": "#/components/schemas/GoogleModel",
- "title": "Google"
- },
- {
- "$ref": "#/components/schemas/GroqModel",
- "title": "Groq"
- },
- {
- "$ref": "#/components/schemas/InflectionAIModel",
- "title": "InflectionAI"
- },
- {
- "$ref": "#/components/schemas/OpenAIModel",
- "title": "OpenAI"
- },
- {
- "$ref": "#/components/schemas/OpenRouterModel",
- "title": "OpenRouter"
- },
- {
- "$ref": "#/components/schemas/PerplexityAIModel",
- "title": "PerplexityAI"
- },
- {
- "$ref": "#/components/schemas/TogetherAIModel",
- "title": "Together"
- },
- {
- "$ref": "#/components/schemas/VapiModel",
- "title": "Vapi"
- },
+ "hooks": {
+ "type": "array",
+ "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
+ "title": "PhoneNumberHookCallRinging"
+ }
+ ]
+ }
+ },
+ "smsEnabled": {
+ "type": "boolean",
+ "description": "Controls whether Vapi sets the messaging webhook URL on the Twilio number during import.\n\nIf set to `false`, Vapi will not update the Twilio messaging URL, leaving it as is.\nIf `true` or omitted (default), Vapi will configure both the voice and messaging URLs.\n\n@default true",
+ "default": true
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of the phone number. This is just for your own reference.",
+ "maxLength": 40
+ },
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "squadId": {
+ "type": "string",
+ "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "allOf": [
{
- "$ref": "#/components/schemas/XaiModel",
- "title": "XAI"
+ "$ref": "#/components/schemas/Server"
}
]
},
- "voice": {
- "description": "These are the options for the assistant's voice.",
+ "number": {
+ "type": "string",
+ "description": "These are the digits of the phone number you own on your Twilio."
+ },
+ "twilioAccountSid": {
+ "type": "string",
+ "description": "This is the Twilio Account SID for the phone number."
+ },
+ "twilioAuthToken": {
+ "type": "string",
+ "description": "This is the Twilio Auth Token for the phone number."
+ },
+ "twilioApiKey": {
+ "type": "string",
+ "description": "This is the Twilio API Key for the phone number."
+ },
+ "twilioApiSecret": {
+ "type": "string",
+ "description": "This is the Twilio API Secret for the phone number."
+ }
+ }
+ },
+ "UpdateVonagePhoneNumberDTO": {
+ "type": "object",
+ "properties": {
+ "fallbackDestination": {
+ "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
"oneOf": [
{
- "$ref": "#/components/schemas/AzureVoice",
- "title": "Azure"
- },
- {
- "$ref": "#/components/schemas/CartesiaVoice",
- "title": "Cartesia"
- },
- {
- "$ref": "#/components/schemas/CustomVoice",
- "title": "CustomVoice"
- },
- {
- "$ref": "#/components/schemas/DeepgramVoice",
- "title": "Deepgram"
- },
- {
- "$ref": "#/components/schemas/ElevenLabsVoice",
- "title": "ElevenLabs"
- },
- {
- "$ref": "#/components/schemas/HumeVoice",
- "title": "Hume"
- },
- {
- "$ref": "#/components/schemas/LMNTVoice",
- "title": "LMNT"
- },
- {
- "$ref": "#/components/schemas/NeuphonicVoice",
- "title": "Neuphonic"
- },
- {
- "$ref": "#/components/schemas/OpenAIVoice",
- "title": "OpenAI"
- },
- {
- "$ref": "#/components/schemas/PlayHTVoice",
- "title": "PlayHT"
- },
- {
- "$ref": "#/components/schemas/RimeAIVoice",
- "title": "RimeAI"
- },
- {
- "$ref": "#/components/schemas/SmallestAIVoice",
- "title": "SmallestAI"
- },
- {
- "$ref": "#/components/schemas/TavusVoice",
- "title": "TavusVoice"
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "NumberTransferDestination"
},
{
- "$ref": "#/components/schemas/VapiVoice",
- "title": "Vapi"
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "SipTransferDestination"
}
- ],
- "default": {
- "provider": "playht",
- "voiceId": "jennifer"
+ ]
+ },
+ "hooks": {
+ "type": "array",
+ "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
+ "title": "PhoneNumberHookCallRinging"
+ }
+ ]
}
},
- "firstMessage": {
+ "name": {
"type": "string",
- "description": "This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).\n\nIf unspecified, assistant will wait for user to speak and use the model to respond once they speak.",
- "example": "Hello! How can I help you today?"
+ "description": "This is the name of the phone number. This is just for your own reference.",
+ "maxLength": 40
},
- "firstMessageInterruptionsEnabled": {
- "type": "boolean",
- "default": false
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
},
- "firstMessageMode": {
+ "workflowId": {
"type": "string",
- "description": "This is the mode for the first message. Default is 'assistant-speaks-first'.\n\nUse:\n- 'assistant-speaks-first' to have the assistant speak first.\n- 'assistant-waits-for-user' to have the assistant wait for the user to speak first.\n- 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points).\n\n@default 'assistant-speaks-first'",
- "enum": [
- "assistant-speaks-first",
- "assistant-speaks-first-with-model-generated-message",
- "assistant-waits-for-user"
- ],
- "example": "assistant-speaks-first"
+ "description": "This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
},
- "voicemailDetection": {
- "description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.",
- "oneOf": [
+ "squadId": {
+ "type": "string",
+ "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "allOf": [
{
- "$ref": "#/components/schemas/GoogleVoicemailDetectionPlan",
- "title": "Google"
- },
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
+ },
+ "number": {
+ "type": "string",
+ "description": "These are the digits of the phone number you own on your Vonage."
+ },
+ "credentialId": {
+ "type": "string",
+ "description": "This is the credential you added in dashboard.vapi.ai/keys. This is used to configure the number to send inbound calls to Vapi, make outbound calls and do live call updates like transfers and hangups."
+ }
+ }
+ },
+ "UpdateVapiPhoneNumberDTO": {
+ "type": "object",
+ "properties": {
+ "fallbackDestination": {
+ "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
+ "oneOf": [
{
- "$ref": "#/components/schemas/OpenAIVoicemailDetectionPlan",
- "title": "OpenAI"
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "NumberTransferDestination"
},
{
- "$ref": "#/components/schemas/TwilioVoicemailDetectionPlan",
- "title": "Twilio"
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "SipTransferDestination"
}
]
},
- "clientMessages": {
- "type": "array",
- "enum": [
- "conversation-update",
- "function-call",
- "function-call-result",
- "hang",
- "language-changed",
- "metadata",
- "model-output",
- "speech-update",
- "status-update",
- "transcript",
- "tool-calls",
- "tool-calls-result",
- "transfer-update",
- "user-interrupted",
- "voice-input",
- "workflow.node.started"
- ],
- "example": [
- "conversation-update",
- "function-call",
- "hang",
- "model-output",
- "speech-update",
- "status-update",
- "transfer-update",
- "transcript",
- "tool-calls",
- "user-interrupted",
- "voice-input",
- "workflow.node.started"
- ],
- "description": "These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started. You can check the shape of the messages in ClientMessage schema.",
- "items": {
- "type": "string",
- "enum": [
- "conversation-update",
- "function-call",
- "function-call-result",
- "hang",
- "language-changed",
- "metadata",
- "model-output",
- "speech-update",
- "status-update",
- "transcript",
- "tool-calls",
- "tool-calls-result",
- "transfer-update",
- "user-interrupted",
- "voice-input",
- "workflow.node.started"
- ]
- }
- },
- "serverMessages": {
+ "hooks": {
"type": "array",
- "enum": [
- "conversation-update",
- "end-of-call-report",
- "function-call",
- "hang",
- "language-changed",
- "language-change-detected",
- "model-output",
- "phone-call-control",
- "speech-update",
- "status-update",
- "transcript",
- "transcript[transcriptType=\"final\"]",
- "tool-calls",
- "transfer-destination-request",
- "transfer-update",
- "user-interrupted",
- "voice-input"
- ],
- "example": [
- "conversation-update",
- "end-of-call-report",
- "function-call",
- "hang",
- "speech-update",
- "status-update",
- "tool-calls",
- "transfer-destination-request",
- "user-interrupted"
- ],
- "description": "These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,user-interrupted. You can check the shape of the messages in ServerMessage schema.",
+ "description": "This is the hooks that will be used for incoming calls to this phone number.",
"items": {
- "type": "string",
- "enum": [
- "conversation-update",
- "end-of-call-report",
- "function-call",
- "hang",
- "language-changed",
- "language-change-detected",
- "model-output",
- "phone-call-control",
- "speech-update",
- "status-update",
- "transcript",
- "transcript[transcriptType=\"final\"]",
- "tool-calls",
- "transfer-destination-request",
- "transfer-update",
- "user-interrupted",
- "voice-input"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
+ "title": "PhoneNumberHookCallRinging"
+ }
]
}
},
- "silenceTimeoutSeconds": {
- "type": "number",
- "description": "How many seconds of silence to wait before ending the call. Defaults to 30.\n\n@default 30",
- "minimum": 10,
- "maximum": 3600,
- "example": 30
+ "name": {
+ "type": "string",
+ "description": "This is the name of the phone number. This is just for your own reference.",
+ "maxLength": 40
},
- "maxDurationSeconds": {
- "type": "number",
- "description": "This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.\n\n@default 600 (10 minutes)",
- "minimum": 10,
- "maximum": 43200,
- "example": 600
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
},
- "backgroundSound": {
- "description": "This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.\nYou can also provide a custom sound by providing a URL to an audio file.",
- "maxLength": 1000,
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "squadId": {
+ "type": "string",
+ "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
+ },
+ "sipUri": {
+ "type": "string",
+ "description": "This is the SIP URI of the phone number. You can SIP INVITE this. The assistant attached to this number will answer.\n\nThis is case-insensitive."
+ },
+ "authentication": {
+ "description": "This enables authentication for incoming SIP INVITE requests to the `sipUri`.\n\nIf not set, any username/password to the 401 challenge of the SIP INVITE will be accepted.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SipAuthentication"
+ }
+ ]
+ }
+ }
+ },
+ "UpdateTelnyxPhoneNumberDTO": {
+ "type": "object",
+ "properties": {
+ "fallbackDestination": {
+ "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
"oneOf": [
{
- "type": "enum",
- "enum": [
- "off",
- "office"
- ],
- "example": "office"
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "NumberTransferDestination"
},
{
- "type": "string",
- "format": "uri",
- "example": "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3"
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "SipTransferDestination"
}
]
},
- "backgroundDenoisingEnabled": {
- "type": "boolean",
- "description": "This enables filtering of noise and background speech while the user is talking.\n\nDefault `false` while in beta.\n\n@default false",
- "example": false
- },
- "modelOutputInMessagesEnabled": {
- "type": "boolean",
- "description": "This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech.\n\nDefault `false` while in beta.\n\n@default false",
- "example": false
- },
- "transportConfigurations": {
+ "hooks": {
"type": "array",
- "description": "These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used.",
+ "description": "This is the hooks that will be used for incoming calls to this phone number.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/TransportConfigurationTwilio",
- "title": "Twilio"
+ "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
+ "title": "PhoneNumberHookCallRinging"
}
]
}
},
- "observabilityPlan": {
- "description": "This is the plan for observability configuration of assistant's calls.\nCurrently supports Langfuse for tracing and monitoring.",
- "oneOf": [
+ "name": {
+ "type": "string",
+ "description": "This is the name of the phone number. This is just for your own reference.",
+ "maxLength": 40
+ },
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "squadId": {
+ "type": "string",
+ "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "allOf": [
{
- "$ref": "#/components/schemas/LangfuseObservabilityPlan",
- "title": "Langfuse"
+ "$ref": "#/components/schemas/Server"
}
- ],
- "allOf": [
+ ]
+ },
+ "number": {
+ "type": "string",
+ "description": "These are the digits of the phone number you own on your Telnyx."
+ },
+ "credentialId": {
+ "type": "string",
+ "description": "This is the credential you added in dashboard.vapi.ai/keys. This is used to configure the number to send inbound calls to Vapi, make outbound calls and do live call updates like transfers and hangups."
+ }
+ }
+ },
+ "ImportVonagePhoneNumberDTO": {
+ "type": "object",
+ "properties": {
+ "fallbackDestination": {
+ "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
+ "oneOf": [
{
- "$ref": "#/components/schemas/LangfuseObservabilityPlan"
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "NumberTransferDestination"
+ },
+ {
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "SipTransferDestination"
}
]
},
- "credentials": {
+ "hooks": {
"type": "array",
- "description": "These are dynamic credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.",
+ "description": "This is the hooks that will be used for incoming calls to this phone number.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/CreateAnthropicCredentialDTO",
- "title": "AnthropicCredential"
- },
- {
- "$ref": "#/components/schemas/CreateAnyscaleCredentialDTO",
- "title": "AnyscaleCredential"
- },
- {
- "$ref": "#/components/schemas/CreateAssemblyAICredentialDTO",
- "title": "AssemblyAICredential"
- },
- {
- "$ref": "#/components/schemas/CreateAzureCredentialDTO",
- "title": "AzureCredential"
- },
- {
- "$ref": "#/components/schemas/CreateAzureOpenAICredentialDTO",
- "title": "AzureOpenAICredential"
- },
- {
- "$ref": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
- "title": "ByoSipTrunkCredential"
- },
- {
- "$ref": "#/components/schemas/CreateCartesiaCredentialDTO",
- "title": "CartesiaCredential"
- },
- {
- "$ref": "#/components/schemas/CreateCerebrasCredentialDTO",
- "title": "CerebrasCredential"
- },
- {
- "$ref": "#/components/schemas/CreateCloudflareCredentialDTO",
- "title": "CloudflareCredential"
- },
- {
- "$ref": "#/components/schemas/CreateCustomLLMCredentialDTO",
- "title": "CustomLLMCredential"
- },
- {
- "$ref": "#/components/schemas/CreateDeepgramCredentialDTO",
- "title": "DeepgramCredential"
- },
- {
- "$ref": "#/components/schemas/CreateDeepInfraCredentialDTO",
- "title": "DeepInfraCredential"
- },
- {
- "$ref": "#/components/schemas/CreateDeepSeekCredentialDTO",
- "title": "DeepSeekCredential"
- },
- {
- "$ref": "#/components/schemas/CreateElevenLabsCredentialDTO",
- "title": "ElevenLabsCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGcpCredentialDTO",
- "title": "GcpCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGladiaCredentialDTO",
- "title": "GladiaCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGoHighLevelCredentialDTO",
- "title": "GhlCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCredentialDTO",
- "title": "GoogleCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGroqCredentialDTO",
- "title": "GroqCredential"
- },
- {
- "$ref": "#/components/schemas/CreateHumeCredentialDTO",
- "title": "HumeCredential"
- },
- {
- "$ref": "#/components/schemas/CreateInflectionAICredentialDTO",
- "title": "InflectionAICredential"
- },
- {
- "$ref": "#/components/schemas/CreateLangfuseCredentialDTO",
- "title": "LangfuseCredential"
- },
- {
- "$ref": "#/components/schemas/CreateLmntCredentialDTO",
- "title": "LmntCredential"
- },
- {
- "$ref": "#/components/schemas/CreateMakeCredentialDTO",
- "title": "MakeCredential"
- },
- {
- "$ref": "#/components/schemas/CreateMistralCredentialDTO",
- "title": "MistralCredential"
- },
- {
- "$ref": "#/components/schemas/CreateNeuphonicCredentialDTO",
- "title": "NeuphonicCredential"
- },
- {
- "$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/CreateS3CredentialDTO",
- "title": "S3Credential"
- },
- {
- "$ref": "#/components/schemas/CreateSmallestAICredentialDTO",
- "title": "SmallestAICredential"
- },
- {
- "$ref": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
- "title": "SpeechmaticsCredential"
- },
- {
- "$ref": "#/components/schemas/CreateSupabaseCredentialDTO",
- "title": "SupabaseCredential"
- },
- {
- "$ref": "#/components/schemas/CreateTavusCredentialDTO",
- "title": "TavusCredential"
- },
- {
- "$ref": "#/components/schemas/CreateTogetherAICredentialDTO",
- "title": "TogetherAICredential"
- },
+ "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
+ "title": "PhoneNumberHookCallRinging"
+ }
+ ]
+ }
+ },
+ "vonagePhoneNumber": {
+ "type": "string",
+ "description": "These are the digits of the phone number you own on your Vonage.",
+ "deprecated": true
+ },
+ "credentialId": {
+ "type": "string",
+ "description": "This is the credential you added in dashboard.vapi.ai/keys. This is used to configure the number to send inbound calls to Vapi, make outbound calls and do live call updates like transfers and hangups."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of the phone number. This is just for your own reference.",
+ "maxLength": 40
+ },
+ "assistantId": {
+ "type": "string",
+ "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId` nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "squadId": {
+ "type": "string",
+ "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId`, `squadId`, nor `workflowId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ },
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
+ }
+ },
+ "required": [
+ "vonagePhoneNumber",
+ "credentialId"
+ ]
+ },
+ "PhoneNumberPaginatedResponse": {
+ "type": "object",
+ "properties": {
+ "results": {
+ "type": "array",
+ "description": "A list of phone numbers, which can be of any provider type.",
+ "items": {
+ "oneOf": [
{
- "$ref": "#/components/schemas/CreateTrieveCredentialDTO",
- "title": "TrieveCredential"
+ "$ref": "#/components/schemas/ByoPhoneNumber"
},
{
- "$ref": "#/components/schemas/CreateTwilioCredentialDTO",
- "title": "TwilioCredential"
+ "$ref": "#/components/schemas/TwilioPhoneNumber"
},
{
- "$ref": "#/components/schemas/CreateVonageCredentialDTO",
- "title": "VonageCredential"
+ "$ref": "#/components/schemas/VonagePhoneNumber"
},
{
- "$ref": "#/components/schemas/CreateWebhookCredentialDTO",
- "title": "WebhookCredential"
+ "$ref": "#/components/schemas/VapiPhoneNumber"
},
{
- "$ref": "#/components/schemas/CreateXAiCredentialDTO",
- "title": "XAiCredential"
- },
+ "$ref": "#/components/schemas/TelnyxPhoneNumber"
+ }
+ ]
+ }
+ },
+ "metadata": {
+ "description": "Metadata about the pagination.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaginationMeta"
+ }
+ ]
+ }
+ },
+ "required": [
+ "results",
+ "metadata"
+ ]
+ },
+ "ApiRequestTool": {
+ "type": "object",
+ "properties": {
+ "messages": {
+ "type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "items": {
+ "oneOf": [
{
- "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
- "title": "GoogleCalendarOAuth2ClientCredential"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
},
{
- "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
- "title": "GoogleCalendarOAuth2AuthorizationCredential"
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
},
{
- "$ref": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
- "title": "GoogleSheetsOAuth2AuthorizationCredential"
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
},
{
- "$ref": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO",
- "title": "SlackOAuth2AuthorizationCredential"
- }
- ],
- "discriminator": {
- "propertyName": "provider",
- "mapping": {
- "11labs": "#/components/schemas/CreateElevenLabsCredentialDTO",
- "anthropic": "#/components/schemas/CreateAnthropicCredentialDTO",
- "anyscale": "#/components/schemas/CreateAnyscaleCredentialDTO",
- "assembly-ai": "#/components/schemas/CreateAssemblyAICredentialDTO",
- "azure-openai": "#/components/schemas/CreateAzureOpenAICredentialDTO",
- "azure": "#/components/schemas/CreateAzureCredentialDTO",
- "byo-sip-trunk": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
- "cartesia": "#/components/schemas/CreateCartesiaCredentialDTO",
- "cerebras": "#/components/schemas/CreateCerebrasCredentialDTO",
- "cloudflare": "#/components/schemas/CreateCloudflareCredentialDTO",
- "custom-llm": "#/components/schemas/CreateCustomLLMCredentialDTO",
- "deepgram": "#/components/schemas/CreateDeepgramCredentialDTO",
- "deepinfra": "#/components/schemas/CreateDeepInfraCredentialDTO",
- "deep-seek": "#/components/schemas/CreateDeepSeekCredentialDTO",
- "gcp": "#/components/schemas/CreateGcpCredentialDTO",
- "gladia": "#/components/schemas/CreateGladiaCredentialDTO",
- "gohighlevel": "#/components/schemas/CreateGoHighLevelCredentialDTO",
- "google": "#/components/schemas/CreateGoogleCredentialDTO",
- "groq": "#/components/schemas/CreateGroqCredentialDTO",
- "inflection-ai": "#/components/schemas/CreateInflectionAICredentialDTO",
- "langfuse": "#/components/schemas/CreateLangfuseCredentialDTO",
- "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",
- "s3": "#/components/schemas/CreateS3CredentialDTO",
- "supabase": "#/components/schemas/CreateSupabaseCredentialDTO",
- "smallest-ai": "#/components/schemas/CreateSmallestAICredentialDTO",
- "tavus": "#/components/schemas/CreateTavusCredentialDTO",
- "together-ai": "#/components/schemas/CreateTogetherAICredentialDTO",
- "twilio": "#/components/schemas/CreateTwilioCredentialDTO",
- "vonage": "#/components/schemas/CreateVonageCredentialDTO",
- "webhook": "#/components/schemas/CreateWebhookCredentialDTO",
- "xai": "#/components/schemas/CreateXAiCredentialDTO",
- "neuphonic": "#/components/schemas/CreateNeuphonicCredentialDTO",
- "hume": "#/components/schemas/CreateHumeCredentialDTO",
- "mistral": "#/components/schemas/CreateMistralCredentialDTO",
- "speechmatics": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
- "trieve": "#/components/schemas/CreateTrieveCredentialDTO",
- "google.calendar.oauth2-client": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
- "google.calendar.oauth2-authorization": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
- "google.sheets.oauth2-authorization": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
- "slack.oauth2-authorization": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO"
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
- }
+ ]
}
},
- "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.",
- "maxLength": 40
- },
- "voicemailMessage": {
+ "type": {
"type": "string",
- "description": "This is the message that the assistant will say if the call is forwarded to voicemail.\n\nIf unspecified, it will hang up.",
- "maxLength": 1000
+ "enum": [
+ "apiRequest"
+ ],
+ "description": "The type of tool. \"apiRequest\" for API request tool."
},
- "endCallMessage": {
+ "method": {
"type": "string",
- "description": "This is the message that the assistant will say if it ends the call.\n\nIf unspecified, it will hang up without saying anything.",
- "maxLength": 1000
+ "enum": [
+ "POST",
+ "GET"
+ ]
},
- "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": 140,
- "minLength": 2
- }
+ "timeoutSeconds": {
+ "type": "number",
+ "description": "This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20",
+ "minimum": 1,
+ "maximum": 300,
+ "example": 20
},
- "compliancePlan": {
- "$ref": "#/components/schemas/CompliancePlan"
+ "id": {
+ "type": "string",
+ "description": "This is the unique identifier for the tool."
},
- "metadata": {
- "type": "object",
- "description": "This is for metadata you want to store on the assistant."
+ "orgId": {
+ "type": "string",
+ "description": "This is the unique identifier for the organization that this tool belongs to."
},
- "analysisPlan": {
- "description": "This is the plan for analysis of assistant's calls. Stored in `call.analysis`.",
- "allOf": [
- {
- "$ref": "#/components/schemas/AnalysisPlan"
- }
- ]
+ "createdAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
},
- "artifactPlan": {
- "description": "This is the plan for artifacts generated during assistant's calls. Stored in `call.artifact`.\n\nNote: `recordingEnabled` is currently at the root level. It will be moved to `artifactPlan` in the future, but will remain backwards compatible.",
- "allOf": [
- {
- "$ref": "#/components/schemas/ArtifactPlan"
- }
- ]
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
},
- "messagePlan": {
- "description": "This is the plan for static predefined messages that can be spoken by the assistant during the call, like `idleMessages`.\n\nNote: `firstMessage`, `voicemailMessage`, and `endCallMessage` are currently at the root level. They will be moved to `messagePlan` in the future, but will remain backwards compatible.",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/MessagePlan"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
},
- "startSpeakingPlan": {
- "description": "This is the plan for when the assistant should start talking.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to start talking after the customer is done speaking.\n- The assistant is too fast to start talking after the customer is done speaking.\n- The assistant is so fast that it's actually interrupting the customer.",
+ "name": {
+ "type": "string",
+ "description": "This is the name of the tool. This will be passed to the model.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.",
+ "maxLength": 40,
+ "pattern": "/^[a-zA-Z0-9_-]{1,40}$/"
+ },
+ "description": {
+ "type": "string",
+ "description": "This is the description of the tool. This will be passed to the model.",
+ "maxLength": 1000
+ },
+ "url": {
+ "type": "string",
+ "description": "This is where the request will be sent."
+ },
+ "body": {
+ "description": "This is the body of the request.",
"allOf": [
{
- "$ref": "#/components/schemas/StartSpeakingPlan"
+ "$ref": "#/components/schemas/JsonSchema"
}
]
},
- "stopSpeakingPlan": {
- "description": "This is the plan for when assistant should stop talking on customer interruption.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to recognize customer's interruption.\n- The assistant is too fast to recognize customer's interruption.\n- The assistant is getting interrupted by phrases that are just acknowledgments.\n- The assistant is getting interrupted by background noises.\n- The assistant is not properly stopping -- it starts talking right after getting interrupted.",
+ "headers": {
+ "description": "These are the headers to send in the request.",
"allOf": [
{
- "$ref": "#/components/schemas/StopSpeakingPlan"
+ "$ref": "#/components/schemas/JsonSchema"
}
]
},
- "monitorPlan": {
- "description": "This is the plan for real-time monitoring of the assistant's calls.\n\nUsage:\n- To enable live listening of the assistant's calls, set `monitorPlan.listenEnabled` to `true`.\n- To enable live control of the assistant's calls, set `monitorPlan.controlEnabled` to `true`.\n\nNote, `serverMessages`, `clientMessages`, `serverUrl` and `serverUrlSecret` are currently at the root level but will be moved to `monitorPlan` in the future. Will remain backwards compatible",
+ "backoffPlan": {
+ "description": "This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)",
"allOf": [
{
- "$ref": "#/components/schemas/MonitorPlan"
+ "$ref": "#/components/schemas/BackoffPlan"
}
]
},
- "credentialIds": {
- "description": "These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server.url\n2. phoneNumber.serverUrl\n3. org.serverUrl",
+ "variableExtractionPlan": {
+ "description": "This is the plan that controls the variable extraction from the tool's response.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/VariableExtractionPlan"
}
]
- },
- "hooks": {
- "description": "This is a set of actions that will be performed on certain events.",
+ }
+ },
+ "required": [
+ "type",
+ "method",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt",
+ "url"
+ ]
+ },
+ "DtmfTool": {
+ "type": "object",
+ "properties": {
+ "messages": {
"type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
- "$ref": "#/components/schemas/AssistantHooks"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
}
},
- "keypadInputPlan": {
- "$ref": "#/components/schemas/KeypadInputPlan"
+ "type": {
+ "type": "string",
+ "enum": [
+ "dtmf"
+ ],
+ "description": "The type of tool. \"dtmf\" for DTMF tool."
},
"id": {
"type": "string",
- "description": "This is the unique identifier for the assistant."
+ "description": "This is the unique identifier for the tool."
},
"orgId": {
"type": "string",
- "description": "This is the unique identifier for the org that this assistant belongs to."
+ "description": "This is the unique identifier for the organization that this tool belongs to."
},
"createdAt": {
"format": "date-time",
"type": "string",
- "description": "This is the ISO 8601 date-time string of when the assistant was created."
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
},
"updatedAt": {
"format": "date-time",
"type": "string",
- "description": "This is the ISO 8601 date-time string of when the assistant was last updated."
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
}
},
"required": [
+ "type",
"id",
"orgId",
"createdAt",
"updatedAt"
]
},
- "AssistantPaginatedResponse": {
+ "EndCallTool": {
"type": "object",
"properties": {
- "results": {
+ "messages": {
"type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
- "$ref": "#/components/schemas/Assistant"
- }
- },
- "metadata": {
- "$ref": "#/components/schemas/PaginationMeta"
- }
- },
- "required": [
- "results",
- "metadata"
- ]
- },
- "UpdateAssistantDTO": {
- "type": "object",
- "properties": {
- "transcriber": {
- "description": "These are the options for the assistant's transcriber.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/AssemblyAITranscriber",
- "title": "AssemblyAI"
- },
- {
- "$ref": "#/components/schemas/AzureSpeechTranscriber",
- "title": "Azure"
- },
- {
- "$ref": "#/components/schemas/CustomTranscriber",
- "title": "CustomTranscriber"
- },
- {
- "$ref": "#/components/schemas/DeepgramTranscriber",
- "title": "Deepgram"
- },
- {
- "$ref": "#/components/schemas/ElevenLabsTranscriber",
- "title": "ElevenLabs"
- },
- {
- "$ref": "#/components/schemas/GladiaTranscriber",
- "title": "Gladia"
- },
- {
- "$ref": "#/components/schemas/SpeechmaticsTranscriber",
- "title": "Speechmatics"
- },
- {
- "$ref": "#/components/schemas/TalkscriberTranscriber",
- "title": "Talkscriber"
- },
- {
- "$ref": "#/components/schemas/GoogleTranscriber",
- "title": "Google"
- },
- {
- "$ref": "#/components/schemas/OpenAITranscriber",
- "title": "OpenAI"
- }
- ]
- },
- "model": {
- "description": "These are the options for the assistant's LLM.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/AnyscaleModel",
- "title": "Anyscale"
- },
- {
- "$ref": "#/components/schemas/AnthropicModel",
- "title": "Anthropic"
- },
- {
- "$ref": "#/components/schemas/CerebrasModel",
- "title": "Cerebras"
- },
- {
- "$ref": "#/components/schemas/CustomLLMModel",
- "title": "CustomLLM"
- },
- {
- "$ref": "#/components/schemas/DeepInfraModel",
- "title": "DeepInfra"
- },
- {
- "$ref": "#/components/schemas/DeepSeekModel",
- "title": "DeepSeek"
- },
- {
- "$ref": "#/components/schemas/GoogleModel",
- "title": "Google"
- },
- {
- "$ref": "#/components/schemas/GroqModel",
- "title": "Groq"
- },
- {
- "$ref": "#/components/schemas/InflectionAIModel",
- "title": "InflectionAI"
- },
- {
- "$ref": "#/components/schemas/OpenAIModel",
- "title": "OpenAI"
- },
- {
- "$ref": "#/components/schemas/OpenRouterModel",
- "title": "OpenRouter"
- },
- {
- "$ref": "#/components/schemas/PerplexityAIModel",
- "title": "PerplexityAI"
- },
- {
- "$ref": "#/components/schemas/TogetherAIModel",
- "title": "Together"
- },
- {
- "$ref": "#/components/schemas/VapiModel",
- "title": "Vapi"
- },
- {
- "$ref": "#/components/schemas/XaiModel",
- "title": "XAI"
- }
- ]
- },
- "voice": {
- "description": "These are the options for the assistant's voice.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/AzureVoice",
- "title": "Azure"
- },
- {
- "$ref": "#/components/schemas/CartesiaVoice",
- "title": "Cartesia"
- },
- {
- "$ref": "#/components/schemas/CustomVoice",
- "title": "CustomVoice"
- },
- {
- "$ref": "#/components/schemas/DeepgramVoice",
- "title": "Deepgram"
- },
- {
- "$ref": "#/components/schemas/ElevenLabsVoice",
- "title": "ElevenLabs"
- },
- {
- "$ref": "#/components/schemas/HumeVoice",
- "title": "Hume"
- },
- {
- "$ref": "#/components/schemas/LMNTVoice",
- "title": "LMNT"
- },
- {
- "$ref": "#/components/schemas/NeuphonicVoice",
- "title": "Neuphonic"
- },
- {
- "$ref": "#/components/schemas/OpenAIVoice",
- "title": "OpenAI"
- },
- {
- "$ref": "#/components/schemas/PlayHTVoice",
- "title": "PlayHT"
- },
- {
- "$ref": "#/components/schemas/RimeAIVoice",
- "title": "RimeAI"
- },
- {
- "$ref": "#/components/schemas/SmallestAIVoice",
- "title": "SmallestAI"
- },
- {
- "$ref": "#/components/schemas/TavusVoice",
- "title": "TavusVoice"
- },
- {
- "$ref": "#/components/schemas/VapiVoice",
- "title": "Vapi"
- }
- ],
- "default": {
- "provider": "playht",
- "voiceId": "jennifer"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
}
},
- "firstMessage": {
- "type": "string",
- "description": "This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).\n\nIf unspecified, assistant will wait for user to speak and use the model to respond once they speak.",
- "example": "Hello! How can I help you today?"
- },
- "firstMessageInterruptionsEnabled": {
- "type": "boolean",
- "default": false
- },
- "firstMessageMode": {
+ "type": {
"type": "string",
- "description": "This is the mode for the first message. Default is 'assistant-speaks-first'.\n\nUse:\n- 'assistant-speaks-first' to have the assistant speak first.\n- 'assistant-waits-for-user' to have the assistant wait for the user to speak first.\n- 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points).\n\n@default 'assistant-speaks-first'",
"enum": [
- "assistant-speaks-first",
- "assistant-speaks-first-with-model-generated-message",
- "assistant-waits-for-user"
+ "endCall"
],
- "example": "assistant-speaks-first"
- },
- "voicemailDetection": {
- "description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/GoogleVoicemailDetectionPlan",
- "title": "Google"
- },
- {
- "$ref": "#/components/schemas/OpenAIVoicemailDetectionPlan",
- "title": "OpenAI"
- },
- {
- "$ref": "#/components/schemas/TwilioVoicemailDetectionPlan",
- "title": "Twilio"
- }
- ]
+ "description": "The type of tool. \"endCall\" for End Call tool."
},
- "clientMessages": {
- "type": "array",
- "enum": [
- "conversation-update",
- "function-call",
- "function-call-result",
- "hang",
- "language-changed",
- "metadata",
- "model-output",
- "speech-update",
- "status-update",
- "transcript",
- "tool-calls",
- "tool-calls-result",
- "transfer-update",
- "user-interrupted",
- "voice-input",
- "workflow.node.started"
- ],
- "example": [
- "conversation-update",
- "function-call",
- "hang",
- "model-output",
- "speech-update",
- "status-update",
- "transfer-update",
- "transcript",
- "tool-calls",
- "user-interrupted",
- "voice-input",
- "workflow.node.started"
- ],
- "description": "These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started. You can check the shape of the messages in ClientMessage schema.",
- "items": {
- "type": "string",
- "enum": [
- "conversation-update",
- "function-call",
- "function-call-result",
- "hang",
- "language-changed",
- "metadata",
- "model-output",
- "speech-update",
- "status-update",
- "transcript",
- "tool-calls",
- "tool-calls-result",
- "transfer-update",
- "user-interrupted",
- "voice-input",
- "workflow.node.started"
- ]
- }
+ "id": {
+ "type": "string",
+ "description": "This is the unique identifier for the tool."
},
- "serverMessages": {
- "type": "array",
- "enum": [
- "conversation-update",
- "end-of-call-report",
- "function-call",
- "hang",
- "language-changed",
- "language-change-detected",
- "model-output",
- "phone-call-control",
- "speech-update",
- "status-update",
- "transcript",
- "transcript[transcriptType=\"final\"]",
- "tool-calls",
- "transfer-destination-request",
- "transfer-update",
- "user-interrupted",
- "voice-input"
- ],
- "example": [
- "conversation-update",
- "end-of-call-report",
- "function-call",
- "hang",
- "speech-update",
- "status-update",
- "tool-calls",
- "transfer-destination-request",
- "user-interrupted"
- ],
- "description": "These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,user-interrupted. You can check the shape of the messages in ServerMessage schema.",
- "items": {
- "type": "string",
- "enum": [
- "conversation-update",
- "end-of-call-report",
- "function-call",
- "hang",
- "language-changed",
- "language-change-detected",
- "model-output",
- "phone-call-control",
- "speech-update",
- "status-update",
- "transcript",
- "transcript[transcriptType=\"final\"]",
- "tool-calls",
- "transfer-destination-request",
- "transfer-update",
- "user-interrupted",
- "voice-input"
- ]
- }
+ "orgId": {
+ "type": "string",
+ "description": "This is the unique identifier for the organization that this tool belongs to."
},
- "silenceTimeoutSeconds": {
- "type": "number",
- "description": "How many seconds of silence to wait before ending the call. Defaults to 30.\n\n@default 30",
- "minimum": 10,
- "maximum": 3600,
- "example": 30
+ "createdAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
},
- "maxDurationSeconds": {
- "type": "number",
- "description": "This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.\n\n@default 600 (10 minutes)",
- "minimum": 10,
- "maximum": 43200,
- "example": 600
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
},
- "backgroundSound": {
- "description": "This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.\nYou can also provide a custom sound by providing a URL to an audio file.",
- "maxLength": 1000,
- "oneOf": [
- {
- "type": "enum",
- "enum": [
- "off",
- "office"
- ],
- "example": "office"
- },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
{
- "type": "string",
- "format": "uri",
- "example": "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
- },
- "backgroundDenoisingEnabled": {
- "type": "boolean",
- "description": "This enables filtering of noise and background speech while the user is talking.\n\nDefault `false` while in beta.\n\n@default false",
- "example": false
- },
- "modelOutputInMessagesEnabled": {
- "type": "boolean",
- "description": "This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech.\n\nDefault `false` while in beta.\n\n@default false",
- "example": false
- },
- "transportConfigurations": {
+ }
+ },
+ "required": [
+ "type",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt"
+ ]
+ },
+ "FunctionTool": {
+ "type": "object",
+ "properties": {
+ "messages": {
"type": "array",
- "description": "These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/TransportConfigurationTwilio",
- "title": "Twilio"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "observabilityPlan": {
- "description": "This is the plan for observability configuration of assistant's calls.\nCurrently supports Langfuse for tracing and monitoring.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/LangfuseObservabilityPlan",
- "title": "Langfuse"
- }
+ "type": {
+ "type": "string",
+ "enum": [
+ "function"
],
+ "description": "The type of tool. \"function\" for Function tool."
+ },
+ "async": {
+ "type": "boolean",
+ "example": false,
+ "description": "This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`)."
+ },
+ "server": {
+ "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.",
"allOf": [
{
- "$ref": "#/components/schemas/LangfuseObservabilityPlan"
+ "$ref": "#/components/schemas/Server"
}
]
},
- "credentials": {
+ "id": {
+ "type": "string",
+ "description": "This is the unique identifier for the tool."
+ },
+ "orgId": {
+ "type": "string",
+ "description": "This is the unique identifier for the organization that this tool belongs to."
+ },
+ "createdAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
+ },
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt"
+ ]
+ },
+ "GhlTool": {
+ "type": "object",
+ "properties": {
+ "messages": {
"type": "array",
- "description": "These are dynamic credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/CreateAnthropicCredentialDTO",
- "title": "AnthropicCredential"
- },
- {
- "$ref": "#/components/schemas/CreateAnyscaleCredentialDTO",
- "title": "AnyscaleCredential"
- },
- {
- "$ref": "#/components/schemas/CreateAssemblyAICredentialDTO",
- "title": "AssemblyAICredential"
- },
- {
- "$ref": "#/components/schemas/CreateAzureCredentialDTO",
- "title": "AzureCredential"
- },
- {
- "$ref": "#/components/schemas/CreateAzureOpenAICredentialDTO",
- "title": "AzureOpenAICredential"
- },
- {
- "$ref": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
- "title": "ByoSipTrunkCredential"
- },
- {
- "$ref": "#/components/schemas/CreateCartesiaCredentialDTO",
- "title": "CartesiaCredential"
- },
- {
- "$ref": "#/components/schemas/CreateCerebrasCredentialDTO",
- "title": "CerebrasCredential"
- },
- {
- "$ref": "#/components/schemas/CreateCloudflareCredentialDTO",
- "title": "CloudflareCredential"
- },
- {
- "$ref": "#/components/schemas/CreateCustomLLMCredentialDTO",
- "title": "CustomLLMCredential"
- },
- {
- "$ref": "#/components/schemas/CreateDeepgramCredentialDTO",
- "title": "DeepgramCredential"
- },
- {
- "$ref": "#/components/schemas/CreateDeepInfraCredentialDTO",
- "title": "DeepInfraCredential"
- },
- {
- "$ref": "#/components/schemas/CreateDeepSeekCredentialDTO",
- "title": "DeepSeekCredential"
- },
- {
- "$ref": "#/components/schemas/CreateElevenLabsCredentialDTO",
- "title": "ElevenLabsCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGcpCredentialDTO",
- "title": "GcpCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGladiaCredentialDTO",
- "title": "GladiaCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGoHighLevelCredentialDTO",
- "title": "GhlCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGoogleCredentialDTO",
- "title": "GoogleCredential"
- },
- {
- "$ref": "#/components/schemas/CreateGroqCredentialDTO",
- "title": "GroqCredential"
- },
- {
- "$ref": "#/components/schemas/CreateHumeCredentialDTO",
- "title": "HumeCredential"
- },
- {
- "$ref": "#/components/schemas/CreateInflectionAICredentialDTO",
- "title": "InflectionAICredential"
- },
- {
- "$ref": "#/components/schemas/CreateLangfuseCredentialDTO",
- "title": "LangfuseCredential"
- },
- {
- "$ref": "#/components/schemas/CreateLmntCredentialDTO",
- "title": "LmntCredential"
- },
- {
- "$ref": "#/components/schemas/CreateMakeCredentialDTO",
- "title": "MakeCredential"
- },
- {
- "$ref": "#/components/schemas/CreateMistralCredentialDTO",
- "title": "MistralCredential"
- },
- {
- "$ref": "#/components/schemas/CreateNeuphonicCredentialDTO",
- "title": "NeuphonicCredential"
- },
- {
- "$ref": "#/components/schemas/CreateOpenAICredentialDTO",
- "title": "OpenAICredential"
- },
- {
- "$ref": "#/components/schemas/CreateOpenRouterCredentialDTO",
- "title": "OpenRouterCredential"
- },
- {
- "$ref": "#/components/schemas/CreatePerplexityAICredentialDTO",
- "title": "PerplexityAICredential"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
},
{
- "$ref": "#/components/schemas/CreatePlayHTCredentialDTO",
- "title": "PlayHTCredential"
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
},
{
- "$ref": "#/components/schemas/CreateRimeAICredentialDTO",
- "title": "RimeAICredential"
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
},
{
- "$ref": "#/components/schemas/CreateRunpodCredentialDTO",
- "title": "RunpodCredential"
- },
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
+ }
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "ghl"
+ ],
+ "description": "The type of tool. \"ghl\" for GHL tool."
+ },
+ "id": {
+ "type": "string",
+ "description": "This is the unique identifier for the tool."
+ },
+ "orgId": {
+ "type": "string",
+ "description": "This is the unique identifier for the organization that this tool belongs to."
+ },
+ "createdAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
+ },
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
+ },
+ "metadata": {
+ "$ref": "#/components/schemas/GhlToolMetadata"
+ }
+ },
+ "required": [
+ "type",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt",
+ "metadata"
+ ]
+ },
+ "MakeTool": {
+ "type": "object",
+ "properties": {
+ "messages": {
+ "type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "items": {
+ "oneOf": [
{
- "$ref": "#/components/schemas/CreateS3CredentialDTO",
- "title": "S3Credential"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
},
{
- "$ref": "#/components/schemas/CreateSmallestAICredentialDTO",
- "title": "SmallestAICredential"
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
},
{
- "$ref": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
- "title": "SpeechmaticsCredential"
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
},
{
- "$ref": "#/components/schemas/CreateSupabaseCredentialDTO",
- "title": "SupabaseCredential"
- },
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
+ }
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "make"
+ ],
+ "description": "The type of tool. \"make\" for Make tool."
+ },
+ "id": {
+ "type": "string",
+ "description": "This is the unique identifier for the tool."
+ },
+ "orgId": {
+ "type": "string",
+ "description": "This is the unique identifier for the organization that this tool belongs to."
+ },
+ "createdAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
+ },
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
+ },
+ "metadata": {
+ "$ref": "#/components/schemas/MakeToolMetadata"
+ }
+ },
+ "required": [
+ "type",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt",
+ "metadata"
+ ]
+ },
+ "TransferCallTool": {
+ "type": "object",
+ "properties": {
+ "messages": {
+ "type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "items": {
+ "oneOf": [
{
- "$ref": "#/components/schemas/CreateTavusCredentialDTO",
- "title": "TavusCredential"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
},
{
- "$ref": "#/components/schemas/CreateTogetherAICredentialDTO",
- "title": "TogetherAICredential"
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
},
{
- "$ref": "#/components/schemas/CreateTrieveCredentialDTO",
- "title": "TrieveCredential"
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
},
{
- "$ref": "#/components/schemas/CreateTwilioCredentialDTO",
- "title": "TwilioCredential"
- },
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
+ }
+ },
+ "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.",
+ "items": {
+ "oneOf": [
{
- "$ref": "#/components/schemas/CreateVonageCredentialDTO",
- "title": "VonageCredential"
+ "$ref": "#/components/schemas/TransferDestinationAssistant",
+ "title": "Assistant"
},
{
- "$ref": "#/components/schemas/CreateWebhookCredentialDTO",
- "title": "WebhookCredential"
+ "$ref": "#/components/schemas/TransferDestinationNumber",
+ "title": "Number"
},
{
- "$ref": "#/components/schemas/CreateXAiCredentialDTO",
- "title": "XAiCredential"
- },
+ "$ref": "#/components/schemas/TransferDestinationSip",
+ "title": "Sip"
+ }
+ ]
+ }
+ },
+ "id": {
+ "type": "string",
+ "description": "This is the unique identifier for the tool."
+ },
+ "orgId": {
+ "type": "string",
+ "description": "This is the unique identifier for the organization that this tool belongs to."
+ },
+ "createdAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
+ },
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt"
+ ]
+ },
+ "OutputTool": {
+ "type": "object",
+ "properties": {
+ "messages": {
+ "type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "items": {
+ "oneOf": [
{
- "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
- "title": "GoogleCalendarOAuth2ClientCredential"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
},
{
- "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
- "title": "GoogleCalendarOAuth2AuthorizationCredential"
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
},
{
- "$ref": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
- "title": "GoogleSheetsOAuth2AuthorizationCredential"
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
},
{
- "$ref": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO",
- "title": "SlackOAuth2AuthorizationCredential"
- }
- ],
- "discriminator": {
- "propertyName": "provider",
- "mapping": {
- "11labs": "#/components/schemas/CreateElevenLabsCredentialDTO",
- "anthropic": "#/components/schemas/CreateAnthropicCredentialDTO",
- "anyscale": "#/components/schemas/CreateAnyscaleCredentialDTO",
- "assembly-ai": "#/components/schemas/CreateAssemblyAICredentialDTO",
- "azure-openai": "#/components/schemas/CreateAzureOpenAICredentialDTO",
- "azure": "#/components/schemas/CreateAzureCredentialDTO",
- "byo-sip-trunk": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
- "cartesia": "#/components/schemas/CreateCartesiaCredentialDTO",
- "cerebras": "#/components/schemas/CreateCerebrasCredentialDTO",
- "cloudflare": "#/components/schemas/CreateCloudflareCredentialDTO",
- "custom-llm": "#/components/schemas/CreateCustomLLMCredentialDTO",
- "deepgram": "#/components/schemas/CreateDeepgramCredentialDTO",
- "deepinfra": "#/components/schemas/CreateDeepInfraCredentialDTO",
- "deep-seek": "#/components/schemas/CreateDeepSeekCredentialDTO",
- "gcp": "#/components/schemas/CreateGcpCredentialDTO",
- "gladia": "#/components/schemas/CreateGladiaCredentialDTO",
- "gohighlevel": "#/components/schemas/CreateGoHighLevelCredentialDTO",
- "google": "#/components/schemas/CreateGoogleCredentialDTO",
- "groq": "#/components/schemas/CreateGroqCredentialDTO",
- "inflection-ai": "#/components/schemas/CreateInflectionAICredentialDTO",
- "langfuse": "#/components/schemas/CreateLangfuseCredentialDTO",
- "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",
- "s3": "#/components/schemas/CreateS3CredentialDTO",
- "supabase": "#/components/schemas/CreateSupabaseCredentialDTO",
- "smallest-ai": "#/components/schemas/CreateSmallestAICredentialDTO",
- "tavus": "#/components/schemas/CreateTavusCredentialDTO",
- "together-ai": "#/components/schemas/CreateTogetherAICredentialDTO",
- "twilio": "#/components/schemas/CreateTwilioCredentialDTO",
- "vonage": "#/components/schemas/CreateVonageCredentialDTO",
- "webhook": "#/components/schemas/CreateWebhookCredentialDTO",
- "xai": "#/components/schemas/CreateXAiCredentialDTO",
- "neuphonic": "#/components/schemas/CreateNeuphonicCredentialDTO",
- "hume": "#/components/schemas/CreateHumeCredentialDTO",
- "mistral": "#/components/schemas/CreateMistralCredentialDTO",
- "speechmatics": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
- "trieve": "#/components/schemas/CreateTrieveCredentialDTO",
- "google.calendar.oauth2-client": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
- "google.calendar.oauth2-authorization": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
- "google.sheets.oauth2-authorization": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
- "slack.oauth2-authorization": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO"
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
- }
+ ]
}
},
- "name": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "output"
+ ],
+ "description": "The type of tool. \"output\" for Output tool."
+ },
+ "id": {
+ "type": "string",
+ "description": "This is the unique identifier for the tool."
+ },
+ "orgId": {
"type": "string",
- "description": "This is the name of the assistant.\n\nThis is required when you want to transfer between assistants in a call.",
- "maxLength": 40
+ "description": "This is the unique identifier for the organization that this tool belongs to."
},
- "voicemailMessage": {
+ "createdAt": {
+ "format": "date-time",
"type": "string",
- "description": "This is the message that the assistant will say if the call is forwarded to voicemail.\n\nIf unspecified, it will hang up.",
- "maxLength": 1000
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
},
- "endCallMessage": {
+ "updatedAt": {
+ "format": "date-time",
"type": "string",
- "description": "This is the message that the assistant will say if it ends the call.\n\nIf unspecified, it will hang up without saying anything.",
- "maxLength": 1000
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
},
- "endCallPhrases": {
- "description": "This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt"
+ ]
+ },
+ "BashTool": {
+ "type": "object",
+ "properties": {
+ "messages": {
"type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
- "type": "string",
- "maxLength": 140,
- "minLength": 2
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
}
},
- "compliancePlan": {
- "$ref": "#/components/schemas/CompliancePlan"
+ "type": {
+ "type": "string",
+ "enum": [
+ "bash"
+ ],
+ "description": "The type of tool. \"bash\" for Bash tool."
},
- "metadata": {
- "type": "object",
- "description": "This is for metadata you want to store on the assistant."
+ "subType": {
+ "type": "string",
+ "enum": [
+ "bash_20241022"
+ ],
+ "description": "The sub type of tool."
},
- "analysisPlan": {
- "description": "This is the plan for analysis of assistant's calls. Stored in `call.analysis`.",
+ "server": {
+ "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.",
"allOf": [
{
- "$ref": "#/components/schemas/AnalysisPlan"
+ "$ref": "#/components/schemas/Server"
}
]
},
- "artifactPlan": {
- "description": "This is the plan for artifacts generated during assistant's calls. Stored in `call.artifact`.\n\nNote: `recordingEnabled` is currently at the root level. It will be moved to `artifactPlan` in the future, but will remain backwards compatible.",
- "allOf": [
- {
- "$ref": "#/components/schemas/ArtifactPlan"
- }
- ]
+ "id": {
+ "type": "string",
+ "description": "This is the unique identifier for the tool."
},
- "messagePlan": {
- "description": "This is the plan for static predefined messages that can be spoken by the assistant during the call, like `idleMessages`.\n\nNote: `firstMessage`, `voicemailMessage`, and `endCallMessage` are currently at the root level. They will be moved to `messagePlan` in the future, but will remain backwards compatible.",
- "allOf": [
- {
- "$ref": "#/components/schemas/MessagePlan"
- }
- ]
+ "orgId": {
+ "type": "string",
+ "description": "This is the unique identifier for the organization that this tool belongs to."
},
- "startSpeakingPlan": {
- "description": "This is the plan for when the assistant should start talking.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to start talking after the customer is done speaking.\n- The assistant is too fast to start talking after the customer is done speaking.\n- The assistant is so fast that it's actually interrupting the customer.",
- "allOf": [
- {
- "$ref": "#/components/schemas/StartSpeakingPlan"
- }
- ]
+ "createdAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
},
- "stopSpeakingPlan": {
- "description": "This is the plan for when assistant should stop talking on customer interruption.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to recognize customer's interruption.\n- The assistant is too fast to recognize customer's interruption.\n- The assistant is getting interrupted by phrases that are just acknowledgments.\n- The assistant is getting interrupted by background noises.\n- The assistant is not properly stopping -- it starts talking right after getting interrupted.",
- "allOf": [
- {
- "$ref": "#/components/schemas/StopSpeakingPlan"
- }
- ]
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
},
- "monitorPlan": {
- "description": "This is the plan for real-time monitoring of the assistant's calls.\n\nUsage:\n- To enable live listening of the assistant's calls, set `monitorPlan.listenEnabled` to `true`.\n- To enable live control of the assistant's calls, set `monitorPlan.controlEnabled` to `true`.\n\nNote, `serverMessages`, `clientMessages`, `serverUrl` and `serverUrlSecret` are currently at the root level but will be moved to `monitorPlan` in the future. Will remain backwards compatible",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/MonitorPlan"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
},
- "credentialIds": {
- "description": "These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server.url\n2. phoneNumber.serverUrl\n3. org.serverUrl",
- "allOf": [
- {
- "$ref": "#/components/schemas/Server"
- }
+ "name": {
+ "type": "string",
+ "description": "The name of the tool, fixed to 'bash'",
+ "default": "bash",
+ "enum": [
+ "bash"
]
- },
- "hooks": {
- "description": "This is a set of actions that will be performed on certain events.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AssistantHooks"
- }
- },
- "keypadInputPlan": {
- "$ref": "#/components/schemas/KeypadInputPlan"
}
- }
+ },
+ "required": [
+ "type",
+ "subType",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt",
+ "name"
+ ]
},
- "ByoPhoneNumber": {
+ "ComputerTool": {
"type": "object",
"properties": {
- "fallbackDestination": {
- "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransferDestinationNumber",
- "title": "NumberTransferDestination"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationSip",
- "title": "SipTransferDestination"
- }
- ]
- },
- "hooks": {
+ "messages": {
"type": "array",
- "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
- "title": "PhoneNumberHookCallRinging"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "provider": {
+ "type": {
"type": "string",
- "description": "This is to bring your own phone numbers from your own SIP trunks or Carriers.",
"enum": [
- "byo-phone-number"
- ]
+ "computer"
+ ],
+ "description": "The type of tool. \"computer\" for Computer tool."
},
- "numberE164CheckEnabled": {
- "type": "boolean",
- "description": "This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)",
- "default": true
+ "subType": {
+ "type": "string",
+ "enum": [
+ "computer_20241022"
+ ],
+ "description": "The sub type of tool."
+ },
+ "server": {
+ "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
},
"id": {
"type": "string",
- "description": "This is the unique identifier for the phone number."
+ "description": "This is the unique identifier for the tool."
},
"orgId": {
"type": "string",
- "description": "This is the unique identifier for the org that this phone number belongs to."
+ "description": "This is the unique identifier for the organization that this tool belongs to."
},
"createdAt": {
"format": "date-time",
"type": "string",
- "description": "This is the ISO 8601 date-time string of when the phone number was created."
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
},
"updatedAt": {
"format": "date-time",
"type": "string",
- "description": "This is the ISO 8601 date-time string of when the phone number was last updated."
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
},
- "status": {
- "type": "string",
- "description": "This is the status of the phone number.",
- "enum": [
- "active",
- "activating",
- "blocked"
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
]
},
"name": {
"type": "string",
- "description": "This is the name of the phone number. This is just for your own reference.",
- "maxLength": 40
+ "description": "The name of the tool, fixed to 'computer'",
+ "default": "computer",
+ "enum": [
+ "computer"
+ ]
},
- "assistantId": {
+ "displayWidthPx": {
+ "type": "number",
+ "description": "The display width in pixels"
+ },
+ "displayHeightPx": {
+ "type": "number",
+ "description": "The display height in pixels"
+ },
+ "displayNumber": {
+ "type": "number",
+ "description": "Optional display number"
+ }
+ },
+ "required": [
+ "type",
+ "subType",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt",
+ "name",
+ "displayWidthPx",
+ "displayHeightPx"
+ ]
+ },
+ "TextEditorTool": {
+ "type": "object",
+ "properties": {
+ "messages": {
+ "type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
+ }
+ },
+ "type": {
"type": "string",
- "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "enum": [
+ "textEditor"
+ ],
+ "description": "The type of tool. \"textEditor\" for Text Editor tool."
},
- "squadId": {
+ "subType": {
"type": "string",
- "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "enum": [
+ "text_editor_20241022"
+ ],
+ "description": "The sub type of tool."
},
"server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.",
"allOf": [
{
"$ref": "#/components/schemas/Server"
}
]
},
- "number": {
+ "id": {
"type": "string",
- "description": "This is the number of the customer.",
- "minLength": 3,
- "maxLength": 40
+ "description": "This is the unique identifier for the tool."
},
- "credentialId": {
+ "orgId": {
"type": "string",
- "description": "This is the credential of your own SIP trunk or Carrier (type `byo-sip-trunk`) which can be used to make calls to this phone number.\n\nYou can add the SIP trunk or Carrier credential in the Provider Credentials page on the Dashboard to get the credentialId."
+ "description": "This is the unique identifier for the organization that this tool belongs to."
+ },
+ "createdAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
+ },
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the tool, fixed to 'str_replace_editor'",
+ "default": "str_replace_editor",
+ "enum": [
+ "str_replace_editor"
+ ]
}
},
"required": [
- "provider",
+ "type",
+ "subType",
"id",
"orgId",
"createdAt",
"updatedAt",
- "credentialId"
+ "name"
]
},
- "TwilioPhoneNumber": {
+ "QueryTool": {
"type": "object",
"properties": {
- "fallbackDestination": {
- "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransferDestinationNumber",
- "title": "NumberTransferDestination"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationSip",
- "title": "SipTransferDestination"
- }
- ]
- },
- "hooks": {
+ "messages": {
"type": "array",
- "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
- "title": "PhoneNumberHookCallRinging"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "provider": {
+ "type": {
"type": "string",
- "description": "This is to use numbers bought on Twilio.",
"enum": [
- "twilio"
- ]
+ "query"
+ ],
+ "description": "The type of tool. \"query\" for Query tool."
+ },
+ "knowledgeBases": {
+ "description": "The knowledge bases to query",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/KnowledgeBase"
+ }
},
"id": {
"type": "string",
- "description": "This is the unique identifier for the phone number."
+ "description": "This is the unique identifier for the tool."
},
"orgId": {
"type": "string",
- "description": "This is the unique identifier for the org that this phone number belongs to."
+ "description": "This is the unique identifier for the organization that this tool belongs to."
},
"createdAt": {
"format": "date-time",
"type": "string",
- "description": "This is the ISO 8601 date-time string of when the phone number was created."
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
},
"updatedAt": {
"format": "date-time",
"type": "string",
- "description": "This is the ISO 8601 date-time string of when the phone number was last updated."
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
},
- "status": {
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt"
+ ]
+ },
+ "GoogleCalendarCreateEventTool": {
+ "type": "object",
+ "properties": {
+ "messages": {
+ "type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
+ }
+ },
+ "type": {
"type": "string",
- "description": "This is the status of the phone number.",
"enum": [
- "active",
- "activating",
- "blocked"
- ]
+ "google.calendar.event.create"
+ ],
+ "description": "The type of tool. \"google.calendar.event.create\" for Google Calendar tool."
},
- "name": {
+ "id": {
"type": "string",
- "description": "This is the name of the phone number. This is just for your own reference.",
- "maxLength": 40
+ "description": "This is the unique identifier for the tool."
},
- "assistantId": {
+ "orgId": {
"type": "string",
- "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "description": "This is the unique identifier for the organization that this tool belongs to."
},
- "squadId": {
+ "createdAt": {
+ "format": "date-time",
"type": "string",
- "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
},
- "server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
- },
- "number": {
- "type": "string",
- "description": "These are the digits of the phone number you own on your Twilio."
- },
- "twilioAccountSid": {
- "type": "string",
- "description": "This is the Twilio Account SID for the phone number."
- },
- "twilioAuthToken": {
- "type": "string",
- "description": "This is the Twilio Auth Token for the phone number."
}
},
"required": [
- "provider",
+ "type",
"id",
"orgId",
"createdAt",
- "updatedAt",
- "number",
- "twilioAccountSid",
- "twilioAuthToken"
+ "updatedAt"
]
},
- "VonagePhoneNumber": {
+ "GoogleSheetsRowAppendTool": {
"type": "object",
"properties": {
- "fallbackDestination": {
- "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransferDestinationNumber",
- "title": "NumberTransferDestination"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationSip",
- "title": "SipTransferDestination"
- }
- ]
- },
- "hooks": {
+ "messages": {
"type": "array",
- "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
- "title": "PhoneNumberHookCallRinging"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "provider": {
+ "type": {
"type": "string",
- "description": "This is to use numbers bought on Vonage.",
"enum": [
- "vonage"
- ]
+ "google.sheets.row.append"
+ ],
+ "description": "The type of tool. \"google.sheets.row.append\" for Google Sheets tool."
},
"id": {
"type": "string",
- "description": "This is the unique identifier for the phone number."
+ "description": "This is the unique identifier for the tool."
},
"orgId": {
"type": "string",
- "description": "This is the unique identifier for the org that this phone number belongs to."
+ "description": "This is the unique identifier for the organization that this tool belongs to."
},
"createdAt": {
"format": "date-time",
"type": "string",
- "description": "This is the ISO 8601 date-time string of when the phone number was created."
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
},
"updatedAt": {
"format": "date-time",
"type": "string",
- "description": "This is the ISO 8601 date-time string of when the phone number was last updated."
- },
- "status": {
- "type": "string",
- "description": "This is the status of the phone number.",
- "enum": [
- "active",
- "activating",
- "blocked"
- ]
- },
- "name": {
- "type": "string",
- "description": "This is the name of the phone number. This is just for your own reference.",
- "maxLength": 40
- },
- "assistantId": {
- "type": "string",
- "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
- },
- "squadId": {
- "type": "string",
- "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
},
- "server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
- },
- "number": {
- "type": "string",
- "description": "These are the digits of the phone number you own on your Vonage."
- },
- "credentialId": {
- "type": "string",
- "description": "This is the credential you added in dashboard.vapi.ai/keys. This is used to configure the number to send inbound calls to Vapi, make outbound calls and do live call updates like transfers and hangups."
}
},
"required": [
- "provider",
+ "type",
"id",
"orgId",
"createdAt",
- "updatedAt",
- "number",
- "credentialId"
- ]
- },
- "SipAuthentication": {
- "type": "object",
- "properties": {
- "realm": {
- "type": "string",
- "description": "This will be expected in the `realm` field of the `authorization` header of the SIP INVITE. Defaults to sip.vapi.ai."
- },
- "username": {
- "type": "string",
- "description": "This will be expected in the `username` field of the `authorization` header of the SIP INVITE.",
- "minLength": 20,
- "maxLength": 40
- },
- "password": {
- "type": "string",
- "description": "This will be expected to generate the `response` field of the `authorization` header of the SIP INVITE, through digest authentication.",
- "minLength": 20,
- "maxLength": 40
- }
- },
- "required": [
- "username",
- "password"
+ "updatedAt"
]
},
- "VapiPhoneNumber": {
+ "GoogleCalendarCheckAvailabilityTool": {
"type": "object",
"properties": {
- "fallbackDestination": {
- "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransferDestinationNumber",
- "title": "NumberTransferDestination"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationSip",
- "title": "SipTransferDestination"
- }
- ]
- },
- "hooks": {
+ "messages": {
"type": "array",
- "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
- "title": "PhoneNumberHookCallRinging"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "provider": {
+ "type": {
"type": "string",
- "description": "This is to create free SIP phone numbers on Vapi.",
"enum": [
- "vapi"
- ]
+ "google.calendar.availability.check"
+ ],
+ "description": "The type of tool. \"google.calendar.availability.check\" for Google Calendar availability check tool."
},
"id": {
"type": "string",
- "description": "This is the unique identifier for the phone number."
+ "description": "This is the unique identifier for the tool."
},
"orgId": {
"type": "string",
- "description": "This is the unique identifier for the org that this phone number belongs to."
+ "description": "This is the unique identifier for the organization that this tool belongs to."
},
"createdAt": {
"format": "date-time",
"type": "string",
- "description": "This is the ISO 8601 date-time string of when the phone number was created."
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
},
"updatedAt": {
"format": "date-time",
"type": "string",
- "description": "This is the ISO 8601 date-time string of when the phone number was last updated."
- },
- "status": {
- "type": "string",
- "description": "This is the status of the phone number.",
- "enum": [
- "active",
- "activating",
- "blocked"
- ]
- },
- "number": {
- "type": "string",
- "description": "These are the digits of the phone number you purchased from Vapi."
- },
- "name": {
- "type": "string",
- "description": "This is the name of the phone number. This is just for your own reference.",
- "maxLength": 40
- },
- "assistantId": {
- "type": "string",
- "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
- },
- "squadId": {
- "type": "string",
- "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
- },
- "server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
- "allOf": [
- {
- "$ref": "#/components/schemas/Server"
- }
- ]
- },
- "numberDesiredAreaCode": {
- "type": "string",
- "description": "This is the area code of the phone number to purchase.",
- "minLength": 3,
- "maxLength": 3
- },
- "sipUri": {
- "type": "string",
- "description": "This is the SIP URI of the phone number. You can SIP INVITE this. The assistant attached to this number will answer.\n\nThis is case-insensitive."
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
},
- "authentication": {
- "description": "This enables authentication for incoming SIP INVITE requests to the `sipUri`.\n\nIf not set, any username/password to the 401 challenge of the SIP INVITE will be accepted.",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/SipAuthentication"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
}
},
"required": [
- "provider",
+ "type",
"id",
"orgId",
"createdAt",
"updatedAt"
]
},
- "TelnyxPhoneNumber": {
+ "SlackSendMessageTool": {
"type": "object",
"properties": {
- "fallbackDestination": {
- "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransferDestinationNumber",
- "title": "NumberTransferDestination"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationSip",
- "title": "SipTransferDestination"
- }
- ]
- },
- "hooks": {
+ "messages": {
"type": "array",
- "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
- "title": "PhoneNumberHookCallRinging"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "provider": {
+ "type": {
"type": "string",
- "description": "This is to use numbers bought on Telnyx.",
"enum": [
- "telnyx"
- ]
+ "slack.message.send"
+ ],
+ "description": "The type of tool. \"slack.message.send\" for Slack send message tool."
},
"id": {
"type": "string",
- "description": "This is the unique identifier for the phone number."
+ "description": "This is the unique identifier for the tool."
},
"orgId": {
"type": "string",
- "description": "This is the unique identifier for the org that this phone number belongs to."
+ "description": "This is the unique identifier for the organization that this tool belongs to."
},
"createdAt": {
"format": "date-time",
"type": "string",
- "description": "This is the ISO 8601 date-time string of when the phone number was created."
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
},
"updatedAt": {
"format": "date-time",
"type": "string",
- "description": "This is the ISO 8601 date-time string of when the phone number was last updated."
- },
- "status": {
- "type": "string",
- "description": "This is the status of the phone number.",
- "enum": [
- "active",
- "activating",
- "blocked"
- ]
- },
- "name": {
- "type": "string",
- "description": "This is the name of the phone number. This is just for your own reference.",
- "maxLength": 40
- },
- "assistantId": {
- "type": "string",
- "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
- },
- "squadId": {
- "type": "string",
- "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
},
- "server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
- },
- "number": {
- "type": "string",
- "description": "These are the digits of the phone number you own on your Telnyx."
- },
- "credentialId": {
- "type": "string",
- "description": "This is the credential you added in dashboard.vapi.ai/keys. This is used to configure the number to send inbound calls to Vapi, make outbound calls and do live call updates like transfers and hangups."
}
},
"required": [
- "provider",
+ "type",
"id",
"orgId",
"createdAt",
- "updatedAt",
- "number",
- "credentialId"
+ "updatedAt"
]
},
- "CreateByoPhoneNumberDTO": {
+ "SmsTool": {
"type": "object",
"properties": {
- "fallbackDestination": {
- "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransferDestinationNumber",
- "title": "NumberTransferDestination"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationSip",
- "title": "SipTransferDestination"
- }
- ]
- },
- "hooks": {
+ "messages": {
"type": "array",
- "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
- "title": "PhoneNumberHookCallRinging"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "provider": {
+ "type": {
"type": "string",
- "description": "This is to bring your own phone numbers from your own SIP trunks or Carriers.",
"enum": [
- "byo-phone-number"
- ]
- },
- "numberE164CheckEnabled": {
- "type": "boolean",
- "description": "This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)",
- "default": true
- },
- "number": {
- "type": "string",
- "description": "This is the number of the customer.",
- "minLength": 3,
- "maxLength": 40
+ "sms"
+ ],
+ "description": "The type of tool. \"sms\" for Twilio SMS sending tool."
},
- "credentialId": {
+ "id": {
"type": "string",
- "description": "This is the credential of your own SIP trunk or Carrier (type `byo-sip-trunk`) which can be used to make calls to this phone number.\n\nYou can add the SIP trunk or Carrier credential in the Provider Credentials page on the Dashboard to get the credentialId."
+ "description": "This is the unique identifier for the tool."
},
- "name": {
+ "orgId": {
"type": "string",
- "description": "This is the name of the phone number. This is just for your own reference.",
- "maxLength": 40
+ "description": "This is the unique identifier for the organization that this tool belongs to."
},
- "assistantId": {
+ "createdAt": {
+ "format": "date-time",
"type": "string",
- "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
},
- "squadId": {
+ "updatedAt": {
+ "format": "date-time",
"type": "string",
- "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
},
- "server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
}
},
"required": [
- "provider",
- "credentialId"
+ "type",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt"
]
},
- "CreateTwilioPhoneNumberDTO": {
+ "McpTool": {
"type": "object",
"properties": {
- "fallbackDestination": {
- "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransferDestinationNumber",
- "title": "NumberTransferDestination"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationSip",
- "title": "SipTransferDestination"
- }
- ]
- },
- "hooks": {
+ "messages": {
"type": "array",
- "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
- "title": "PhoneNumberHookCallRinging"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "provider": {
+ "type": {
"type": "string",
- "description": "This is to use numbers bought on Twilio.",
"enum": [
- "twilio"
- ]
- },
- "number": {
- "type": "string",
- "description": "These are the digits of the phone number you own on your Twilio."
+ "mcp"
+ ],
+ "description": "The type of tool. \"mcp\" for MCP tool."
},
- "twilioAccountSid": {
- "type": "string",
- "description": "This is the Twilio Account SID for the phone number."
+ "server": {
+ "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
},
- "twilioAuthToken": {
+ "id": {
"type": "string",
- "description": "This is the Twilio Auth Token for the phone number."
+ "description": "This is the unique identifier for the tool."
},
- "name": {
+ "orgId": {
"type": "string",
- "description": "This is the name of the phone number. This is just for your own reference.",
- "maxLength": 40
+ "description": "This is the unique identifier for the organization that this tool belongs to."
},
- "assistantId": {
+ "createdAt": {
+ "format": "date-time",
"type": "string",
- "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
},
- "squadId": {
+ "updatedAt": {
+ "format": "date-time",
"type": "string",
- "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
},
- "server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
+ },
+ "metadata": {
+ "$ref": "#/components/schemas/McpToolMetadata"
}
},
"required": [
- "provider",
- "number",
- "twilioAccountSid",
- "twilioAuthToken"
+ "type",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt"
]
},
- "CreateVonagePhoneNumberDTO": {
+ "GoHighLevelCalendarAvailabilityTool": {
"type": "object",
"properties": {
- "fallbackDestination": {
- "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransferDestinationNumber",
- "title": "NumberTransferDestination"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationSip",
- "title": "SipTransferDestination"
- }
- ]
- },
- "hooks": {
+ "messages": {
"type": "array",
- "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
- "title": "PhoneNumberHookCallRinging"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "provider": {
+ "type": {
"type": "string",
- "description": "This is to use numbers bought on Vonage.",
"enum": [
- "vonage"
- ]
- },
- "number": {
- "type": "string",
- "description": "These are the digits of the phone number you own on your Vonage."
+ "gohighlevel.calendar.availability.check"
+ ],
+ "description": "The type of tool. \"gohighlevel.calendar.availability.check\" for GoHighLevel Calendar availability check tool."
},
- "credentialId": {
+ "id": {
"type": "string",
- "description": "This is the credential you added in dashboard.vapi.ai/keys. This is used to configure the number to send inbound calls to Vapi, make outbound calls and do live call updates like transfers and hangups."
+ "description": "This is the unique identifier for the tool."
},
- "name": {
+ "orgId": {
"type": "string",
- "description": "This is the name of the phone number. This is just for your own reference.",
- "maxLength": 40
+ "description": "This is the unique identifier for the organization that this tool belongs to."
},
- "assistantId": {
+ "createdAt": {
+ "format": "date-time",
"type": "string",
- "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
},
- "squadId": {
+ "updatedAt": {
+ "format": "date-time",
"type": "string",
- "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
},
- "server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
}
},
"required": [
- "provider",
- "number",
- "credentialId"
+ "type",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt"
]
},
- "CreateVapiPhoneNumberDTO": {
+ "GoHighLevelCalendarEventCreateTool": {
"type": "object",
"properties": {
- "fallbackDestination": {
- "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransferDestinationNumber",
- "title": "NumberTransferDestination"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationSip",
- "title": "SipTransferDestination"
- }
- ]
- },
- "hooks": {
+ "messages": {
"type": "array",
- "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
- "title": "PhoneNumberHookCallRinging"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "provider": {
+ "type": {
"type": "string",
- "description": "This is to create free SIP phone numbers on Vapi.",
"enum": [
- "vapi"
- ]
- },
- "numberDesiredAreaCode": {
- "type": "string",
- "description": "This is the area code of the phone number to purchase.",
- "minLength": 3,
- "maxLength": 3
+ "gohighlevel.calendar.event.create"
+ ],
+ "description": "The type of tool. \"gohighlevel.calendar.event.create\" for GoHighLevel Calendar event create tool."
},
- "sipUri": {
+ "id": {
"type": "string",
- "description": "This is the SIP URI of the phone number. You can SIP INVITE this. The assistant attached to this number will answer.\n\nThis is case-insensitive."
- },
- "authentication": {
- "description": "This enables authentication for incoming SIP INVITE requests to the `sipUri`.\n\nIf not set, any username/password to the 401 challenge of the SIP INVITE will be accepted.",
- "allOf": [
- {
- "$ref": "#/components/schemas/SipAuthentication"
- }
- ]
+ "description": "This is the unique identifier for the tool."
},
- "name": {
+ "orgId": {
"type": "string",
- "description": "This is the name of the phone number. This is just for your own reference.",
- "maxLength": 40
+ "description": "This is the unique identifier for the organization that this tool belongs to."
},
- "assistantId": {
+ "createdAt": {
+ "format": "date-time",
"type": "string",
- "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
},
- "squadId": {
+ "updatedAt": {
+ "format": "date-time",
"type": "string",
- "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
},
- "server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
}
},
"required": [
- "provider"
+ "type",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt"
]
},
- "CreateTelnyxPhoneNumberDTO": {
+ "GoHighLevelContactCreateTool": {
"type": "object",
"properties": {
- "fallbackDestination": {
- "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransferDestinationNumber",
- "title": "NumberTransferDestination"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationSip",
- "title": "SipTransferDestination"
- }
- ]
- },
- "hooks": {
+ "messages": {
"type": "array",
- "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
- "title": "PhoneNumberHookCallRinging"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "provider": {
+ "type": {
"type": "string",
- "description": "This is to use numbers bought on Telnyx.",
"enum": [
- "telnyx"
- ]
- },
- "number": {
- "type": "string",
- "description": "These are the digits of the phone number you own on your Telnyx."
+ "gohighlevel.contact.create"
+ ],
+ "description": "The type of tool. \"gohighlevel.contact.create\" for GoHighLevel contact create tool."
},
- "credentialId": {
+ "id": {
"type": "string",
- "description": "This is the credential you added in dashboard.vapi.ai/keys. This is used to configure the number to send inbound calls to Vapi, make outbound calls and do live call updates like transfers and hangups."
+ "description": "This is the unique identifier for the tool."
},
- "name": {
+ "orgId": {
"type": "string",
- "description": "This is the name of the phone number. This is just for your own reference.",
- "maxLength": 40
+ "description": "This is the unique identifier for the organization that this tool belongs to."
},
- "assistantId": {
+ "createdAt": {
+ "format": "date-time",
"type": "string",
- "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
},
- "squadId": {
+ "updatedAt": {
+ "format": "date-time",
"type": "string",
- "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
},
- "server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
}
},
"required": [
- "provider",
- "number",
- "credentialId"
+ "type",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt"
]
},
- "UpdateByoPhoneNumberDTO": {
+ "GoHighLevelContactGetTool": {
"type": "object",
"properties": {
- "fallbackDestination": {
- "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransferDestinationNumber",
- "title": "NumberTransferDestination"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationSip",
- "title": "SipTransferDestination"
- }
- ]
- },
- "hooks": {
+ "messages": {
"type": "array",
- "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
- "title": "PhoneNumberHookCallRinging"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "numberE164CheckEnabled": {
- "type": "boolean",
- "description": "This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)",
- "default": true
+ "type": {
+ "type": "string",
+ "enum": [
+ "gohighlevel.contact.get"
+ ],
+ "description": "The type of tool. \"gohighlevel.contact.get\" for GoHighLevel contact get tool."
},
- "name": {
+ "id": {
"type": "string",
- "description": "This is the name of the phone number. This is just for your own reference.",
- "maxLength": 40
+ "description": "This is the unique identifier for the tool."
},
- "assistantId": {
+ "orgId": {
"type": "string",
- "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "description": "This is the unique identifier for the organization that this tool belongs to."
},
- "squadId": {
+ "createdAt": {
+ "format": "date-time",
"type": "string",
- "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "description": "This is the ISO 8601 date-time string of when the tool was created."
},
- "server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the tool was last updated."
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
- },
- "number": {
- "type": "string",
- "description": "This is the number of the customer.",
- "minLength": 3,
- "maxLength": 40
- },
- "credentialId": {
- "type": "string",
- "description": "This is the credential of your own SIP trunk or Carrier (type `byo-sip-trunk`) which can be used to make calls to this phone number.\n\nYou can add the SIP trunk or Carrier credential in the Provider Credentials page on the Dashboard to get the credentialId."
}
- }
+ },
+ "required": [
+ "type",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt"
+ ]
},
- "UpdateTwilioPhoneNumberDTO": {
+ "CreateApiRequestToolDTO": {
"type": "object",
"properties": {
- "fallbackDestination": {
- "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransferDestinationNumber",
- "title": "NumberTransferDestination"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationSip",
- "title": "SipTransferDestination"
- }
- ]
- },
- "hooks": {
+ "messages": {
"type": "array",
- "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
- "title": "PhoneNumberHookCallRinging"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
+ "type": {
+ "type": "string",
+ "enum": [
+ "apiRequest"
+ ],
+ "description": "The type of tool. \"apiRequest\" for API request tool."
+ },
+ "method": {
+ "type": "string",
+ "enum": [
+ "POST",
+ "GET"
+ ]
+ },
+ "timeoutSeconds": {
+ "type": "number",
+ "description": "This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20",
+ "minimum": 1,
+ "maximum": 300,
+ "example": 20
+ },
"name": {
"type": "string",
- "description": "This is the name of the phone number. This is just for your own reference.",
- "maxLength": 40
+ "description": "This is the name of the tool. This will be passed to the model.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.",
+ "maxLength": 40,
+ "pattern": "/^[a-zA-Z0-9_-]{1,40}$/"
},
- "assistantId": {
+ "description": {
"type": "string",
- "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "description": "This is the description of the tool. This will be passed to the model.",
+ "maxLength": 1000
},
- "squadId": {
+ "url": {
"type": "string",
- "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "description": "This is where the request will be sent."
},
- "server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "body": {
+ "description": "This is the body of the request.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/JsonSchema"
}
]
},
- "number": {
- "type": "string",
- "description": "These are the digits of the phone number you own on your Twilio."
- },
- "twilioAccountSid": {
- "type": "string",
- "description": "This is the Twilio Account SID for the phone number."
+ "headers": {
+ "description": "These are the headers to send in the request.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/JsonSchema"
+ }
+ ]
},
- "twilioAuthToken": {
- "type": "string",
- "description": "This is the Twilio Auth Token for the phone number."
- }
- }
- },
- "UpdateVonagePhoneNumberDTO": {
- "type": "object",
- "properties": {
- "fallbackDestination": {
- "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
- "oneOf": [
+ "backoffPlan": {
+ "description": "This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)",
+ "allOf": [
{
- "$ref": "#/components/schemas/TransferDestinationNumber",
- "title": "NumberTransferDestination"
- },
+ "$ref": "#/components/schemas/BackoffPlan"
+ }
+ ]
+ },
+ "variableExtractionPlan": {
+ "description": "This is the plan that controls the variable extraction from the tool's response.",
+ "allOf": [
{
- "$ref": "#/components/schemas/TransferDestinationSip",
- "title": "SipTransferDestination"
+ "$ref": "#/components/schemas/VariableExtractionPlan"
}
]
},
- "hooks": {
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "method",
+ "url"
+ ]
+ },
+ "CreateOutputToolDTO": {
+ "type": "object",
+ "properties": {
+ "messages": {
"type": "array",
- "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
- "title": "PhoneNumberHookCallRinging"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "name": {
- "type": "string",
- "description": "This is the name of the phone number. This is just for your own reference.",
- "maxLength": 40
- },
- "assistantId": {
- "type": "string",
- "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
- },
- "squadId": {
+ "type": {
"type": "string",
- "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "enum": [
+ "output"
+ ],
+ "description": "The type of tool. \"output\" for Output tool."
},
- "server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
- },
- "number": {
- "type": "string",
- "description": "These are the digits of the phone number you own on your Vonage."
- },
- "credentialId": {
- "type": "string",
- "description": "This is the credential you added in dashboard.vapi.ai/keys. This is used to configure the number to send inbound calls to Vapi, make outbound calls and do live call updates like transfers and hangups."
}
- }
+ },
+ "required": [
+ "type"
+ ]
},
- "UpdateVapiPhoneNumberDTO": {
+ "CreateBashToolDTO": {
"type": "object",
"properties": {
- "fallbackDestination": {
- "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransferDestinationNumber",
- "title": "NumberTransferDestination"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationSip",
- "title": "SipTransferDestination"
- }
- ]
- },
- "hooks": {
+ "messages": {
"type": "array",
- "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
- "title": "PhoneNumberHookCallRinging"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "name": {
- "type": "string",
- "description": "This is the name of the phone number. This is just for your own reference.",
- "maxLength": 40
- },
- "assistantId": {
+ "type": {
"type": "string",
- "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "enum": [
+ "bash"
+ ],
+ "description": "The type of tool. \"bash\" for Bash tool."
},
- "squadId": {
+ "subType": {
"type": "string",
- "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "enum": [
+ "bash_20241022"
+ ],
+ "description": "The sub type of tool."
},
"server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.",
"allOf": [
{
"$ref": "#/components/schemas/Server"
}
]
},
- "sipUri": {
+ "name": {
"type": "string",
- "description": "This is the SIP URI of the phone number. You can SIP INVITE this. The assistant attached to this number will answer.\n\nThis is case-insensitive."
+ "description": "The name of the tool, fixed to 'bash'",
+ "default": "bash",
+ "enum": [
+ "bash"
+ ]
},
- "authentication": {
- "description": "This enables authentication for incoming SIP INVITE requests to the `sipUri`.\n\nIf not set, any username/password to the 401 challenge of the SIP INVITE will be accepted.",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/SipAuthentication"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
}
- }
+ },
+ "required": [
+ "type",
+ "subType",
+ "name"
+ ]
},
- "UpdateTelnyxPhoneNumberDTO": {
+ "CreateComputerToolDTO": {
"type": "object",
"properties": {
- "fallbackDestination": {
- "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransferDestinationNumber",
- "title": "NumberTransferDestination"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationSip",
- "title": "SipTransferDestination"
- }
- ]
- },
- "hooks": {
+ "messages": {
"type": "array",
- "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
- "title": "PhoneNumberHookCallRinging"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "name": {
- "type": "string",
- "description": "This is the name of the phone number. This is just for your own reference.",
- "maxLength": 40
- },
- "assistantId": {
+ "type": {
"type": "string",
- "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "enum": [
+ "computer"
+ ],
+ "description": "The type of tool. \"computer\" for Computer tool."
},
- "squadId": {
+ "subType": {
"type": "string",
- "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "enum": [
+ "computer_20241022"
+ ],
+ "description": "The sub type of tool."
},
"server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.",
"allOf": [
{
"$ref": "#/components/schemas/Server"
}
]
},
- "number": {
+ "name": {
"type": "string",
- "description": "These are the digits of the phone number you own on your Telnyx."
+ "description": "The name of the tool, fixed to 'computer'",
+ "default": "computer",
+ "enum": [
+ "computer"
+ ]
},
- "credentialId": {
- "type": "string",
- "description": "This is the credential you added in dashboard.vapi.ai/keys. This is used to configure the number to send inbound calls to Vapi, make outbound calls and do live call updates like transfers and hangups."
+ "displayWidthPx": {
+ "type": "number",
+ "description": "The display width in pixels"
+ },
+ "displayHeightPx": {
+ "type": "number",
+ "description": "The display height in pixels"
+ },
+ "displayNumber": {
+ "type": "number",
+ "description": "Optional display number"
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
}
- }
+ },
+ "required": [
+ "type",
+ "subType",
+ "name",
+ "displayWidthPx",
+ "displayHeightPx"
+ ]
},
- "ImportVonagePhoneNumberDTO": {
+ "CreateTextEditorToolDTO": {
"type": "object",
"properties": {
- "fallbackDestination": {
- "description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransferDestinationNumber",
- "title": "NumberTransferDestination"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationSip",
- "title": "SipTransferDestination"
- }
- ]
- },
- "hooks": {
+ "messages": {
"type": "array",
- "description": "This is the hooks that will be used for incoming calls to this phone number.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/PhoneNumberHookCallRinging",
- "title": "PhoneNumberHookCallRinging"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "vonagePhoneNumber": {
- "type": "string",
- "description": "These are the digits of the phone number you own on your Vonage.",
- "deprecated": true
- },
- "credentialId": {
+ "type": {
"type": "string",
- "description": "This is the credential you added in dashboard.vapi.ai/keys. This is used to configure the number to send inbound calls to Vapi, make outbound calls and do live call updates like transfers and hangups."
+ "enum": [
+ "textEditor"
+ ],
+ "description": "The type of tool. \"textEditor\" for Text Editor tool."
},
- "name": {
+ "subType": {
"type": "string",
- "description": "This is the name of the phone number. This is just for your own reference.",
- "maxLength": 40
+ "enum": [
+ "text_editor_20241022"
+ ],
+ "description": "The sub type of tool."
},
- "assistantId": {
- "type": "string",
- "description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "server": {
+ "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
},
- "squadId": {
+ "name": {
"type": "string",
- "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
+ "description": "The name of the tool, fixed to 'str_replace_editor'",
+ "default": "str_replace_editor",
+ "enum": [
+ "str_replace_editor"
+ ]
},
- "server": {
- "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
}
},
"required": [
- "vonagePhoneNumber",
- "credentialId"
+ "type",
+ "subType",
+ "name"
]
},
- "PhoneNumberPaginatedResponse": {
+ "CreateSmsToolDTO": {
"type": "object",
"properties": {
- "results": {
+ "messages": {
"type": "array",
- "description": "A list of phone numbers, which can be of any provider type.",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/ByoPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/TwilioPhoneNumber"
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
},
{
- "$ref": "#/components/schemas/VonagePhoneNumber"
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
},
{
- "$ref": "#/components/schemas/VapiPhoneNumber"
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
},
{
- "$ref": "#/components/schemas/TelnyxPhoneNumber"
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
}
]
}
},
- "metadata": {
- "description": "Metadata about the pagination.",
+ "type": {
+ "type": "string",
+ "enum": [
+ "sms"
+ ],
+ "description": "The type of tool. \"sms\" for Twilio SMS sending tool."
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/PaginationMeta"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
}
},
"required": [
- "results",
- "metadata"
+ "type"
]
},
- "DtmfTool": {
+ "UpdateApiRequestToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -22608,64 +32058,80 @@
]
}
},
- "type": {
+ "method": {
"type": "string",
"enum": [
- "dtmf"
- ],
- "description": "The type of tool. \"dtmf\" for DTMF tool."
+ "POST",
+ "GET"
+ ]
},
- "id": {
- "type": "string",
- "description": "This is the unique identifier for the tool."
+ "timeoutSeconds": {
+ "type": "number",
+ "description": "This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20",
+ "minimum": 1,
+ "maximum": 300,
+ "example": 20
},
- "orgId": {
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
+ },
+ "name": {
"type": "string",
- "description": "This is the unique identifier for the organization that this tool belongs to."
+ "description": "This is the name of the tool. This will be passed to the model.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.",
+ "maxLength": 40,
+ "pattern": "/^[a-zA-Z0-9_-]{1,40}$/"
},
- "createdAt": {
- "format": "date-time",
+ "description": {
"type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was created."
+ "description": "This is the description of the tool. This will be passed to the model.",
+ "maxLength": 1000
},
- "updatedAt": {
- "format": "date-time",
+ "url": {
"type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was last updated."
+ "description": "This is where the request will be sent."
},
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "body": {
+ "description": "This is the body of the request.",
"allOf": [
{
- "$ref": "#/components/schemas/OpenAIFunction"
+ "$ref": "#/components/schemas/JsonSchema"
}
]
},
- "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.",
+ "headers": {
+ "description": "These are the headers to send in the request.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/JsonSchema"
+ }
+ ]
+ },
+ "backoffPlan": {
+ "description": "This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).\n\n@default undefined (the request will not be retried)",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BackoffPlan"
+ }
+ ]
+ },
+ "variableExtractionPlan": {
+ "description": "This is the plan that controls the variable extraction from the tool's response.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/VariableExtractionPlan"
}
]
}
- },
- "required": [
- "type",
- "id",
- "orgId",
- "createdAt",
- "updatedAt"
- ]
+ }
},
- "EndCallTool": {
+ "UpdateDtmfToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -22690,31 +32156,6 @@
]
}
},
- "type": {
- "type": "string",
- "enum": [
- "endCall"
- ],
- "description": "The type of tool. \"endCall\" for End Call tool."
- },
- "id": {
- "type": "string",
- "description": "This is the unique identifier for the tool."
- },
- "orgId": {
- "type": "string",
- "description": "This is the unique identifier for the organization that this tool belongs to."
- },
- "createdAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was created."
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was last updated."
- },
"function": {
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
@@ -22722,32 +32163,49 @@
"$ref": "#/components/schemas/OpenAIFunction"
}
]
+ }
+ }
+ },
+ "UpdateEndCallToolDTO": {
+ "type": "object",
+ "properties": {
+ "messages": {
+ "type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
+ }
},
- "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.",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
}
- },
- "required": [
- "type",
- "id",
- "orgId",
- "createdAt",
- "updatedAt"
- ]
+ }
},
- "FunctionTool": {
+ "UpdateFunctionToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -22772,64 +32230,32 @@
]
}
},
- "type": {
- "type": "string",
- "enum": [
- "function"
- ],
- "description": "The type of tool. \"function\" for Function tool."
- },
- "id": {
- "type": "string",
- "description": "This is the unique identifier for the tool."
- },
- "orgId": {
- "type": "string",
- "description": "This is the unique identifier for the organization that this tool belongs to."
- },
- "createdAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was created."
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was last updated."
+ "async": {
+ "type": "boolean",
+ "example": false,
+ "description": "This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`)."
},
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "server": {
+ "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.",
"allOf": [
{
- "$ref": "#/components/schemas/OpenAIFunction"
+ "$ref": "#/components/schemas/Server"
}
]
},
- "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.",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
}
- },
- "required": [
- "type",
- "id",
- "orgId",
- "createdAt",
- "updatedAt"
- ]
+ }
},
- "GhlTool": {
+ "UpdateGhlToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -22854,31 +32280,6 @@
]
}
},
- "type": {
- "type": "string",
- "enum": [
- "ghl"
- ],
- "description": "The type of tool. \"ghl\" for GHL tool."
- },
- "id": {
- "type": "string",
- "description": "This is the unique identifier for the tool."
- },
- "orgId": {
- "type": "string",
- "description": "This is the unique identifier for the organization that this tool belongs to."
- },
- "createdAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was created."
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was last updated."
- },
"function": {
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
@@ -22887,35 +32288,14 @@
}
]
},
- "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"
- }
- ]
- },
"metadata": {
"$ref": "#/components/schemas/GhlToolMetadata"
}
- },
- "required": [
- "type",
- "id",
- "orgId",
- "createdAt",
- "updatedAt",
- "metadata"
- ]
+ }
},
- "MakeTool": {
+ "UpdateMakeToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -22934,36 +32314,11 @@
"title": "ToolMessageFailed"
},
{
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "make"
- ],
- "description": "The type of tool. \"make\" for Make tool."
- },
- "id": {
- "type": "string",
- "description": "This is the unique identifier for the tool."
- },
- "orgId": {
- "type": "string",
- "description": "This is the unique identifier for the organization that this tool belongs to."
- },
- "createdAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was created."
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was last updated."
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
+ }
},
"function": {
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
@@ -22973,35 +32328,14 @@
}
]
},
- "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"
- }
- ]
- },
"metadata": {
"$ref": "#/components/schemas/MakeToolMetadata"
}
- },
- "required": [
- "type",
- "id",
- "orgId",
- "createdAt",
- "updatedAt",
- "metadata"
- ]
+ }
},
- "TransferCallTool": {
+ "UpdateTransferCallToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -23026,12 +32360,6 @@
]
}
},
- "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.",
@@ -23041,10 +32369,6 @@
"$ref": "#/components/schemas/TransferDestinationAssistant",
"title": "Assistant"
},
- {
- "$ref": "#/components/schemas/TransferDestinationStep",
- "title": "Step"
- },
{
"$ref": "#/components/schemas/TransferDestinationNumber",
"title": "Number"
@@ -23056,24 +32380,6 @@
]
}
},
- "id": {
- "type": "string",
- "description": "This is the unique identifier for the tool."
- },
- "orgId": {
- "type": "string",
- "description": "This is the unique identifier for the organization that this tool belongs to."
- },
- "createdAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was created."
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was last updated."
- },
"function": {
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
@@ -23081,32 +32387,12 @@
"$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"
- }
- ]
}
- },
- "required": [
- "type",
- "id",
- "orgId",
- "createdAt",
- "updatedAt"
- ]
+ }
},
- "OutputTool": {
+ "UpdateOutputToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -23131,31 +32417,6 @@
]
}
},
- "type": {
- "type": "string",
- "enum": [
- "output"
- ],
- "description": "The type of tool. \"output\" for Output tool."
- },
- "id": {
- "type": "string",
- "description": "This is the unique identifier for the tool."
- },
- "orgId": {
- "type": "string",
- "description": "This is the unique identifier for the organization that this tool belongs to."
- },
- "createdAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was created."
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was last updated."
- },
"function": {
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
@@ -23163,32 +32424,12 @@
"$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"
- }
- ]
}
- },
- "required": [
- "type",
- "id",
- "orgId",
- "createdAt",
- "updatedAt"
- ]
+ }
},
- "BashTool": {
+ "UpdateBashToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -23213,13 +32454,6 @@
]
}
},
- "type": {
- "type": "string",
- "enum": [
- "bash"
- ],
- "description": "The type of tool. \"bash\" for Bash tool."
- },
"subType": {
"type": "string",
"enum": [
@@ -23227,37 +32461,19 @@
],
"description": "The sub type of tool."
},
- "id": {
- "type": "string",
- "description": "This is the unique identifier for the tool."
- },
- "orgId": {
- "type": "string",
- "description": "This is the unique identifier for the organization that this tool belongs to."
- },
- "createdAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was created."
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was last updated."
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "server": {
+ "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.",
"allOf": [
{
- "$ref": "#/components/schemas/OpenAIFunction"
+ "$ref": "#/components/schemas/Server"
}
]
},
- "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.",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
},
@@ -23269,25 +32485,11 @@
"bash"
]
}
- },
- "required": [
- "type",
- "subType",
- "id",
- "orgId",
- "createdAt",
- "updatedAt",
- "name"
- ]
+ }
},
- "ComputerTool": {
+ "UpdateComputerToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -23312,13 +32514,6 @@
]
}
},
- "type": {
- "type": "string",
- "enum": [
- "computer"
- ],
- "description": "The type of tool. \"computer\" for Computer tool."
- },
"subType": {
"type": "string",
"enum": [
@@ -23326,37 +32521,19 @@
],
"description": "The sub type of tool."
},
- "id": {
- "type": "string",
- "description": "This is the unique identifier for the tool."
- },
- "orgId": {
- "type": "string",
- "description": "This is the unique identifier for the organization that this tool belongs to."
- },
- "createdAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was created."
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was last updated."
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "server": {
+ "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.",
"allOf": [
{
- "$ref": "#/components/schemas/OpenAIFunction"
+ "$ref": "#/components/schemas/Server"
}
]
},
- "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.",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
},
@@ -23380,27 +32557,11 @@
"type": "number",
"description": "Optional display number"
}
- },
- "required": [
- "type",
- "subType",
- "id",
- "orgId",
- "createdAt",
- "updatedAt",
- "name",
- "displayWidthPx",
- "displayHeightPx"
- ]
+ }
},
- "TextEditorTool": {
+ "UpdateTextEditorToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -23425,13 +32586,6 @@
]
}
},
- "type": {
- "type": "string",
- "enum": [
- "textEditor"
- ],
- "description": "The type of tool. \"textEditor\" for Text Editor tool."
- },
"subType": {
"type": "string",
"enum": [
@@ -23439,37 +32593,19 @@
],
"description": "The sub type of tool."
},
- "id": {
- "type": "string",
- "description": "This is the unique identifier for the tool."
- },
- "orgId": {
- "type": "string",
- "description": "This is the unique identifier for the organization that this tool belongs to."
- },
- "createdAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was created."
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was last updated."
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "server": {
+ "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.",
"allOf": [
{
- "$ref": "#/components/schemas/OpenAIFunction"
+ "$ref": "#/components/schemas/Server"
}
]
},
- "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.",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
},
@@ -23481,25 +32617,11 @@
"str_replace_editor"
]
}
- },
- "required": [
- "type",
- "subType",
- "id",
- "orgId",
- "createdAt",
- "updatedAt",
- "name"
- ]
+ }
},
- "QueryTool": {
+ "UpdateQueryToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -23524,13 +32646,6 @@
]
}
},
- "type": {
- "type": "string",
- "enum": [
- "query"
- ],
- "description": "The type of tool. \"query\" for Query tool."
- },
"knowledgeBases": {
"description": "The knowledge bases to query",
"type": "array",
@@ -23538,24 +32653,6 @@
"$ref": "#/components/schemas/KnowledgeBase"
}
},
- "id": {
- "type": "string",
- "description": "This is the unique identifier for the tool."
- },
- "orgId": {
- "type": "string",
- "description": "This is the unique identifier for the organization that this tool belongs to."
- },
- "createdAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was created."
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was last updated."
- },
"function": {
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
@@ -23563,32 +32660,12 @@
"$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"
- }
- ]
}
- },
- "required": [
- "type",
- "id",
- "orgId",
- "createdAt",
- "updatedAt"
- ]
+ }
},
- "GoogleCalendarCreateEventTool": {
+ "UpdateGoogleCalendarCreateEventToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -23613,31 +32690,6 @@
]
}
},
- "type": {
- "type": "string",
- "enum": [
- "google.calendar.event.create"
- ],
- "description": "The type of tool. \"google.calendar.event.create\" for Google Calendar tool."
- },
- "id": {
- "type": "string",
- "description": "This is the unique identifier for the tool."
- },
- "orgId": {
- "type": "string",
- "description": "This is the unique identifier for the organization that this tool belongs to."
- },
- "createdAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was created."
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was last updated."
- },
"function": {
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
@@ -23645,32 +32697,12 @@
"$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"
- }
- ]
}
- },
- "required": [
- "type",
- "id",
- "orgId",
- "createdAt",
- "updatedAt"
- ]
+ }
},
- "GoogleSheetsRowAppendTool": {
+ "UpdateGoogleSheetsRowAppendToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -23695,31 +32727,6 @@
]
}
},
- "type": {
- "type": "string",
- "enum": [
- "google.sheets.row.append"
- ],
- "description": "The type of tool. \"google.sheets.row.append\" for Google Sheets tool."
- },
- "id": {
- "type": "string",
- "description": "This is the unique identifier for the tool."
- },
- "orgId": {
- "type": "string",
- "description": "This is the unique identifier for the organization that this tool belongs to."
- },
- "createdAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was created."
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was last updated."
- },
"function": {
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
@@ -23727,32 +32734,12 @@
"$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"
- }
- ]
}
- },
- "required": [
- "type",
- "id",
- "orgId",
- "createdAt",
- "updatedAt"
- ]
+ }
},
- "GoogleCalendarCheckAvailabilityTool": {
+ "UpdateGoogleCalendarCheckAvailabilityToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -23777,31 +32764,6 @@
]
}
},
- "type": {
- "type": "string",
- "enum": [
- "google.calendar.availability.check"
- ],
- "description": "The type of tool. \"google.calendar.availability.check\" for Google Calendar availability check tool."
- },
- "id": {
- "type": "string",
- "description": "This is the unique identifier for the tool."
- },
- "orgId": {
- "type": "string",
- "description": "This is the unique identifier for the organization that this tool belongs to."
- },
- "createdAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was created."
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was last updated."
- },
"function": {
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
@@ -23809,32 +32771,12 @@
"$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"
- }
- ]
}
- },
- "required": [
- "type",
- "id",
- "orgId",
- "createdAt",
- "updatedAt"
- ]
+ }
},
- "SlackSendMessageTool": {
+ "UpdateSlackSendMessageToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -23859,64 +32801,19 @@
]
}
},
- "type": {
- "type": "string",
- "enum": [
- "slack.message.send"
- ],
- "description": "The type of tool. \"slack.message.send\" for Slack send message tool."
- },
- "id": {
- "type": "string",
- "description": "This is the unique identifier for the tool."
- },
- "orgId": {
- "type": "string",
- "description": "This is the unique identifier for the organization that this tool belongs to."
- },
- "createdAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was created."
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was last updated."
- },
"function": {
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"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"
- }
- ]
- }
- },
- "required": [
- "type",
- "id",
- "orgId",
- "createdAt",
- "updatedAt"
- ]
+ }
+ ]
+ }
+ }
},
- "SmsSendTool": {
+ "UpdateSmsToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -23941,31 +32838,6 @@
]
}
},
- "type": {
- "type": "string",
- "enum": [
- "sms"
- ],
- "description": "The type of tool. \"sms\" for Twilio SMS sending tool."
- },
- "id": {
- "type": "string",
- "description": "This is the unique identifier for the tool."
- },
- "orgId": {
- "type": "string",
- "description": "This is the unique identifier for the organization that this tool belongs to."
- },
- "createdAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was created."
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was last updated."
- },
"function": {
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
@@ -23973,32 +32845,12 @@
"$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"
- }
- ]
}
- },
- "required": [
- "type",
- "id",
- "orgId",
- "createdAt",
- "updatedAt"
- ]
+ }
},
- "McpTool": {
+ "UpdateMcpToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -24023,64 +32875,30 @@
]
}
},
- "type": {
- "type": "string",
- "enum": [
- "mcp"
- ],
- "description": "The type of tool. \"mcp\" for MCP tool."
- },
- "id": {
- "type": "string",
- "description": "This is the unique identifier for the tool."
- },
- "orgId": {
- "type": "string",
- "description": "This is the unique identifier for the organization that this tool belongs to."
- },
- "createdAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was created."
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the tool was last updated."
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "server": {
+ "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.",
"allOf": [
{
- "$ref": "#/components/schemas/OpenAIFunction"
+ "$ref": "#/components/schemas/Server"
}
]
},
- "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.",
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
+ },
+ "metadata": {
+ "$ref": "#/components/schemas/McpToolMetadata"
}
- },
- "required": [
- "type",
- "id",
- "orgId",
- "createdAt",
- "updatedAt"
- ]
+ }
},
- "CreateOutputToolDTO": {
+ "UpdateGoHighLevelCalendarAvailabilityToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -24105,13 +32923,6 @@
]
}
},
- "type": {
- "type": "string",
- "enum": [
- "output"
- ],
- "description": "The type of tool. \"output\" for Output tool."
- },
"function": {
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
@@ -24119,28 +32930,12 @@
"$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"
- }
- ]
}
- },
- "required": [
- "type"
- ]
+ }
},
- "CreateBashToolDTO": {
+ "UpdateGoHighLevelCalendarEventCreateToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -24165,28 +32960,6 @@
]
}
},
- "type": {
- "type": "string",
- "enum": [
- "bash"
- ],
- "description": "The type of tool. \"bash\" for Bash tool."
- },
- "subType": {
- "type": "string",
- "enum": [
- "bash_20241022"
- ],
- "description": "The sub type of tool."
- },
- "name": {
- "type": "string",
- "description": "The name of the tool, fixed to 'bash'",
- "default": "bash",
- "enum": [
- "bash"
- ]
- },
"function": {
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
@@ -24194,30 +32967,12 @@
"$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"
- }
- ]
}
- },
- "required": [
- "type",
- "subType",
- "name"
- ]
+ }
},
- "CreateComputerToolDTO": {
+ "UpdateGoHighLevelContactCreateToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -24242,40 +32997,6 @@
]
}
},
- "type": {
- "type": "string",
- "enum": [
- "computer"
- ],
- "description": "The type of tool. \"computer\" for Computer tool."
- },
- "subType": {
- "type": "string",
- "enum": [
- "computer_20241022"
- ],
- "description": "The sub type of tool."
- },
- "name": {
- "type": "string",
- "description": "The name of the tool, fixed to 'computer'",
- "default": "computer",
- "enum": [
- "computer"
- ]
- },
- "displayWidthPx": {
- "type": "number",
- "description": "The display width in pixels"
- },
- "displayHeightPx": {
- "type": "number",
- "description": "The display height in pixels"
- },
- "displayNumber": {
- "type": "number",
- "description": "Optional display number"
- },
"function": {
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
@@ -24283,32 +33004,12 @@
"$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"
- }
- ]
}
- },
- "required": [
- "type",
- "subType",
- "name",
- "displayWidthPx",
- "displayHeightPx"
- ]
+ }
},
- "CreateTextEditorToolDTO": {
+ "UpdateGoHighLevelContactGetToolDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -24333,1581 +33034,1385 @@
]
}
},
- "type": {
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
+ }
+ }
+ },
+ "CreateFileDTO": {
+ "type": "object",
+ "properties": {
+ "file": {
+ "type": "string",
+ "description": "This is the File you want to upload for use with the Knowledge Base.",
+ "format": "binary"
+ }
+ },
+ "required": [
+ "file"
+ ]
+ },
+ "File": {
+ "type": "object",
+ "properties": {
+ "object": {
"type": "string",
"enum": [
- "textEditor"
- ],
- "description": "The type of tool. \"textEditor\" for Text Editor tool."
+ "file"
+ ]
},
- "subType": {
- "type": "string",
+ "status": {
"enum": [
- "text_editor_20241022"
+ "processing",
+ "done",
+ "failed"
],
- "description": "The sub type of tool."
+ "type": "string"
},
"name": {
"type": "string",
- "description": "The name of the tool, fixed to 'str_replace_editor'",
- "default": "str_replace_editor",
+ "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"
+ },
+ "parsedTextUrl": {
+ "type": "string"
+ },
+ "parsedTextBytes": {
+ "type": "number"
+ },
+ "metadata": {
+ "type": "object"
+ },
+ "id": {
+ "type": "string",
+ "description": "This is the unique identifier for the file."
+ },
+ "orgId": {
+ "type": "string",
+ "description": "This is the unique identifier for the org that this file belongs to."
+ },
+ "createdAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the file was created."
+ },
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the file was last updated."
+ }
+ },
+ "required": [
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt"
+ ]
+ },
+ "UpdateFileDTO": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "This is the name of the file. This is just for your own reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ }
+ },
+ "TrieveKnowledgeBaseSearchPlan": {
+ "type": "object",
+ "properties": {
+ "topK": {
+ "type": "number",
+ "description": "Specifies the number of top chunks to return. This corresponds to the `page_size` parameter in Trieve."
+ },
+ "removeStopWords": {
+ "type": "boolean",
+ "description": "If true, stop words (specified in server/src/stop-words.txt in the git repo) will be removed. This will preserve queries that are entirely stop words."
+ },
+ "scoreThreshold": {
+ "type": "number",
+ "description": "This is the score threshold to filter out chunks with a score below the threshold for cosine distance metric. For Manhattan Distance, Euclidean Distance, and Dot Product, it will filter out scores above the threshold distance. This threshold applies before weight and bias modifications. If not specified, this defaults to no threshold. A threshold of 0 will default to no threshold."
+ },
+ "searchType": {
+ "type": "string",
+ "description": "This is the search method used when searching for relevant chunks from the vector store.",
"enum": [
- "str_replace_editor"
+ "fulltext",
+ "semantic",
+ "hybrid",
+ "bm25"
+ ]
+ }
+ },
+ "required": [
+ "searchType"
+ ]
+ },
+ "TrieveKnowledgeBase": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "description": "This knowledge base is provided by Trieve.\n\nTo learn more about Trieve, visit https://trieve.ai.",
+ "enum": [
+ "trieve"
]
},
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "name": {
+ "type": "string",
+ "description": "This is the name of the knowledge base."
+ },
+ "searchPlan": {
+ "description": "This is the searching plan used when searching for relevant chunks from the vector store.\n\nYou should configure this if you're running into these issues:\n- Too much unnecessary context is being fed as knowledge base context.\n- Not enough relevant context is being fed as knowledge base context.",
"allOf": [
{
- "$ref": "#/components/schemas/OpenAIFunction"
+ "$ref": "#/components/schemas/TrieveKnowledgeBaseSearchPlan"
+ }
+ ]
+ },
+ "createPlan": {
+ "description": "This is the plan if you want us to create/import a new vector store using Trieve.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TrieveKnowledgeBaseImport",
+ "title": "Import"
}
]
},
+ "id": {
+ "type": "string",
+ "description": "This is the id of the knowledge base."
+ },
+ "orgId": {
+ "type": "string",
+ "description": "This is the org id of the knowledge base."
+ }
+ },
+ "required": [
+ "provider",
+ "id",
+ "orgId"
+ ]
+ },
+ "CustomKnowledgeBase": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "description": "This knowledge base is bring your own knowledge base implementation.",
+ "enum": [
+ "custom-knowledge-base"
+ ]
+ },
"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.",
+ "description": "This is where the knowledge base request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"messsage\": {\n \"type\": \"knowledge-base-request\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Why is ocean blue?\"\n }\n ],\n ...other metadata about the call...\n }\n}\n\nResponse Expected:\n```\n{\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The ocean is blue because water absorbs everything but blue.\",\n }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK\n \"documents\": [\n {\n \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",\n \"similarity\": 1\n },\n {\n \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",\n \"similarity\": .5\n }\n ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL\n}\n```",
"allOf": [
{
"$ref": "#/components/schemas/Server"
}
]
+ },
+ "id": {
+ "type": "string",
+ "description": "This is the id of the knowledge base."
+ },
+ "orgId": {
+ "type": "string",
+ "description": "This is the org id of the knowledge base."
}
},
"required": [
- "type",
- "subType",
- "name"
+ "provider",
+ "server",
+ "id",
+ "orgId"
]
},
- "CreateSmsSendToolDTO": {
+ "CreateTrieveKnowledgeBaseDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
- "type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
- },
- {
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
- },
- {
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
- },
- {
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
- },
- "type": {
+ "provider": {
"type": "string",
+ "description": "This knowledge base is provided by Trieve.\n\nTo learn more about Trieve, visit https://trieve.ai.",
"enum": [
- "sms"
- ],
- "description": "The type of tool. \"sms\" for Twilio SMS sending tool."
+ "trieve"
+ ]
},
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "name": {
+ "type": "string",
+ "description": "This is the name of the knowledge base."
+ },
+ "searchPlan": {
+ "description": "This is the searching plan used when searching for relevant chunks from the vector store.\n\nYou should configure this if you're running into these issues:\n- Too much unnecessary context is being fed as knowledge base context.\n- Not enough relevant context is being fed as knowledge base context.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/TrieveKnowledgeBaseSearchPlan"
+ }
+ ]
+ },
+ "createPlan": {
+ "description": "This is the plan if you want us to create/import a new vector store using Trieve.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TrieveKnowledgeBaseImport",
+ "title": "Import"
+ }
+ ]
+ }
+ },
+ "required": [
+ "provider"
+ ]
+ },
+ "UpdateTrieveKnowledgeBaseDTO": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "This is the name of the knowledge base."
+ },
+ "searchPlan": {
+ "description": "This is the searching plan used when searching for relevant chunks from the vector store.\n\nYou should configure this if you're running into these issues:\n- Too much unnecessary context is being fed as knowledge base context.\n- Not enough relevant context is being fed as knowledge base context.",
"allOf": [
{
- "$ref": "#/components/schemas/OpenAIFunction"
+ "$ref": "#/components/schemas/TrieveKnowledgeBaseSearchPlan"
}
]
},
+ "createPlan": {
+ "description": "This is the plan if you want us to create/import a new vector store using Trieve.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/TrieveKnowledgeBaseImport",
+ "title": "Import"
+ }
+ ]
+ }
+ }
+ },
+ "UpdateCustomKnowledgeBaseDTO": {
+ "type": "object",
+ "properties": {
"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.",
+ "description": "This is where the knowledge base request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"messsage\": {\n \"type\": \"knowledge-base-request\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Why is ocean blue?\"\n }\n ],\n ...other metadata about the call...\n }\n}\n\nResponse Expected:\n```\n{\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The ocean is blue because water absorbs everything but blue.\",\n }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK\n \"documents\": [\n {\n \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",\n \"similarity\": 1\n },\n {\n \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",\n \"similarity\": .5\n }\n ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL\n}\n```",
"allOf": [
{
"$ref": "#/components/schemas/Server"
}
]
}
- },
- "required": [
- "type"
- ]
+ }
},
- "CreateMcpToolDTO": {
+ "TrieveKnowledgeBaseChunkPlan": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
+ "fileIds": {
+ "description": "These are the file ids that will be used to create the vector store. To upload files, use the `POST /files` endpoint.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
},
- "messages": {
+ "websites": {
+ "description": "These are the websites that will be used to create the vector store.",
"type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
- },
- {
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
- },
- {
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
- },
- {
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
+ "type": "string"
+ }
+ },
+ "targetSplitsPerChunk": {
+ "type": "number",
+ "description": "This is an optional field which allows you to specify the number of splits you want per chunk. If not specified, the default 20 is used. However, you may want to use a different number."
+ },
+ "splitDelimiters": {
+ "description": "This is an optional field which allows you to specify the delimiters to use when splitting the file before chunking the text. If not specified, the default [.!?\\n] are used to split into sentences. However, you may want to use spaces or other delimiters.",
+ "type": "array",
+ "items": {
+ "type": "string"
}
},
+ "rebalanceChunks": {
+ "type": "boolean",
+ "description": "This is an optional field which allows you to specify whether or not to rebalance the chunks created from the file. If not specified, the default true is used. If true, Trieve will evenly distribute remainder splits across chunks such that 66 splits with a target_splits_per_chunk of 20 will result in 3 chunks with 22 splits each."
+ }
+ }
+ },
+ "TrieveKnowledgeBaseCreate": {
+ "type": "object",
+ "properties": {
"type": {
"type": "string",
+ "description": "This is to create a new dataset on Trieve.",
"enum": [
- "mcp"
- ],
- "description": "The type of tool. \"mcp\" for MCP tool."
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "allOf": [
- {
- "$ref": "#/components/schemas/OpenAIFunction"
- }
+ "create"
]
},
- "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"
- }
- ]
+ "chunkPlans": {
+ "description": "These are the chunk plans used to create the dataset.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TrieveKnowledgeBaseChunkPlan"
+ }
}
},
"required": [
- "type"
+ "type",
+ "chunkPlans"
]
},
- "UpdateDtmfToolDTO": {
+ "TrieveKnowledgeBaseImport": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
+ "type": {
+ "type": "string",
+ "description": "This is to import an existing dataset from Trieve.",
+ "enum": [
+ "import"
+ ]
},
- "messages": {
+ "providerId": {
+ "type": "string",
+ "description": "This is the `datasetId` of the dataset on your Trieve account."
+ }
+ },
+ "required": [
+ "type",
+ "providerId"
+ ]
+ },
+ "Workflow": {
+ "type": "object",
+ "properties": {
+ "nodes": {
"type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
- },
- {
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
- },
- {
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
+ "$ref": "#/components/schemas/ConversationNode",
+ "title": "ConversationNode"
},
{
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
+ "$ref": "#/components/schemas/ToolNode",
+ "title": "ToolNode"
}
]
}
},
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "allOf": [
+ "transcriber": {
+ "description": "This is the transcriber for the workflow.\n\nThis can be overridden at node level using `nodes[n].transcriber`.",
+ "oneOf": [
{
- "$ref": "#/components/schemas/OpenAIFunction"
+ "$ref": "#/components/schemas/AssemblyAITranscriber",
+ "title": "AssemblyAITranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/AzureSpeechTranscriber",
+ "title": "AzureSpeechTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/CustomTranscriber",
+ "title": "CustomTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/DeepgramTranscriber",
+ "title": "DeepgramTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/ElevenLabsTranscriber",
+ "title": "ElevenLabsTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/GladiaTranscriber",
+ "title": "GladiaTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleTranscriber",
+ "title": "GoogleTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/SpeechmaticsTranscriber",
+ "title": "SpeechmaticsTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/TalkscriberTranscriber",
+ "title": "TalkscriberTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAITranscriber",
+ "title": "OpenAITranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/CartesiaTranscriber",
+ "title": "CartesiaTranscriber"
}
]
},
- "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.",
+ "voice": {
+ "description": "This is the voice for the workflow.\n\nThis can be overridden at node level using `nodes[n].voice`.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AzureVoice",
+ "title": "AzureVoice"
+ },
+ {
+ "$ref": "#/components/schemas/CartesiaVoice",
+ "title": "CartesiaVoice"
+ },
+ {
+ "$ref": "#/components/schemas/CustomVoice",
+ "title": "CustomVoice"
+ },
+ {
+ "$ref": "#/components/schemas/DeepgramVoice",
+ "title": "DeepgramVoice"
+ },
+ {
+ "$ref": "#/components/schemas/ElevenLabsVoice",
+ "title": "ElevenLabsVoice"
+ },
+ {
+ "$ref": "#/components/schemas/HumeVoice",
+ "title": "HumeVoice"
+ },
+ {
+ "$ref": "#/components/schemas/LMNTVoice",
+ "title": "LMNTVoice"
+ },
+ {
+ "$ref": "#/components/schemas/NeuphonicVoice",
+ "title": "NeuphonicVoice"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAIVoice",
+ "title": "OpenAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/PlayHTVoice",
+ "title": "PlayHTVoice"
+ },
+ {
+ "$ref": "#/components/schemas/RimeAIVoice",
+ "title": "RimeAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/SmallestAIVoice",
+ "title": "SmallestAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/TavusVoice",
+ "title": "TavusVoice"
+ },
+ {
+ "$ref": "#/components/schemas/VapiVoice",
+ "title": "VapiVoice"
+ },
+ {
+ "$ref": "#/components/schemas/SesameVoice",
+ "title": "SesameVoice"
+ }
+ ]
+ },
+ "observabilityPlan": {
+ "description": "This is the plan for observability of workflow's calls.\n\nCurrently, only Langfuse is supported.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/LangfuseObservabilityPlan",
+ "title": "Langfuse"
+ }
+ ],
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/LangfuseObservabilityPlan"
}
]
- }
- }
- },
- "UpdateEndCallToolDTO": {
- "type": "object",
- "properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
},
- "messages": {
+ "credentials": {
"type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "description": "These are dynamic credentials that will be used for the workflow calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
+ "$ref": "#/components/schemas/CreateAnthropicCredentialDTO",
+ "title": "AnthropicCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
+ "$ref": "#/components/schemas/CreateAnyscaleCredentialDTO",
+ "title": "AnyscaleCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
+ "$ref": "#/components/schemas/CreateAssemblyAICredentialDTO",
+ "title": "AssemblyAICredential"
},
{
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
+ "$ref": "#/components/schemas/CreateAzureCredentialDTO",
+ "title": "AzureCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateAzureOpenAICredentialDTO",
+ "title": "AzureOpenAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
+ "title": "ByoSipTrunkCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCartesiaCredentialDTO",
+ "title": "CartesiaCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCerebrasCredentialDTO",
+ "title": "CerebrasCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCloudflareCredentialDTO",
+ "title": "CloudflareCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateCustomLLMCredentialDTO",
+ "title": "CustomLLMCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepgramCredentialDTO",
+ "title": "DeepgramCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepInfraCredentialDTO",
+ "title": "DeepInfraCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepSeekCredentialDTO",
+ "title": "DeepSeekCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateElevenLabsCredentialDTO",
+ "title": "ElevenLabsCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGcpCredentialDTO",
+ "title": "GcpCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGladiaCredentialDTO",
+ "title": "GladiaCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCredentialDTO",
+ "title": "GhlCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCredentialDTO",
+ "title": "GoogleCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGroqCredentialDTO",
+ "title": "GroqCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateHumeCredentialDTO",
+ "title": "HumeCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateInflectionAICredentialDTO",
+ "title": "InflectionAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateLangfuseCredentialDTO",
+ "title": "LangfuseCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateLmntCredentialDTO",
+ "title": "LmntCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMakeCredentialDTO",
+ "title": "MakeCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMistralCredentialDTO",
+ "title": "MistralCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateNeuphonicCredentialDTO",
+ "title": "NeuphonicCredential"
+ },
+ {
+ "$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/CreateS3CredentialDTO",
+ "title": "S3Credential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmallestAICredentialDTO",
+ "title": "SmallestAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
+ "title": "SpeechmaticsCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSupabaseCredentialDTO",
+ "title": "SupabaseCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTavusCredentialDTO",
+ "title": "TavusCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTogetherAICredentialDTO",
+ "title": "TogetherAICredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTrieveCredentialDTO",
+ "title": "TrieveCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioCredentialDTO",
+ "title": "TwilioCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonageCredentialDTO",
+ "title": "VonageCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateWebhookCredentialDTO",
+ "title": "WebhookCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateXAiCredentialDTO",
+ "title": "XAiCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
+ "title": "GoogleCalendarOAuth2ClientCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
+ "title": "GoogleCalendarOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
+ "title": "GoogleSheetsOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO",
+ "title": "SlackOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelMCPCredentialDTO",
+ "title": "GoHighLevelMCPCredential"
}
- ]
+ ],
+ "discriminator": {
+ "propertyName": "provider",
+ "mapping": {
+ "11labs": "#/components/schemas/CreateElevenLabsCredentialDTO",
+ "anthropic": "#/components/schemas/CreateAnthropicCredentialDTO",
+ "anyscale": "#/components/schemas/CreateAnyscaleCredentialDTO",
+ "assembly-ai": "#/components/schemas/CreateAssemblyAICredentialDTO",
+ "azure-openai": "#/components/schemas/CreateAzureOpenAICredentialDTO",
+ "azure": "#/components/schemas/CreateAzureCredentialDTO",
+ "byo-sip-trunk": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
+ "cartesia": "#/components/schemas/CreateCartesiaCredentialDTO",
+ "cerebras": "#/components/schemas/CreateCerebrasCredentialDTO",
+ "cloudflare": "#/components/schemas/CreateCloudflareCredentialDTO",
+ "custom-llm": "#/components/schemas/CreateCustomLLMCredentialDTO",
+ "deepgram": "#/components/schemas/CreateDeepgramCredentialDTO",
+ "deepinfra": "#/components/schemas/CreateDeepInfraCredentialDTO",
+ "deep-seek": "#/components/schemas/CreateDeepSeekCredentialDTO",
+ "gcp": "#/components/schemas/CreateGcpCredentialDTO",
+ "gladia": "#/components/schemas/CreateGladiaCredentialDTO",
+ "gohighlevel": "#/components/schemas/CreateGoHighLevelCredentialDTO",
+ "google": "#/components/schemas/CreateGoogleCredentialDTO",
+ "groq": "#/components/schemas/CreateGroqCredentialDTO",
+ "inflection-ai": "#/components/schemas/CreateInflectionAICredentialDTO",
+ "langfuse": "#/components/schemas/CreateLangfuseCredentialDTO",
+ "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",
+ "s3": "#/components/schemas/CreateS3CredentialDTO",
+ "supabase": "#/components/schemas/CreateSupabaseCredentialDTO",
+ "smallest-ai": "#/components/schemas/CreateSmallestAICredentialDTO",
+ "tavus": "#/components/schemas/CreateTavusCredentialDTO",
+ "together-ai": "#/components/schemas/CreateTogetherAICredentialDTO",
+ "twilio": "#/components/schemas/CreateTwilioCredentialDTO",
+ "vonage": "#/components/schemas/CreateVonageCredentialDTO",
+ "webhook": "#/components/schemas/CreateWebhookCredentialDTO",
+ "xai": "#/components/schemas/CreateXAiCredentialDTO",
+ "neuphonic": "#/components/schemas/CreateNeuphonicCredentialDTO",
+ "hume": "#/components/schemas/CreateHumeCredentialDTO",
+ "mistral": "#/components/schemas/CreateMistralCredentialDTO",
+ "speechmatics": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
+ "trieve": "#/components/schemas/CreateTrieveCredentialDTO",
+ "google.calendar.oauth2-client": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
+ "google.calendar.oauth2-authorization": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
+ "google.sheets.oauth2-authorization": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
+ "slack.oauth2-authorization": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO",
+ "ghl.oauth2-authorization": "#/components/schemas/CreateGoHighLevelMCPCredentialDTO"
+ }
+ }
+ }
+ },
+ "id": {
+ "type": "string"
+ },
+ "orgId": {
+ "type": "string"
+ },
+ "createdAt": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "maxLength": 80
+ },
+ "edges": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Edge"
}
},
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "globalPrompt": {
+ "type": "string",
+ "maxLength": 5000
+ },
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. tool.server\n2. workflow.server / assistant.server\n3. phoneNumber.server\n4. org.server",
"allOf": [
{
- "$ref": "#/components/schemas/OpenAIFunction"
+ "$ref": "#/components/schemas/Server"
}
]
},
- "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.",
+ "compliancePlan": {
+ "description": "This is the compliance plan for the workflow. It allows you to configure HIPAA and other compliance settings.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/CompliancePlan"
}
]
- }
- }
- },
- "UpdateFunctionToolDTO": {
- "type": "object",
- "properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
- "type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
- },
- {
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
- },
- {
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
- },
- {
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
},
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "analysisPlan": {
+ "description": "This is the plan for analysis of workflow's calls. Stored in `call.analysis`.",
"allOf": [
{
- "$ref": "#/components/schemas/OpenAIFunction"
+ "$ref": "#/components/schemas/AnalysisPlan"
}
]
},
- "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.",
+ "artifactPlan": {
+ "description": "This is the plan for artifacts generated during workflow's calls. Stored in `call.artifact`.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/ArtifactPlan"
}
]
- }
- }
- },
- "UpdateGhlToolDTO": {
- "type": "object",
- "properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
- "type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
- },
- {
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
- },
- {
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
- },
- {
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
},
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "startSpeakingPlan": {
+ "description": "This is the plan for when the workflow nodes should start talking.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to start talking after the customer is done speaking.\n- The assistant is too fast to start talking after the customer is done speaking.\n- The assistant is so fast that it's actually interrupting the customer.",
"allOf": [
{
- "$ref": "#/components/schemas/OpenAIFunction"
+ "$ref": "#/components/schemas/StartSpeakingPlan"
}
]
},
- "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.",
+ "stopSpeakingPlan": {
+ "description": "This is the plan for when workflow nodes should stop talking on customer interruption.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to recognize customer's interruption.\n- The assistant is too fast to recognize customer's interruption.\n- The assistant is getting interrupted by phrases that are just acknowledgments.\n- The assistant is getting interrupted by background noises.\n- The assistant is not properly stopping -- it starts talking right after getting interrupted.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/StopSpeakingPlan"
}
]
},
- "metadata": {
- "$ref": "#/components/schemas/GhlToolMetadata"
- }
- }
- },
- "UpdateMakeToolDTO": {
- "type": "object",
- "properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
- "type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
- },
- {
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
- },
- {
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
- },
- {
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "monitorPlan": {
+ "description": "This is the plan for real-time monitoring of the workflow's calls.\n\nUsage:\n- To enable live listening of the workflow's calls, set `monitorPlan.listenEnabled` to `true`.\n- To enable live control of the workflow's calls, set `monitorPlan.controlEnabled` to `true`.",
"allOf": [
{
- "$ref": "#/components/schemas/OpenAIFunction"
+ "$ref": "#/components/schemas/MonitorPlan"
}
]
},
- "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.",
+ "backgroundSpeechDenoisingPlan": {
+ "description": "This enables filtering of noise and background speech while the user is talking.\n\nFeatures:\n- Smart denoising using Krisp\n- Fourier denoising\n\nBoth can be used together. Order of precedence:\n- Smart denoising\n- Fourier denoising",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/BackgroundSpeechDenoisingPlan"
}
]
},
- "metadata": {
- "$ref": "#/components/schemas/MakeToolMetadata"
+ "credentialIds": {
+ "description": "These are the credentials that will be used for the workflow calls. By default, all the credentials are available for use in the call but you can provide a subset using this.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
- }
+ },
+ "required": [
+ "nodes",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt",
+ "name",
+ "edges"
+ ]
},
- "UpdateTransferCallToolDTO": {
+ "UpdateWorkflowDTO": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
+ "nodes": {
"type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
- },
- {
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
- },
- {
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
+ "$ref": "#/components/schemas/ConversationNode",
+ "title": "ConversationNode"
},
{
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
+ "$ref": "#/components/schemas/ToolNode",
+ "title": "ToolNode"
}
]
}
},
- "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.",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/TransferDestinationAssistant",
- "title": "Assistant"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationStep",
- "title": "Step"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationNumber",
- "title": "Number"
- },
- {
- "$ref": "#/components/schemas/TransferDestinationSip",
- "title": "Sip"
- }
- ]
- }
+ "transcriber": {
+ "description": "This is the transcriber for the workflow.\n\nThis can be overridden at node level using `nodes[n].transcriber`.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AssemblyAITranscriber",
+ "title": "AssemblyAITranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/AzureSpeechTranscriber",
+ "title": "AzureSpeechTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/CustomTranscriber",
+ "title": "CustomTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/DeepgramTranscriber",
+ "title": "DeepgramTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/ElevenLabsTranscriber",
+ "title": "ElevenLabsTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/GladiaTranscriber",
+ "title": "GladiaTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/GoogleTranscriber",
+ "title": "GoogleTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/SpeechmaticsTranscriber",
+ "title": "SpeechmaticsTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/TalkscriberTranscriber",
+ "title": "TalkscriberTranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAITranscriber",
+ "title": "OpenAITranscriber"
+ },
+ {
+ "$ref": "#/components/schemas/CartesiaTranscriber",
+ "title": "CartesiaTranscriber"
+ }
+ ]
},
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "allOf": [
+ "voice": {
+ "description": "This is the voice for the workflow.\n\nThis can be overridden at node level using `nodes[n].voice`.",
+ "oneOf": [
{
- "$ref": "#/components/schemas/OpenAIFunction"
+ "$ref": "#/components/schemas/AzureVoice",
+ "title": "AzureVoice"
+ },
+ {
+ "$ref": "#/components/schemas/CartesiaVoice",
+ "title": "CartesiaVoice"
+ },
+ {
+ "$ref": "#/components/schemas/CustomVoice",
+ "title": "CustomVoice"
+ },
+ {
+ "$ref": "#/components/schemas/DeepgramVoice",
+ "title": "DeepgramVoice"
+ },
+ {
+ "$ref": "#/components/schemas/ElevenLabsVoice",
+ "title": "ElevenLabsVoice"
+ },
+ {
+ "$ref": "#/components/schemas/HumeVoice",
+ "title": "HumeVoice"
+ },
+ {
+ "$ref": "#/components/schemas/LMNTVoice",
+ "title": "LMNTVoice"
+ },
+ {
+ "$ref": "#/components/schemas/NeuphonicVoice",
+ "title": "NeuphonicVoice"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAIVoice",
+ "title": "OpenAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/PlayHTVoice",
+ "title": "PlayHTVoice"
+ },
+ {
+ "$ref": "#/components/schemas/RimeAIVoice",
+ "title": "RimeAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/SmallestAIVoice",
+ "title": "SmallestAIVoice"
+ },
+ {
+ "$ref": "#/components/schemas/TavusVoice",
+ "title": "TavusVoice"
+ },
+ {
+ "$ref": "#/components/schemas/VapiVoice",
+ "title": "VapiVoice"
+ },
+ {
+ "$ref": "#/components/schemas/SesameVoice",
+ "title": "SesameVoice"
}
]
},
- "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.",
+ "observabilityPlan": {
+ "description": "This is the plan for observability of workflow's calls.\n\nCurrently, only Langfuse is supported.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/LangfuseObservabilityPlan",
+ "title": "Langfuse"
+ }
+ ],
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/LangfuseObservabilityPlan"
}
]
- }
- }
- },
- "UpdateOutputToolDTO": {
- "type": "object",
- "properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
},
- "messages": {
+ "credentials": {
"type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "description": "These are dynamic credentials that will be used for the workflow calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.",
"items": {
"oneOf": [
{
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
+ "$ref": "#/components/schemas/CreateAnthropicCredentialDTO",
+ "title": "AnthropicCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
+ "$ref": "#/components/schemas/CreateAnyscaleCredentialDTO",
+ "title": "AnyscaleCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
+ "$ref": "#/components/schemas/CreateAssemblyAICredentialDTO",
+ "title": "AssemblyAICredential"
},
{
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "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"
- }
- ]
- }
- }
- },
- "UpdateBashToolDTO": {
- "type": "object",
- "properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
- "type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
- "items": {
- "oneOf": [
+ "$ref": "#/components/schemas/CreateAzureCredentialDTO",
+ "title": "AzureCredential"
+ },
{
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
+ "$ref": "#/components/schemas/CreateAzureOpenAICredentialDTO",
+ "title": "AzureOpenAICredential"
},
{
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
+ "$ref": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
+ "title": "ByoSipTrunkCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
+ "$ref": "#/components/schemas/CreateCartesiaCredentialDTO",
+ "title": "CartesiaCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
- },
- "subType": {
- "type": "string",
- "enum": [
- "bash_20241022"
- ],
- "description": "The sub type of tool."
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "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"
- }
- ]
- },
- "name": {
- "type": "string",
- "description": "The name of the tool, fixed to 'bash'",
- "default": "bash",
- "enum": [
- "bash"
- ]
- }
- }
- },
- "UpdateComputerToolDTO": {
- "type": "object",
- "properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
- "type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
- "items": {
- "oneOf": [
+ "$ref": "#/components/schemas/CreateCerebrasCredentialDTO",
+ "title": "CerebrasCredential"
+ },
{
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
+ "$ref": "#/components/schemas/CreateCloudflareCredentialDTO",
+ "title": "CloudflareCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
+ "$ref": "#/components/schemas/CreateCustomLLMCredentialDTO",
+ "title": "CustomLLMCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
+ "$ref": "#/components/schemas/CreateDeepgramCredentialDTO",
+ "title": "DeepgramCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
- },
- "subType": {
- "type": "string",
- "enum": [
- "computer_20241022"
- ],
- "description": "The sub type of tool."
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "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"
- }
- ]
- },
- "name": {
- "type": "string",
- "description": "The name of the tool, fixed to 'computer'",
- "default": "computer",
- "enum": [
- "computer"
- ]
- },
- "displayWidthPx": {
- "type": "number",
- "description": "The display width in pixels"
- },
- "displayHeightPx": {
- "type": "number",
- "description": "The display height in pixels"
- },
- "displayNumber": {
- "type": "number",
- "description": "Optional display number"
- }
- }
- },
- "UpdateTextEditorToolDTO": {
- "type": "object",
- "properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
- "type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
- "items": {
- "oneOf": [
+ "$ref": "#/components/schemas/CreateDeepInfraCredentialDTO",
+ "title": "DeepInfraCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateDeepSeekCredentialDTO",
+ "title": "DeepSeekCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateElevenLabsCredentialDTO",
+ "title": "ElevenLabsCredential"
+ },
{
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
+ "$ref": "#/components/schemas/CreateGcpCredentialDTO",
+ "title": "GcpCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
+ "$ref": "#/components/schemas/CreateGladiaCredentialDTO",
+ "title": "GladiaCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
+ "$ref": "#/components/schemas/CreateGoHighLevelCredentialDTO",
+ "title": "GhlCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
- },
- "subType": {
- "type": "string",
- "enum": [
- "text_editor_20241022"
- ],
- "description": "The sub type of tool."
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "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"
- }
- ]
- },
- "name": {
- "type": "string",
- "description": "The name of the tool, fixed to 'str_replace_editor'",
- "default": "str_replace_editor",
- "enum": [
- "str_replace_editor"
- ]
- }
- }
- },
- "UpdateQueryToolDTO": {
- "type": "object",
- "properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
- "type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
- "items": {
- "oneOf": [
+ "$ref": "#/components/schemas/CreateGoogleCredentialDTO",
+ "title": "GoogleCredential"
+ },
{
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
+ "$ref": "#/components/schemas/CreateGroqCredentialDTO",
+ "title": "GroqCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
+ "$ref": "#/components/schemas/CreateHumeCredentialDTO",
+ "title": "HumeCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
+ "$ref": "#/components/schemas/CreateInflectionAICredentialDTO",
+ "title": "InflectionAICredential"
},
{
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
- },
- "knowledgeBases": {
- "description": "The knowledge bases to query",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/KnowledgeBase"
- }
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "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"
- }
- ]
- }
- }
- },
- "UpdateGoogleCalendarCreateEventToolDTO": {
- "type": "object",
- "properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
- "type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
- "items": {
- "oneOf": [
+ "$ref": "#/components/schemas/CreateLangfuseCredentialDTO",
+ "title": "LangfuseCredential"
+ },
{
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
+ "$ref": "#/components/schemas/CreateLmntCredentialDTO",
+ "title": "LmntCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
+ "$ref": "#/components/schemas/CreateMakeCredentialDTO",
+ "title": "MakeCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
+ "$ref": "#/components/schemas/CreateMistralCredentialDTO",
+ "title": "MistralCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "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"
- }
- ]
- }
- }
- },
- "UpdateGoogleSheetsRowAppendToolDTO": {
- "type": "object",
- "properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
- "type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
- "items": {
- "oneOf": [
+ "$ref": "#/components/schemas/CreateNeuphonicCredentialDTO",
+ "title": "NeuphonicCredential"
+ },
{
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
+ "$ref": "#/components/schemas/CreateOpenAICredentialDTO",
+ "title": "OpenAICredential"
},
{
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
+ "$ref": "#/components/schemas/CreateOpenRouterCredentialDTO",
+ "title": "OpenRouterCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
+ "$ref": "#/components/schemas/CreatePerplexityAICredentialDTO",
+ "title": "PerplexityAICredential"
},
{
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "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"
- }
- ]
- }
- }
- },
- "UpdateGoogleCalendarCheckAvailabilityToolDTO": {
- "type": "object",
- "properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
- "type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
- "items": {
- "oneOf": [
+ "$ref": "#/components/schemas/CreatePlayHTCredentialDTO",
+ "title": "PlayHTCredential"
+ },
{
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
+ "$ref": "#/components/schemas/CreateRimeAICredentialDTO",
+ "title": "RimeAICredential"
},
{
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
+ "$ref": "#/components/schemas/CreateRunpodCredentialDTO",
+ "title": "RunpodCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
+ "$ref": "#/components/schemas/CreateS3CredentialDTO",
+ "title": "S3Credential"
},
{
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "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"
- }
- ]
- }
- }
- },
- "UpdateSlackSendMessageToolDTO": {
- "type": "object",
- "properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
- "type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
- "items": {
- "oneOf": [
+ "$ref": "#/components/schemas/CreateSmallestAICredentialDTO",
+ "title": "SmallestAICredential"
+ },
{
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
+ "$ref": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
+ "title": "SpeechmaticsCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
+ "$ref": "#/components/schemas/CreateSupabaseCredentialDTO",
+ "title": "SupabaseCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
+ "$ref": "#/components/schemas/CreateTavusCredentialDTO",
+ "title": "TavusCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "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"
- }
- ]
- }
- }
- },
- "UpdateSmsSendToolDTO": {
- "type": "object",
- "properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
- "type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
- "items": {
- "oneOf": [
+ "$ref": "#/components/schemas/CreateTogetherAICredentialDTO",
+ "title": "TogetherAICredential"
+ },
{
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
+ "$ref": "#/components/schemas/CreateTrieveCredentialDTO",
+ "title": "TrieveCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
+ "$ref": "#/components/schemas/CreateTwilioCredentialDTO",
+ "title": "TwilioCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
+ "$ref": "#/components/schemas/CreateVonageCredentialDTO",
+ "title": "VonageCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
- }
- ]
- }
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "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"
- }
- ]
- }
- }
- },
- "UpdateMcpToolDTO": {
- "type": "object",
- "properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
- "messages": {
- "type": "array",
- "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
- "items": {
- "oneOf": [
+ "$ref": "#/components/schemas/CreateWebhookCredentialDTO",
+ "title": "WebhookCredential"
+ },
{
- "$ref": "#/components/schemas/ToolMessageStart",
- "title": "ToolMessageStart"
+ "$ref": "#/components/schemas/CreateXAiCredentialDTO",
+ "title": "XAiCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
+ "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
+ "title": "GoogleCalendarOAuth2ClientCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
+ "$ref": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
+ "title": "GoogleCalendarOAuth2AuthorizationCredential"
},
{
- "$ref": "#/components/schemas/ToolMessageDelayed",
- "title": "ToolMessageDelayed"
+ "$ref": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
+ "title": "GoogleSheetsOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO",
+ "title": "SlackOAuth2AuthorizationCredential"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelMCPCredentialDTO",
+ "title": "GoHighLevelMCPCredential"
}
- ]
- }
- },
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
- "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"
- }
- ]
- }
- }
- },
- "CreateFileDTO": {
- "type": "object",
- "properties": {
- "file": {
- "type": "string",
- "description": "This is the File you want to upload for use with the Knowledge Base.",
- "format": "binary"
- }
- },
- "required": [
- "file"
- ]
- },
- "File": {
- "type": "object",
- "properties": {
- "object": {
- "type": "string",
- "enum": [
- "file"
- ]
- },
- "status": {
- "enum": [
- "processing",
- "done",
- "failed"
- ],
- "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"
- },
- "parsedTextUrl": {
- "type": "string"
- },
- "parsedTextBytes": {
- "type": "number"
- },
- "metadata": {
- "type": "object"
- },
- "id": {
- "type": "string",
- "description": "This is the unique identifier for the file."
- },
- "orgId": {
- "type": "string",
- "description": "This is the unique identifier for the org that this file belongs to."
- },
- "createdAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the file was created."
+ ],
+ "discriminator": {
+ "propertyName": "provider",
+ "mapping": {
+ "11labs": "#/components/schemas/CreateElevenLabsCredentialDTO",
+ "anthropic": "#/components/schemas/CreateAnthropicCredentialDTO",
+ "anyscale": "#/components/schemas/CreateAnyscaleCredentialDTO",
+ "assembly-ai": "#/components/schemas/CreateAssemblyAICredentialDTO",
+ "azure-openai": "#/components/schemas/CreateAzureOpenAICredentialDTO",
+ "azure": "#/components/schemas/CreateAzureCredentialDTO",
+ "byo-sip-trunk": "#/components/schemas/CreateByoSipTrunkCredentialDTO",
+ "cartesia": "#/components/schemas/CreateCartesiaCredentialDTO",
+ "cerebras": "#/components/schemas/CreateCerebrasCredentialDTO",
+ "cloudflare": "#/components/schemas/CreateCloudflareCredentialDTO",
+ "custom-llm": "#/components/schemas/CreateCustomLLMCredentialDTO",
+ "deepgram": "#/components/schemas/CreateDeepgramCredentialDTO",
+ "deepinfra": "#/components/schemas/CreateDeepInfraCredentialDTO",
+ "deep-seek": "#/components/schemas/CreateDeepSeekCredentialDTO",
+ "gcp": "#/components/schemas/CreateGcpCredentialDTO",
+ "gladia": "#/components/schemas/CreateGladiaCredentialDTO",
+ "gohighlevel": "#/components/schemas/CreateGoHighLevelCredentialDTO",
+ "google": "#/components/schemas/CreateGoogleCredentialDTO",
+ "groq": "#/components/schemas/CreateGroqCredentialDTO",
+ "inflection-ai": "#/components/schemas/CreateInflectionAICredentialDTO",
+ "langfuse": "#/components/schemas/CreateLangfuseCredentialDTO",
+ "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",
+ "s3": "#/components/schemas/CreateS3CredentialDTO",
+ "supabase": "#/components/schemas/CreateSupabaseCredentialDTO",
+ "smallest-ai": "#/components/schemas/CreateSmallestAICredentialDTO",
+ "tavus": "#/components/schemas/CreateTavusCredentialDTO",
+ "together-ai": "#/components/schemas/CreateTogetherAICredentialDTO",
+ "twilio": "#/components/schemas/CreateTwilioCredentialDTO",
+ "vonage": "#/components/schemas/CreateVonageCredentialDTO",
+ "webhook": "#/components/schemas/CreateWebhookCredentialDTO",
+ "xai": "#/components/schemas/CreateXAiCredentialDTO",
+ "neuphonic": "#/components/schemas/CreateNeuphonicCredentialDTO",
+ "hume": "#/components/schemas/CreateHumeCredentialDTO",
+ "mistral": "#/components/schemas/CreateMistralCredentialDTO",
+ "speechmatics": "#/components/schemas/CreateSpeechmaticsCredentialDTO",
+ "trieve": "#/components/schemas/CreateTrieveCredentialDTO",
+ "google.calendar.oauth2-client": "#/components/schemas/CreateGoogleCalendarOAuth2ClientCredentialDTO",
+ "google.calendar.oauth2-authorization": "#/components/schemas/CreateGoogleCalendarOAuth2AuthorizationCredentialDTO",
+ "google.sheets.oauth2-authorization": "#/components/schemas/CreateGoogleSheetsOAuth2AuthorizationCredentialDTO",
+ "slack.oauth2-authorization": "#/components/schemas/CreateSlackOAuth2AuthorizationCredentialDTO",
+ "ghl.oauth2-authorization": "#/components/schemas/CreateGoHighLevelMCPCredentialDTO"
+ }
+ }
+ }
},
- "updatedAt": {
- "format": "date-time",
- "type": "string",
- "description": "This is the ISO 8601 date-time string of when the file was last updated."
- }
- },
- "required": [
- "id",
- "orgId",
- "createdAt",
- "updatedAt"
- ]
- },
- "UpdateFileDTO": {
- "type": "object",
- "properties": {
"name": {
"type": "string",
- "description": "This is the name of the file. This is just for your own reference.",
- "minLength": 1,
- "maxLength": 40
- }
- }
- },
- "TrieveKnowledgeBaseSearchPlan": {
- "type": "object",
- "properties": {
- "topK": {
- "type": "number",
- "description": "Specifies the number of top chunks to return. This corresponds to the `page_size` parameter in Trieve."
- },
- "removeStopWords": {
- "type": "boolean",
- "description": "If true, stop words (specified in server/src/stop-words.txt in the git repo) will be removed. This will preserve queries that are entirely stop words."
- },
- "scoreThreshold": {
- "type": "number",
- "description": "This is the score threshold to filter out chunks with a score below the threshold for cosine distance metric. For Manhattan Distance, Euclidean Distance, and Dot Product, it will filter out scores above the threshold distance. This threshold applies before weight and bias modifications. If not specified, this defaults to no threshold. A threshold of 0 will default to no threshold."
+ "maxLength": 80
},
- "searchType": {
- "type": "string",
- "description": "This is the search method used when searching for relevant chunks from the vector store.",
- "enum": [
- "fulltext",
- "semantic",
- "hybrid",
- "bm25"
- ]
- }
- },
- "required": [
- "searchType"
- ]
- },
- "TrieveKnowledgeBase": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "description": "This knowledge base is provided by Trieve.\n\nTo learn more about Trieve, visit https://trieve.ai.",
- "enum": [
- "trieve"
- ]
+ "edges": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Edge"
+ }
},
- "name": {
+ "globalPrompt": {
"type": "string",
- "description": "This is the name of the knowledge base."
+ "maxLength": 5000
},
- "searchPlan": {
- "description": "This is the searching plan used when searching for relevant chunks from the vector store.\n\nYou should configure this if you're running into these issues:\n- Too much unnecessary context is being fed as knowledge base context.\n- Not enough relevant context is being fed as knowledge base context.",
+ "server": {
+ "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. tool.server\n2. workflow.server / assistant.server\n3. phoneNumber.server\n4. org.server",
"allOf": [
{
- "$ref": "#/components/schemas/TrieveKnowledgeBaseSearchPlan"
+ "$ref": "#/components/schemas/Server"
}
]
},
- "createPlan": {
- "description": "This is the plan if you want us to create/import a new vector store using Trieve.",
- "oneOf": [
+ "compliancePlan": {
+ "description": "This is the compliance plan for the workflow. It allows you to configure HIPAA and other compliance settings.",
+ "allOf": [
{
- "$ref": "#/components/schemas/TrieveKnowledgeBaseImport",
- "title": "Import"
+ "$ref": "#/components/schemas/CompliancePlan"
}
]
},
- "id": {
- "type": "string",
- "description": "This is the id of the knowledge base."
- },
- "orgId": {
- "type": "string",
- "description": "This is the org id of the knowledge base."
- }
- },
- "required": [
- "provider",
- "id",
- "orgId"
- ]
- },
- "CustomKnowledgeBase": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "description": "This knowledge base is bring your own knowledge base implementation.",
- "enum": [
- "custom-knowledge-base"
- ]
- },
- "server": {
- "description": "This is where the knowledge base request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"messsage\": {\n \"type\": \"knowledge-base-request\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Why is ocean blue?\"\n }\n ],\n ...other metadata about the call...\n }\n}\n\nResponse Expected:\n```\n{\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The ocean is blue because water absorbs everything but blue.\",\n }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK\n \"documents\": [\n {\n \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",\n \"similarity\": 1\n },\n {\n \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",\n \"similarity\": .5\n }\n ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL\n}\n```",
+ "analysisPlan": {
+ "description": "This is the plan for analysis of workflow's calls. Stored in `call.analysis`.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/AnalysisPlan"
}
]
},
- "id": {
- "type": "string",
- "description": "This is the id of the knowledge base."
- },
- "orgId": {
- "type": "string",
- "description": "This is the org id of the knowledge base."
- }
- },
- "required": [
- "provider",
- "server",
- "id",
- "orgId"
- ]
- },
- "CreateTrieveKnowledgeBaseDTO": {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "description": "This knowledge base is provided by Trieve.\n\nTo learn more about Trieve, visit https://trieve.ai.",
- "enum": [
- "trieve"
- ]
- },
- "name": {
- "type": "string",
- "description": "This is the name of the knowledge base."
- },
- "searchPlan": {
- "description": "This is the searching plan used when searching for relevant chunks from the vector store.\n\nYou should configure this if you're running into these issues:\n- Too much unnecessary context is being fed as knowledge base context.\n- Not enough relevant context is being fed as knowledge base context.",
+ "artifactPlan": {
+ "description": "This is the plan for artifacts generated during workflow's calls. Stored in `call.artifact`.",
"allOf": [
{
- "$ref": "#/components/schemas/TrieveKnowledgeBaseSearchPlan"
+ "$ref": "#/components/schemas/ArtifactPlan"
}
]
},
- "createPlan": {
- "description": "This is the plan if you want us to create/import a new vector store using Trieve.",
- "oneOf": [
+ "startSpeakingPlan": {
+ "description": "This is the plan for when the workflow nodes should start talking.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to start talking after the customer is done speaking.\n- The assistant is too fast to start talking after the customer is done speaking.\n- The assistant is so fast that it's actually interrupting the customer.",
+ "allOf": [
{
- "$ref": "#/components/schemas/TrieveKnowledgeBaseImport",
- "title": "Import"
+ "$ref": "#/components/schemas/StartSpeakingPlan"
}
]
- }
- },
- "required": [
- "provider"
- ]
- },
- "UpdateTrieveKnowledgeBaseDTO": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "This is the name of the knowledge base."
},
- "searchPlan": {
- "description": "This is the searching plan used when searching for relevant chunks from the vector store.\n\nYou should configure this if you're running into these issues:\n- Too much unnecessary context is being fed as knowledge base context.\n- Not enough relevant context is being fed as knowledge base context.",
+ "stopSpeakingPlan": {
+ "description": "This is the plan for when workflow nodes should stop talking on customer interruption.\n\nYou should configure this if you're running into these issues:\n- The assistant is too slow to recognize customer's interruption.\n- The assistant is too fast to recognize customer's interruption.\n- The assistant is getting interrupted by phrases that are just acknowledgments.\n- The assistant is getting interrupted by background noises.\n- The assistant is not properly stopping -- it starts talking right after getting interrupted.",
"allOf": [
{
- "$ref": "#/components/schemas/TrieveKnowledgeBaseSearchPlan"
+ "$ref": "#/components/schemas/StopSpeakingPlan"
}
]
},
- "createPlan": {
- "description": "This is the plan if you want us to create/import a new vector store using Trieve.",
- "oneOf": [
+ "monitorPlan": {
+ "description": "This is the plan for real-time monitoring of the workflow's calls.\n\nUsage:\n- To enable live listening of the workflow's calls, set `monitorPlan.listenEnabled` to `true`.\n- To enable live control of the workflow's calls, set `monitorPlan.controlEnabled` to `true`.",
+ "allOf": [
{
- "$ref": "#/components/schemas/TrieveKnowledgeBaseImport",
- "title": "Import"
+ "$ref": "#/components/schemas/MonitorPlan"
}
]
- }
- }
- },
- "UpdateCustomKnowledgeBaseDTO": {
- "type": "object",
- "properties": {
- "server": {
- "description": "This is where the knowledge base request will be sent.\n\nRequest Example:\n\nPOST https://{server.url}\nContent-Type: application/json\n\n{\n \"messsage\": {\n \"type\": \"knowledge-base-request\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"Why is ocean blue?\"\n }\n ],\n ...other metadata about the call...\n }\n}\n\nResponse Expected:\n```\n{\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The ocean is blue because water absorbs everything but blue.\",\n }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK\n \"documents\": [\n {\n \"content\": \"The ocean is blue primarily because water absorbs colors in the red part of the light spectrum and scatters the blue light, making it more visible to our eyes.\",\n \"similarity\": 1\n },\n {\n \"content\": \"Blue light is scattered more by the water molecules than other colors, enhancing the blue appearance of the ocean.\",\n \"similarity\": .5\n }\n ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL\n}\n```",
+ },
+ "backgroundSpeechDenoisingPlan": {
+ "description": "This enables filtering of noise and background speech while the user is talking.\n\nFeatures:\n- Smart denoising using Krisp\n- Fourier denoising\n\nBoth can be used together. Order of precedence:\n- Smart denoising\n- Fourier denoising",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/BackgroundSpeechDenoisingPlan"
}
]
- }
- }
- },
- "TrieveKnowledgeBaseChunkPlan": {
- "type": "object",
- "properties": {
- "fileIds": {
- "description": "These are the file ids that will be used to create the vector store. To upload files, use the `POST /files` endpoint.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "websites": {
- "description": "These are the websites that will be used to create the vector store.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "targetSplitsPerChunk": {
- "type": "number",
- "description": "This is an optional field which allows you to specify the number of splits you want per chunk. If not specified, the default 20 is used. However, you may want to use a different number."
},
- "splitDelimiters": {
- "description": "This is an optional field which allows you to specify the delimiters to use when splitting the file before chunking the text. If not specified, the default [.!?\\n] are used to split into sentences. However, you may want to use spaces or other delimiters.",
+ "credentialIds": {
+ "description": "These are the credentials that will be used for the workflow calls. By default, all the credentials are available for use in the call but you can provide a subset using this.",
"type": "array",
"items": {
"type": "string"
}
- },
- "rebalanceChunks": {
- "type": "boolean",
- "description": "This is an optional field which allows you to specify whether or not to rebalance the chunks created from the file. If not specified, the default true is used. If true, Trieve will evenly distribute remainder splits across chunks such that 66 splits with a target_splits_per_chunk of 20 will result in 3 chunks with 22 splits each."
}
}
},
- "TrieveKnowledgeBaseCreate": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "description": "This is to create a new dataset on Trieve.",
- "enum": [
- "create"
- ]
- },
- "chunkPlans": {
- "description": "These are the chunk plans used to create the dataset.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TrieveKnowledgeBaseChunkPlan"
- }
- }
- },
- "required": [
- "type",
- "chunkPlans"
- ]
- },
- "TrieveKnowledgeBaseImport": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "description": "This is to import an existing dataset from Trieve.",
- "enum": [
- "import"
- ]
- },
- "providerId": {
- "type": "string",
- "description": "This is the `datasetId` of the dataset on your Trieve account."
- }
- },
- "required": [
- "type",
- "providerId"
- ]
- },
- "UpdateWorkflowDTO": {
+ "GenerateWorkflowDTO": {
"type": "object",
"properties": {
- "nodes": {
- "type": "array",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/Say",
- "title": "Say"
- },
- {
- "$ref": "#/components/schemas/Gather",
- "title": "Gather"
- },
- {
- "$ref": "#/components/schemas/ApiRequest",
- "title": "ApiRequest"
- },
- {
- "$ref": "#/components/schemas/Hangup",
- "title": "Hangup"
- },
- {
- "$ref": "#/components/schemas/Transfer",
- "title": "Transfer"
- }
- ]
- }
- },
- "model": {
- "description": "These are the options for the workflow's LLM.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/AnthropicModel",
- "title": "Anthropic"
- },
- {
- "$ref": "#/components/schemas/AnyscaleModel",
- "title": "Anyscale"
- },
- {
- "$ref": "#/components/schemas/CerebrasModel",
- "title": "Cerebras"
- },
- {
- "$ref": "#/components/schemas/CustomLLMModel",
- "title": "CustomLLM"
- },
- {
- "$ref": "#/components/schemas/DeepInfraModel",
- "title": "DeepInfra"
- },
- {
- "$ref": "#/components/schemas/DeepSeekModel",
- "title": "DeepSeek"
- },
- {
- "$ref": "#/components/schemas/GoogleModel",
- "title": "Google"
- },
- {
- "$ref": "#/components/schemas/GroqModel",
- "title": "Groq"
- },
- {
- "$ref": "#/components/schemas/InflectionAIModel",
- "title": "InflectionAI"
- },
- {
- "$ref": "#/components/schemas/OpenAIModel",
- "title": "OpenAI"
- },
- {
- "$ref": "#/components/schemas/OpenRouterModel",
- "title": "OpenRouter"
- },
- {
- "$ref": "#/components/schemas/PerplexityAIModel",
- "title": "PerplexityAI"
- },
- {
- "$ref": "#/components/schemas/TogetherAIModel",
- "title": "Together"
- },
- {
- "$ref": "#/components/schemas/XaiModel",
- "title": "XAI"
- }
- ]
- },
- "name": {
- "type": "string",
- "maxLength": 80
- },
- "edges": {
+ "toolIds": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/Edge"
+ "type": "string"
}
}
}
@@ -26532,7 +35037,7 @@
"rubric": {
"type": "string",
"description": "This is the rubric used by the AI scorer.",
- "maxLength": 1000
+ "maxLength": 10000
}
},
"required": [
@@ -26599,7 +35104,7 @@
"rubric": {
"type": "string",
"description": "This is the rubric used by the AI scorer.",
- "maxLength": 1000
+ "maxLength": 10000
}
},
"required": [
@@ -26798,69 +35303,6 @@
}
}
},
- "Metrics": {
- "type": "object",
- "properties": {
- "orgId": {
- "type": "string"
- },
- "rangeStart": {
- "type": "string"
- },
- "rangeEnd": {
- "type": "string"
- },
- "bill": {
- "type": "number"
- },
- "billWithinBillingLimit": {
- "type": "boolean"
- },
- "billDailyBreakdown": {
- "type": "object"
- },
- "callActive": {
- "type": "number"
- },
- "callActiveWithinConcurrencyLimit": {
- "type": "boolean"
- },
- "callMinutes": {
- "type": "number"
- },
- "callMinutesDailyBreakdown": {
- "type": "object"
- },
- "callMinutesAverage": {
- "type": "number"
- },
- "callMinutesAverageDailyBreakdown": {
- "type": "object"
- },
- "callCount": {
- "type": "number"
- },
- "callCountDailyBreakdown": {
- "type": "object"
- }
- },
- "required": [
- "orgId",
- "rangeStart",
- "rangeEnd",
- "bill",
- "billWithinBillingLimit",
- "billDailyBreakdown",
- "callActive",
- "callActiveWithinConcurrencyLimit",
- "callMinutes",
- "callMinutesDailyBreakdown",
- "callMinutesAverage",
- "callMinutesAverageDailyBreakdown",
- "callCount",
- "callCountDailyBreakdown"
- ]
- },
"TimeRange": {
"type": "object",
"properties": {
@@ -27389,7 +35831,11 @@
"enum": [
"trial",
"pay-as-you-go",
- "enterprise"
+ "enterprise",
+ "agency",
+ "startup",
+ "growth",
+ "scale"
]
},
"status": {
@@ -27641,6 +36087,10 @@
"type": "string",
"description": "This is the secret key used for signing JWT tokens for the org."
},
+ "minutesUsed": {
+ "type": "number",
+ "description": "This is the total number of call minutes used by this org across all time."
+ },
"name": {
"type": "string",
"description": "This is the name of the org. This is just for your own reference.",
@@ -28163,6 +36613,11 @@
"description": "This is not returned in the API.",
"maxLength": 10000
},
+ "fallbackIndex": {
+ "type": "number",
+ "minimum": 1,
+ "description": "This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order."
+ },
"id": {
"type": "string",
"description": "This is the unique identifier for the credential."
@@ -28240,10 +36695,13 @@
"models": {
"type": "array",
"enum": [
+ "gpt-4.1-2025-04-14",
+ "gpt-4.1-mini-2025-04-14",
+ "gpt-4.1-nano-2025-04-14",
"gpt-4o-2024-11-20",
"gpt-4o-2024-08-06",
- "gpt-4o-mini-2024-07-18",
"gpt-4o-2024-05-13",
+ "gpt-4o-mini-2024-07-18",
"gpt-4-turbo-2024-04-09",
"gpt-4-0125-preview",
"gpt-4-1106-preview",
@@ -28258,10 +36716,13 @@
"items": {
"type": "string",
"enum": [
+ "gpt-4.1-2025-04-14",
+ "gpt-4.1-mini-2025-04-14",
+ "gpt-4.1-nano-2025-04-14",
"gpt-4o-2024-11-20",
"gpt-4o-2024-08-06",
- "gpt-4o-mini-2024-07-18",
"gpt-4o-2024-05-13",
+ "gpt-4o-mini-2024-07-18",
"gpt-4-turbo-2024-04-09",
"gpt-4-0125-preview",
"gpt-4-1106-preview",
@@ -28518,6 +36979,11 @@
"type": "string",
"description": "Cloudflare Account Email."
},
+ "fallbackIndex": {
+ "type": "number",
+ "description": "This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.",
+ "minimum": 1
+ },
"id": {
"type": "string",
"description": "This is the unique identifier for the credential."
@@ -28570,6 +37036,10 @@
"format": "date-time",
"type": "string",
"description": "This is the OAuth2 access token expiration."
+ },
+ "refreshToken": {
+ "type": "string",
+ "description": "This is the OAuth2 refresh token."
}
}
},
@@ -28839,6 +37309,11 @@
"gcp"
]
},
+ "fallbackIndex": {
+ "type": "number",
+ "description": "This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.",
+ "minimum": 1
+ },
"id": {
"type": "string",
"description": "This is the unique identifier for the credential."
@@ -28871,13 +37346,13 @@
}
]
},
+ "region": {
+ "type": "string",
+ "description": "This is the region of the GCP resource.",
+ "maxLength": 40
+ },
"bucketPlan": {
- "description": "This is the bucket plan that can be provided to store call artifacts in GCP.",
- "allOf": [
- {
- "$ref": "#/components/schemas/BucketPlan"
- }
- ]
+ "$ref": "#/components/schemas/BucketPlan"
}
},
"required": [
@@ -29748,6 +38223,11 @@
"type": "string",
"description": "The path prefix for the uploaded recording. Ex. \"recordings/\""
},
+ "fallbackIndex": {
+ "type": "number",
+ "minimum": 1,
+ "description": "This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order."
+ },
"id": {
"type": "string",
"description": "This is the unique identifier for the credential."
@@ -29890,6 +38370,11 @@
],
"description": "This is for supabase storage."
},
+ "fallbackIndex": {
+ "type": "number",
+ "minimum": 1,
+ "description": "This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order."
+ },
"id": {
"type": "string",
"description": "This is the unique identifier for the credential."
@@ -30080,6 +38565,14 @@
"type": "string",
"description": "This is not returned in the API."
},
+ "apiKey": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "apiSecret": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
"id": {
"type": "string",
"description": "This is the unique identifier for the credential."
@@ -30110,7 +38603,6 @@
},
"required": [
"provider",
- "authToken",
"id",
"orgId",
"createdAt",
@@ -30473,6 +38965,57 @@
"updatedAt"
]
},
+ "GoHighLevelMCPCredential": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "ghl.oauth2-authorization"
+ ]
+ },
+ "authenticationSession": {
+ "description": "This is the authentication session for the credential.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Oauth2AuthenticationSession"
+ }
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "This is the unique identifier for the credential."
+ },
+ "orgId": {
+ "type": "string",
+ "description": "This is the unique identifier for the org that this credential belongs to."
+ },
+ "createdAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the credential was created."
+ },
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string",
+ "description": "This is the ISO 8601 date-time string of when the assistant was last updated."
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "authenticationSession",
+ "id",
+ "orgId",
+ "createdAt",
+ "updatedAt"
+ ]
+ },
"CreateCerebrasCredentialDTO": {
"type": "object",
"properties": {
@@ -30680,6 +39223,35 @@
"apiKey"
]
},
+ "CreateGoHighLevelMCPCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "enum": [
+ "ghl.oauth2-authorization"
+ ]
+ },
+ "authenticationSession": {
+ "description": "This is the authentication session for the credential.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Oauth2AuthenticationSession"
+ }
+ ]
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ },
+ "required": [
+ "provider",
+ "authenticationSession"
+ ]
+ },
"UpdateAnthropicCredentialDTO": {
"type": "object",
"properties": {
@@ -30768,6 +39340,11 @@
"description": "This is not returned in the API.",
"maxLength": 10000
},
+ "fallbackIndex": {
+ "type": "number",
+ "minimum": 1,
+ "description": "This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order."
+ },
"name": {
"type": "string",
"description": "This is the name of credential. This is just for your reference.",
@@ -30813,10 +39390,13 @@
"models": {
"type": "array",
"enum": [
+ "gpt-4.1-2025-04-14",
+ "gpt-4.1-mini-2025-04-14",
+ "gpt-4.1-nano-2025-04-14",
"gpt-4o-2024-11-20",
"gpt-4o-2024-08-06",
- "gpt-4o-mini-2024-07-18",
"gpt-4o-2024-05-13",
+ "gpt-4o-mini-2024-07-18",
"gpt-4-turbo-2024-04-09",
"gpt-4-0125-preview",
"gpt-4-1106-preview",
@@ -30831,10 +39411,13 @@
"items": {
"type": "string",
"enum": [
+ "gpt-4.1-2025-04-14",
+ "gpt-4.1-mini-2025-04-14",
+ "gpt-4.1-nano-2025-04-14",
"gpt-4o-2024-11-20",
"gpt-4o-2024-08-06",
- "gpt-4o-mini-2024-07-18",
"gpt-4o-2024-05-13",
+ "gpt-4o-mini-2024-07-18",
"gpt-4-turbo-2024-04-09",
"gpt-4-0125-preview",
"gpt-4-1106-preview",
@@ -30959,6 +39542,11 @@
"type": "string",
"description": "Cloudflare Account Email."
},
+ "fallbackIndex": {
+ "type": "number",
+ "description": "This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.",
+ "minimum": 1
+ },
"name": {
"type": "string",
"description": "This is the name of credential. This is just for your reference.",
@@ -31067,6 +39655,11 @@
"UpdateGcpCredentialDTO": {
"type": "object",
"properties": {
+ "fallbackIndex": {
+ "type": "number",
+ "description": "This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.",
+ "minimum": 1
+ },
"name": {
"type": "string",
"description": "This is the name of credential. This is just for your reference.",
@@ -31081,13 +39674,13 @@
}
]
},
+ "region": {
+ "type": "string",
+ "description": "This is the region of the GCP resource.",
+ "maxLength": 40
+ },
"bucketPlan": {
- "description": "This is the bucket plan that can be provided to store call artifacts in GCP.",
- "allOf": [
- {
- "$ref": "#/components/schemas/BucketPlan"
- }
- ]
+ "$ref": "#/components/schemas/BucketPlan"
}
}
},
@@ -31392,6 +39985,11 @@
"type": "string",
"description": "The path prefix for the uploaded recording. Ex. \"recordings/\""
},
+ "fallbackIndex": {
+ "type": "number",
+ "minimum": 1,
+ "description": "This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order."
+ },
"name": {
"type": "string",
"description": "This is the name of credential. This is just for your reference.",
@@ -31433,6 +40031,11 @@
"UpdateSupabaseCredentialDTO": {
"type": "object",
"properties": {
+ "fallbackIndex": {
+ "type": "number",
+ "minimum": 1,
+ "description": "This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order."
+ },
"name": {
"type": "string",
"description": "This is the name of credential. This is just for your reference.",
@@ -31496,6 +40099,14 @@
"type": "string",
"description": "This is not returned in the API."
},
+ "apiKey": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
+ "apiSecret": {
+ "type": "string",
+ "description": "This is not returned in the API."
+ },
"name": {
"type": "string",
"description": "This is the name of credential. This is just for your reference.",
@@ -31616,6 +40227,25 @@
}
}
},
+ "UpdateGoHighLevelMCPCredentialDTO": {
+ "type": "object",
+ "properties": {
+ "authenticationSession": {
+ "description": "This is the authentication session for the credential.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Oauth2AuthenticationSession"
+ }
+ ]
+ },
+ "name": {
+ "type": "string",
+ "description": "This is the name of credential. This is just for your reference.",
+ "minLength": 1,
+ "maxLength": 40
+ }
+ }
+ },
"CredentialSessionResponse": {
"type": "object",
"properties": {
@@ -31927,6 +40557,106 @@
"type"
]
},
+ "GoHighLevelCalendarAvailabilityToolProviderDetails": {
+ "type": "object",
+ "properties": {
+ "templateUrl": {
+ "type": "string",
+ "description": "This is the Template URL or the Snapshot URL corresponding to the Template."
+ },
+ "setupInstructions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ToolTemplateSetup"
+ }
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "gohighlevel.calendar.availability.check"
+ ],
+ "description": "The type of tool. \"gohighlevel.calendar.availability.check\" for GoHighLevel Calendar availability check tool."
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "GoHighLevelCalendarEventCreateToolProviderDetails": {
+ "type": "object",
+ "properties": {
+ "templateUrl": {
+ "type": "string",
+ "description": "This is the Template URL or the Snapshot URL corresponding to the Template."
+ },
+ "setupInstructions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ToolTemplateSetup"
+ }
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "gohighlevel.calendar.event.create"
+ ],
+ "description": "The type of tool. \"gohighlevel.calendar.event.create\" for GoHighLevel Calendar event create tool."
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "GoHighLevelContactCreateToolProviderDetails": {
+ "type": "object",
+ "properties": {
+ "templateUrl": {
+ "type": "string",
+ "description": "This is the Template URL or the Snapshot URL corresponding to the Template."
+ },
+ "setupInstructions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ToolTemplateSetup"
+ }
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "gohighlevel.contact.create"
+ ],
+ "description": "The type of tool. \"gohighlevel.contact.create\" for GoHighLevel contact create tool."
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "GoHighLevelContactGetToolProviderDetails": {
+ "type": "object",
+ "properties": {
+ "templateUrl": {
+ "type": "string",
+ "description": "This is the Template URL or the Snapshot URL corresponding to the Template."
+ },
+ "setupInstructions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ToolTemplateSetup"
+ }
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "gohighlevel.contact.get"
+ ],
+ "description": "The type of tool. \"gohighlevel.contact.get\" for GoHighLevel contact get tool."
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
"ToolTemplateMetadata": {
"type": "object",
"properties": {
@@ -31946,6 +40676,18 @@
"properties": {
"details": {
"oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateApiRequestToolDTO",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateBashToolDTO",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateComputerToolDTO",
+ "title": "ComputerTool"
+ },
{
"$ref": "#/components/schemas/CreateDtmfToolDTO",
"title": "DtmfTool"
@@ -31954,25 +40696,29 @@
"$ref": "#/components/schemas/CreateEndCallToolDTO",
"title": "EndCallTool"
},
- {
- "$ref": "#/components/schemas/CreateVoicemailToolDTO",
- "title": "VoicemailTool"
- },
{
"$ref": "#/components/schemas/CreateFunctionToolDTO",
"title": "FunctionTool"
},
{
- "$ref": "#/components/schemas/CreateGhlToolDTO",
- "title": "GhlTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
},
{
- "$ref": "#/components/schemas/CreateMakeToolDTO",
- "title": "MakeTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
},
{
- "$ref": "#/components/schemas/CreateTransferCallToolDTO",
- "title": "TransferCallTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
},
{
"$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
@@ -31981,6 +40727,30 @@
{
"$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
"title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateQueryToolDTO",
+ "title": "QueryTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
+ "title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmsToolDTO",
+ "title": "SmsTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTextEditorToolDTO",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTransferCallToolDTO",
+ "title": "TransferCallTool"
}
]
},
@@ -32005,6 +40775,22 @@
{
"$ref": "#/components/schemas/GoogleSheetsRowAppendToolProviderDetails",
"title": "GoogleSheetsRowAppendToolProviderDetails"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelCalendarAvailabilityToolProviderDetails",
+ "title": "GoHighLevelCalendarAvailabilityToolProviderDetails"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelCalendarEventCreateToolProviderDetails",
+ "title": "GoHighLevelCalendarEventCreateToolProviderDetails"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelContactCreateToolProviderDetails",
+ "title": "GoHighLevelContactCreateToolProviderDetails"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelContactGetToolProviderDetails",
+ "title": "GoHighLevelContactGetToolProviderDetails"
}
]
},
@@ -32049,6 +40835,18 @@
"properties": {
"details": {
"oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateApiRequestToolDTO",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateBashToolDTO",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateComputerToolDTO",
+ "title": "ComputerTool"
+ },
{
"$ref": "#/components/schemas/CreateDtmfToolDTO",
"title": "DtmfTool"
@@ -32057,25 +40855,29 @@
"$ref": "#/components/schemas/CreateEndCallToolDTO",
"title": "EndCallTool"
},
- {
- "$ref": "#/components/schemas/CreateVoicemailToolDTO",
- "title": "VoicemailTool"
- },
{
"$ref": "#/components/schemas/CreateFunctionToolDTO",
"title": "FunctionTool"
},
{
- "$ref": "#/components/schemas/CreateGhlToolDTO",
- "title": "GhlTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
},
{
- "$ref": "#/components/schemas/CreateMakeToolDTO",
- "title": "MakeTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
},
{
- "$ref": "#/components/schemas/CreateTransferCallToolDTO",
- "title": "TransferCallTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
},
{
"$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
@@ -32084,6 +40886,30 @@
{
"$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
"title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateQueryToolDTO",
+ "title": "QueryTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
+ "title": "SlackSendMessageTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateSmsToolDTO",
+ "title": "SmsTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTextEditorToolDTO",
+ "title": "TextEditorTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTransferCallToolDTO",
+ "title": "TransferCallTool"
}
]
},
@@ -32108,6 +40934,22 @@
{
"$ref": "#/components/schemas/GoogleSheetsRowAppendToolProviderDetails",
"title": "GoogleSheetsRowAppendToolProviderDetails"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelCalendarAvailabilityToolProviderDetails",
+ "title": "GoHighLevelCalendarAvailabilityToolProviderDetails"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelCalendarEventCreateToolProviderDetails",
+ "title": "GoHighLevelCalendarEventCreateToolProviderDetails"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelContactCreateToolProviderDetails",
+ "title": "GoHighLevelContactCreateToolProviderDetails"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelContactGetToolProviderDetails",
+ "title": "GoHighLevelContactGetToolProviderDetails"
}
]
},
@@ -32174,6 +41016,18 @@
"properties": {
"details": {
"oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateApiRequestToolDTO",
+ "title": "ApiRequestTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateBashToolDTO",
+ "title": "BashTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateComputerToolDTO",
+ "title": "ComputerTool"
+ },
{
"$ref": "#/components/schemas/CreateDtmfToolDTO",
"title": "DtmfTool"
@@ -32182,33 +41036,61 @@
"$ref": "#/components/schemas/CreateEndCallToolDTO",
"title": "EndCallTool"
},
- {
- "$ref": "#/components/schemas/CreateVoicemailToolDTO",
- "title": "VoicemailTool"
- },
{
"$ref": "#/components/schemas/CreateFunctionToolDTO",
"title": "FunctionTool"
},
{
- "$ref": "#/components/schemas/CreateGhlToolDTO",
- "title": "GhlTool"
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarAvailabilityToolDTO",
+ "title": "GoHighLevelCalendarAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelCalendarEventCreateToolDTO",
+ "title": "GoHighLevelCalendarEventCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactCreateToolDTO",
+ "title": "GoHighLevelContactCreateTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoHighLevelContactGetToolDTO",
+ "title": "GoHighLevelContactGetTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCheckAvailabilityToolDTO",
+ "title": "GoogleCalendarCheckAvailabilityTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
+ "title": "GoogleCalendarCreateEventTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
+ "title": "GoogleSheetsRowAppendTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateMcpToolDTO",
+ "title": "McpTool"
+ },
+ {
+ "$ref": "#/components/schemas/CreateQueryToolDTO",
+ "title": "QueryTool"
},
{
- "$ref": "#/components/schemas/CreateMakeToolDTO",
- "title": "MakeTool"
+ "$ref": "#/components/schemas/CreateSlackSendMessageToolDTO",
+ "title": "SlackSendMessageTool"
},
{
- "$ref": "#/components/schemas/CreateTransferCallToolDTO",
- "title": "TransferCallTool"
+ "$ref": "#/components/schemas/CreateSmsToolDTO",
+ "title": "SmsTool"
},
{
- "$ref": "#/components/schemas/CreateGoogleCalendarCreateEventToolDTO",
- "title": "GoogleCalendarCreateEventTool"
+ "$ref": "#/components/schemas/CreateTextEditorToolDTO",
+ "title": "TextEditorTool"
},
{
- "$ref": "#/components/schemas/CreateGoogleSheetsRowAppendToolDTO",
- "title": "GoogleSheetsRowAppendTool"
+ "$ref": "#/components/schemas/CreateTransferCallToolDTO",
+ "title": "TransferCallTool"
}
]
},
@@ -32233,6 +41115,22 @@
{
"$ref": "#/components/schemas/GoogleSheetsRowAppendToolProviderDetails",
"title": "GoogleSheetsRowAppendToolProviderDetails"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelCalendarAvailabilityToolProviderDetails",
+ "title": "GoHighLevelCalendarAvailabilityToolProviderDetails"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelCalendarEventCreateToolProviderDetails",
+ "title": "GoHighLevelCalendarEventCreateToolProviderDetails"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelContactCreateToolProviderDetails",
+ "title": "GoHighLevelContactCreateToolProviderDetails"
+ },
+ {
+ "$ref": "#/components/schemas/GoHighLevelContactGetToolProviderDetails",
+ "title": "GoHighLevelContactGetToolProviderDetails"
}
]
},
@@ -32527,6 +41425,31 @@
"ClientMessageWorkflowNodeStarted": {
"type": "object",
"properties": {
+ "phoneNumber": {
+ "description": "This is the phone number that the message is associated with.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
+ "title": "ByoPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioPhoneNumberDTO",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonagePhoneNumberDTO",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
+ }
+ ]
+ },
"type": {
"type": "string",
"description": "This is the type of the message. \"workflow.node.started\" is sent when the active node changes.",
@@ -32534,6 +41457,34 @@
"workflow.node.started"
]
},
+ "timestamp": {
+ "type": "number",
+ "description": "This is the timestamp of the message."
+ },
+ "call": {
+ "description": "This is the call that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Call"
+ }
+ ]
+ },
+ "customer": {
+ "description": "This is the customer that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ }
+ ]
+ },
+ "assistant": {
+ "description": "This is the assistant that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateAssistantDTO"
+ }
+ ]
+ },
"node": {
"type": "object",
"description": "This is the active node."
@@ -32547,6 +41498,31 @@
"ClientMessageConversationUpdate": {
"type": "object",
"properties": {
+ "phoneNumber": {
+ "description": "This is the phone number that the message is associated with.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
+ "title": "ByoPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioPhoneNumberDTO",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonagePhoneNumberDTO",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
+ }
+ ]
+ },
"type": {
"type": "string",
"description": "This is the type of the message. \"conversation-update\" is sent when an update is committed to the conversation history.",
@@ -32588,6 +41564,34 @@
"items": {
"$ref": "#/components/schemas/OpenAIMessage"
}
+ },
+ "timestamp": {
+ "type": "number",
+ "description": "This is the timestamp of the message."
+ },
+ "call": {
+ "description": "This is the call that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Call"
+ }
+ ]
+ },
+ "customer": {
+ "description": "This is the customer that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ }
+ ]
+ },
+ "assistant": {
+ "description": "This is the assistant that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateAssistantDTO"
+ }
+ ]
}
},
"required": [
@@ -32598,12 +41602,65 @@
"ClientMessageHang": {
"type": "object",
"properties": {
+ "phoneNumber": {
+ "description": "This is the phone number that the message is associated with.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
+ "title": "ByoPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioPhoneNumberDTO",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonagePhoneNumberDTO",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
+ }
+ ]
+ },
"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"
]
+ },
+ "timestamp": {
+ "type": "number",
+ "description": "This is the timestamp of the message."
+ },
+ "call": {
+ "description": "This is the call that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Call"
+ }
+ ]
+ },
+ "customer": {
+ "description": "This is the customer that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ }
+ ]
+ },
+ "assistant": {
+ "description": "This is the assistant that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateAssistantDTO"
+ }
+ ]
}
},
"required": [
@@ -32613,6 +41670,31 @@
"ClientMessageMetadata": {
"type": "object",
"properties": {
+ "phoneNumber": {
+ "description": "This is the phone number that the message is associated with.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
+ "title": "ByoPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioPhoneNumberDTO",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonagePhoneNumberDTO",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
+ }
+ ]
+ },
"type": {
"type": "string",
"description": "This is the type of the message. \"metadata\" is sent to forward metadata to the client.",
@@ -32620,6 +41702,34 @@
"metadata"
]
},
+ "timestamp": {
+ "type": "number",
+ "description": "This is the timestamp of the message."
+ },
+ "call": {
+ "description": "This is the call that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Call"
+ }
+ ]
+ },
+ "customer": {
+ "description": "This is the customer that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ }
+ ]
+ },
+ "assistant": {
+ "description": "This is the assistant that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateAssistantDTO"
+ }
+ ]
+ },
"metadata": {
"type": "string",
"description": "This is the metadata content"
@@ -32633,6 +41743,31 @@
"ClientMessageModelOutput": {
"type": "object",
"properties": {
+ "phoneNumber": {
+ "description": "This is the phone number that the message is associated with.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
+ "title": "ByoPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioPhoneNumberDTO",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonagePhoneNumberDTO",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
+ }
+ ]
+ },
"type": {
"type": "string",
"description": "This is the type of the message. \"model-output\" is sent as the model outputs tokens.",
@@ -32640,6 +41775,34 @@
"model-output"
]
},
+ "timestamp": {
+ "type": "number",
+ "description": "This is the timestamp of the message."
+ },
+ "call": {
+ "description": "This is the call that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Call"
+ }
+ ]
+ },
+ "customer": {
+ "description": "This is the customer that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ }
+ ]
+ },
+ "assistant": {
+ "description": "This is the assistant that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateAssistantDTO"
+ }
+ ]
+ },
"output": {
"type": "object",
"description": "This is the output of the model. It can be a token or tool call."
@@ -32653,6 +41816,31 @@
"ClientMessageSpeechUpdate": {
"type": "object",
"properties": {
+ "phoneNumber": {
+ "description": "This is the phone number that the message is associated with.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
+ "title": "ByoPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioPhoneNumberDTO",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonagePhoneNumberDTO",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
+ }
+ ]
+ },
"type": {
"type": "string",
"description": "This is the type of the message. \"speech-update\" is sent whenever assistant or user start or stop speaking.",
@@ -32679,6 +41867,34 @@
"turn": {
"type": "number",
"description": "This is the turn number of the speech update (0-indexed)."
+ },
+ "timestamp": {
+ "type": "number",
+ "description": "This is the timestamp of the message."
+ },
+ "call": {
+ "description": "This is the call that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Call"
+ }
+ ]
+ },
+ "customer": {
+ "description": "This is the customer that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ }
+ ]
+ },
+ "assistant": {
+ "description": "This is the assistant that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateAssistantDTO"
+ }
+ ]
}
},
"required": [
@@ -32690,6 +41906,31 @@
"ClientMessageTranscript": {
"type": "object",
"properties": {
+ "phoneNumber": {
+ "description": "This is the phone number that the message is associated with.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
+ "title": "ByoPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioPhoneNumberDTO",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonagePhoneNumberDTO",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
+ }
+ ]
+ },
"type": {
"type": "string",
"description": "This is the type of the message. \"transcript\" is sent as transcriber outputs partial or final transcript.",
@@ -32698,6 +41939,34 @@
"transcript[transcriptType=\"final\"]"
]
},
+ "timestamp": {
+ "type": "number",
+ "description": "This is the timestamp of the message."
+ },
+ "call": {
+ "description": "This is the call that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Call"
+ }
+ ]
+ },
+ "customer": {
+ "description": "This is the customer that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ }
+ ]
+ },
+ "assistant": {
+ "description": "This is the assistant that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateAssistantDTO"
+ }
+ ]
+ },
"role": {
"type": "string",
"description": "This is the role for which the transcript is for.",
@@ -32726,55 +41995,34 @@
"transcript"
]
},
- "ToolCallFunction": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "This is the name of the function the model called."
- },
- "arguments": {
- "type": "object",
- "description": "These are the arguments that the function was called with."
- }
- },
- "required": [
- "name",
- "arguments"
- ]
- },
- "ToolCall": {
+ "ClientMessageToolCalls": {
"type": "object",
"properties": {
- "type": {
- "type": "string",
- "description": "This is the type of tool the model called.",
- "enum": [
- "function"
- ]
- },
- "function": {
- "description": "This is the function the model called.",
- "allOf": [
+ "phoneNumber": {
+ "description": "This is the phone number that the message is associated with.",
+ "oneOf": [
{
- "$ref": "#/components/schemas/ToolCallFunction"
+ "$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
+ "title": "ByoPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioPhoneNumberDTO",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonagePhoneNumberDTO",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
}
]
},
- "id": {
- "type": "string",
- "description": "This is the unique identifier for the tool call."
- }
- },
- "required": [
- "type",
- "function",
- "id"
- ]
- },
- "ClientMessageToolCalls": {
- "type": "object",
- "properties": {
"type": {
"type": "string",
"description": "This is the type of the message. \"tool-calls\" is sent to call a tool.",
@@ -32818,6 +42066,34 @@
]
}
},
+ "timestamp": {
+ "type": "number",
+ "description": "This is the timestamp of the message."
+ },
+ "call": {
+ "description": "This is the call that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Call"
+ }
+ ]
+ },
+ "customer": {
+ "description": "This is the customer that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ }
+ ]
+ },
+ "assistant": {
+ "description": "This is the assistant that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateAssistantDTO"
+ }
+ ]
+ },
"toolCallList": {
"description": "This is the list of tool calls that the model is requesting.",
"type": "array",
@@ -32834,6 +42110,31 @@
"ClientMessageToolCallsResult": {
"type": "object",
"properties": {
+ "phoneNumber": {
+ "description": "This is the phone number that the message is associated with.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
+ "title": "ByoPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioPhoneNumberDTO",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonagePhoneNumberDTO",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
+ }
+ ]
+ },
"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.",
@@ -32841,6 +42142,34 @@
"tool-calls-result"
]
},
+ "timestamp": {
+ "type": "number",
+ "description": "This is the timestamp of the message."
+ },
+ "call": {
+ "description": "This is the call that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Call"
+ }
+ ]
+ },
+ "customer": {
+ "description": "This is the customer that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ }
+ ]
+ },
+ "assistant": {
+ "description": "This is the assistant that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateAssistantDTO"
+ }
+ ]
+ },
"toolCallResult": {
"type": "object",
"description": "This is the result of the tool call."
@@ -32854,6 +42183,31 @@
"ClientMessageTransferUpdate": {
"type": "object",
"properties": {
+ "phoneNumber": {
+ "description": "This is the phone number that the message is associated with.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
+ "title": "ByoPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioPhoneNumberDTO",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonagePhoneNumberDTO",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
+ }
+ ]
+ },
"type": {
"type": "string",
"description": "This is the type of the message. \"transfer-update\" is sent whenever a transfer happens.",
@@ -32868,10 +42222,6 @@
"$ref": "#/components/schemas/TransferDestinationAssistant",
"title": "Assistant"
},
- {
- "$ref": "#/components/schemas/TransferDestinationStep",
- "title": "Step"
- },
{
"$ref": "#/components/schemas/TransferDestinationNumber",
"title": "Number"
@@ -32882,6 +42232,34 @@
}
]
},
+ "timestamp": {
+ "type": "number",
+ "description": "This is the timestamp of the message."
+ },
+ "call": {
+ "description": "This is the call that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Call"
+ }
+ ]
+ },
+ "customer": {
+ "description": "This is the customer that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ }
+ ]
+ },
+ "assistant": {
+ "description": "This is the assistant that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateAssistantDTO"
+ }
+ ]
+ },
"toAssistant": {
"description": "This is the assistant that the call is being transferred to. This is only sent if `destination.type` is \"assistant\".",
"allOf": [
@@ -32914,12 +42292,65 @@
"ClientMessageUserInterrupted": {
"type": "object",
"properties": {
+ "phoneNumber": {
+ "description": "This is the phone number that the message is associated with.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
+ "title": "ByoPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioPhoneNumberDTO",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonagePhoneNumberDTO",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
+ }
+ ]
+ },
"type": {
"type": "string",
"description": "This is the type of the message. \"user-interrupted\" is sent when the user interrupts the assistant.",
"enum": [
"user-interrupted"
]
+ },
+ "timestamp": {
+ "type": "number",
+ "description": "This is the timestamp of the message."
+ },
+ "call": {
+ "description": "This is the call that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Call"
+ }
+ ]
+ },
+ "customer": {
+ "description": "This is the customer that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ }
+ ]
+ },
+ "assistant": {
+ "description": "This is the assistant that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateAssistantDTO"
+ }
+ ]
}
},
"required": [
@@ -32929,6 +42360,31 @@
"ClientMessageLanguageChangeDetected": {
"type": "object",
"properties": {
+ "phoneNumber": {
+ "description": "This is the phone number that the message is associated with.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
+ "title": "ByoPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioPhoneNumberDTO",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonagePhoneNumberDTO",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
+ }
+ ]
+ },
"type": {
"type": "string",
"description": "This is the type of the message. \"language-change-detected\" is sent when the transcriber is automatically switched based on the detected language.",
@@ -32936,6 +42392,34 @@
"language-change-detected"
]
},
+ "timestamp": {
+ "type": "number",
+ "description": "This is the timestamp of the message."
+ },
+ "call": {
+ "description": "This is the call that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Call"
+ }
+ ]
+ },
+ "customer": {
+ "description": "This is the customer that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ }
+ ]
+ },
+ "assistant": {
+ "description": "This is the assistant that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateAssistantDTO"
+ }
+ ]
+ },
"language": {
"type": "string",
"description": "This is the language the transcriber is switched to."
@@ -32949,6 +42433,31 @@
"ClientMessageVoiceInput": {
"type": "object",
"properties": {
+ "phoneNumber": {
+ "description": "This is the phone number that the message is associated with.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
+ "title": "ByoPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioPhoneNumberDTO",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonagePhoneNumberDTO",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
+ }
+ ]
+ },
"type": {
"type": "string",
"description": "This is the type of the message. \"voice-input\" is sent when a generation is requested from voice provider.",
@@ -32956,6 +42465,34 @@
"voice-input"
]
},
+ "timestamp": {
+ "type": "number",
+ "description": "This is the timestamp of the message."
+ },
+ "call": {
+ "description": "This is the call that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Call"
+ }
+ ]
+ },
+ "customer": {
+ "description": "This is the customer that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ }
+ ]
+ },
+ "assistant": {
+ "description": "This is the assistant that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateAssistantDTO"
+ }
+ ]
+ },
"input": {
"type": "string",
"description": "This is the voice input content"
@@ -33035,7 +42572,7 @@
"type": "object",
"properties": {
"phoneNumber": {
- "description": "This is the phone number associated with the call.\n\nThis matches one of the following:\n- `call.phoneNumber`,\n- `call.phoneNumberId`.",
+ "description": "This is the phone number that the message is associated with.",
"oneOf": [
{
"$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
@@ -33052,6 +42589,10 @@
{
"$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
"title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
}
]
},
@@ -33064,7 +42605,7 @@
},
"timestamp": {
"type": "number",
- "description": "This is the timestamp of when the message was sent in milliseconds since Unix Epoch."
+ "description": "This is the timestamp of the message."
},
"artifact": {
"description": "This is a live version of the `call.artifact`.\n\nThis matches what is stored on `call.artifact` after the call.",
@@ -33075,7 +42616,7 @@
]
},
"assistant": {
- "description": "This is the assistant that is currently active. This is provided for convenience.\n\nThis matches one of the following:\n- `call.assistant`,\n- `call.assistantId`,\n- `call.squad[n].assistant`,\n- `call.squad[n].assistantId`,\n- `call.squadId->[n].assistant`,\n- `call.squadId->[n].assistantId`.",
+ "description": "This is the assistant that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateAssistantDTO"
@@ -33083,7 +42624,7 @@
]
},
"customer": {
- "description": "This is the customer associated with the call.\n\nThis matches one of the following:\n- `call.customer`,\n- `call.customerId`.",
+ "description": "This is the customer that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateCustomerDTO"
@@ -33091,12 +42632,20 @@
]
},
"call": {
- "description": "This is the call object.\n\nThis matches what was returned in POST /call.\n\nNote: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.",
+ "description": "This is the call that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/Call"
}
]
+ },
+ "chat": {
+ "description": "This is the chat object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Chat"
+ }
+ ]
}
},
"required": [
@@ -33107,7 +42656,7 @@
"type": "object",
"properties": {
"phoneNumber": {
- "description": "This is the phone number associated with the call.\n\nThis matches one of the following:\n- `call.phoneNumber`,\n- `call.phoneNumberId`.",
+ "description": "This is the phone number that the message is associated with.",
"oneOf": [
{
"$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
@@ -33124,6 +42673,10 @@
{
"$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
"title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
}
]
},
@@ -33171,7 +42724,7 @@
},
"timestamp": {
"type": "number",
- "description": "This is the timestamp of when the message was sent in milliseconds since Unix Epoch."
+ "description": "This is the timestamp of the message."
},
"artifact": {
"description": "This is a live version of the `call.artifact`.\n\nThis matches what is stored on `call.artifact` after the call.",
@@ -33182,7 +42735,7 @@
]
},
"assistant": {
- "description": "This is the assistant that is currently active. This is provided for convenience.\n\nThis matches one of the following:\n- `call.assistant`,\n- `call.assistantId`,\n- `call.squad[n].assistant`,\n- `call.squad[n].assistantId`,\n- `call.squadId->[n].assistant`,\n- `call.squadId->[n].assistantId`.",
+ "description": "This is the assistant that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateAssistantDTO"
@@ -33190,7 +42743,7 @@
]
},
"customer": {
- "description": "This is the customer associated with the call.\n\nThis matches one of the following:\n- `call.customer`,\n- `call.customerId`.",
+ "description": "This is the customer that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateCustomerDTO"
@@ -33198,12 +42751,20 @@
]
},
"call": {
- "description": "This is the call object.\n\nThis matches what was returned in POST /call.\n\nNote: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.",
+ "description": "This is the call that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/Call"
}
]
+ },
+ "chat": {
+ "description": "This is the chat object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Chat"
+ }
+ ]
}
},
"required": [
@@ -33215,7 +42776,7 @@
"type": "object",
"properties": {
"phoneNumber": {
- "description": "This is the phone number associated with the call.\n\nThis matches one of the following:\n- `call.phoneNumber`,\n- `call.phoneNumberId`.",
+ "description": "This is the phone number that the message is associated with.",
"oneOf": [
{
"$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
@@ -33232,6 +42793,10 @@
{
"$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
"title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
}
]
},
@@ -33253,8 +42818,9 @@
"assistant-request-returned-invalid-assistant",
"assistant-request-returned-no-assistant",
"assistant-request-returned-forwarding-phone-number",
- "call.start.error-get-org",
- "call.start.error-get-subscription",
+ "scheduled-call-deleted",
+ "call.start.error-vapifault-get-org",
+ "call.start.error-vapifault-get-subscription",
"call.start.error-get-assistant",
"call.start.error-get-phone-number",
"call.start.error-get-customer",
@@ -33262,6 +42828,11 @@
"call.start.error-vapi-number-international",
"call.start.error-vapi-number-outbound-daily-limit",
"call.start.error-get-transport",
+ "call.start.error-subscription-wallet-does-not-exist",
+ "call.start.error-subscription-frozen",
+ "call.start.error-subscription-insufficient-credits",
+ "call.start.error-subscription-upgrade-failed",
+ "call.start.error-subscription-concurrency-limit-reached",
"assistant-not-valid",
"database-error",
"assistant-not-found",
@@ -33329,7 +42900,6 @@
"call.in-progress.error-vapifault-azure-speech-transcriber-failed",
"call.in-progress.error-pipeline-no-available-llm-model",
"worker-shutdown",
- "unknown-error",
"vonage-disconnected",
"vonage-failed-to-connect-call",
"vonage-completed",
@@ -33339,6 +42909,9 @@
"call.in-progress.error-vapifault-transport-never-connected",
"call.in-progress.error-vapifault-transport-connected-but-call-not-active",
"call.in-progress.error-vapifault-call-started-but-connection-to-transport-missing",
+ "call.in-progress.error-vapifault-worker-died",
+ "call.in-progress.twilio-completed-call",
+ "call.in-progress.sip-completed-call",
"call.in-progress.error-vapifault-openai-llm-failed",
"call.in-progress.error-vapifault-azure-openai-llm-failed",
"call.in-progress.error-vapifault-groq-llm-failed",
@@ -33348,6 +42921,7 @@
"call.in-progress.error-vapifault-inflection-ai-llm-failed",
"call.in-progress.error-vapifault-cerebras-llm-failed",
"call.in-progress.error-vapifault-deep-seek-llm-failed",
+ "call.in-progress.error-vapifault-chat-pipeline-failed-to-start",
"pipeline-error-openai-400-bad-request-validation-failed",
"pipeline-error-openai-401-unauthorized",
"pipeline-error-openai-401-incorrect-api-key",
@@ -33615,6 +43189,7 @@
"pipeline-error-cartesia-socket-hang-up",
"pipeline-error-cartesia-requested-payment",
"pipeline-error-cartesia-500-server-error",
+ "pipeline-error-cartesia-502-server-error",
"pipeline-error-cartesia-503-server-error",
"pipeline-error-cartesia-522-server-error",
"call.in-progress.error-vapifault-cartesia-socket-hang-up",
@@ -33635,6 +43210,7 @@
"pipeline-error-eleven-labs-invalid-api-key",
"pipeline-error-eleven-labs-invalid-voice-samples",
"pipeline-error-eleven-labs-voice-disabled-by-owner",
+ "pipeline-error-eleven-labs-vapi-voice-disabled-by-owner",
"pipeline-error-eleven-labs-blocked-account-in-probation",
"pipeline-error-eleven-labs-blocked-content-against-their-policy",
"pipeline-error-eleven-labs-missing-samples-for-voice-clone",
@@ -33643,6 +43219,7 @@
"pipeline-error-eleven-labs-max-character-limit-exceeded",
"pipeline-error-eleven-labs-blocked-voice-potentially-against-terms-of-service-and-awaiting-verification",
"pipeline-error-eleven-labs-500-server-error",
+ "pipeline-error-eleven-labs-503-server-error",
"call.in-progress.error-vapifault-eleven-labs-voice-not-found",
"call.in-progress.error-vapifault-eleven-labs-quota-exceeded",
"call.in-progress.error-vapifault-eleven-labs-unauthorized-access",
@@ -33664,6 +43241,7 @@
"call.in-progress.error-vapifault-eleven-labs-max-character-limit-exceeded",
"call.in-progress.error-vapifault-eleven-labs-blocked-voice-potentially-against-terms-of-service-and-awaiting-verification",
"call.in-progress.error-providerfault-eleven-labs-500-server-error",
+ "call.in-progress.error-providerfault-eleven-labs-503-server-error",
"pipeline-error-playht-request-timed-out",
"pipeline-error-playht-invalid-voice",
"pipeline-error-playht-unexpected-error",
@@ -33699,6 +43277,7 @@
"pipeline-error-deepgram-returning-500-invalid-json",
"pipeline-error-deepgram-returning-502-network-error",
"pipeline-error-deepgram-returning-502-bad-gateway-ehostunreach",
+ "pipeline-error-deepgram-returning-econnreset",
"call.in-progress.error-vapifault-deepgram-returning-400-no-such-model-language-tier-combination",
"call.in-progress.error-vapifault-deepgram-returning-401-invalid-credentials",
"call.in-progress.error-vapifault-deepgram-returning-404-not-found",
@@ -33717,6 +43296,7 @@
"assistant-forwarded-call",
"assistant-join-timed-out",
"call.in-progress.error-assistant-did-not-receive-customer-audio",
+ "call.in-progress.error-transfer-failed",
"customer-busy",
"customer-ended-call",
"customer-did-not-answer",
@@ -33726,9 +43306,16 @@
"phone-call-provider-closed-websocket",
"call.forwarding.operator-busy",
"silence-timed-out",
- "call.in-progress.error-sip-telephony-provider-failed-to-connect-call",
+ "call.in-progress.error-sip-inbound-call-failed-to-connect",
+ "call.in-progress.error-providerfault-outbound-sip-403-forbidden",
+ "call.in-progress.error-providerfault-outbound-sip-407-proxy-authentication-required",
+ "call.in-progress.error-providerfault-outbound-sip-503-service-unavailable",
+ "call.in-progress.error-providerfault-outbound-sip-480-temporarily-unavailable",
+ "call.in-progress.error-sip-outbound-call-failed-to-connect",
"call.ringing.hook-executed-say",
"call.ringing.hook-executed-transfer",
+ "call.ringing.sip-inbound-caller-hungup-before-call-connect",
+ "call.ringing.error-sip-inbound-call-failed-to-connect",
"twilio-failed-to-connect-call",
"twilio-reported-customer-misdialed",
"vonage-rejected",
@@ -33771,13 +43358,17 @@
{
"$ref": "#/components/schemas/AnalysisCost",
"title": "AnalysisCost"
+ },
+ {
+ "$ref": "#/components/schemas/KnowledgeBaseCost",
+ "title": "KnowledgeBaseCost"
}
]
}
},
"timestamp": {
"type": "number",
- "description": "This is the timestamp of when the message was sent in milliseconds since Unix Epoch."
+ "description": "This is the timestamp of the message."
},
"artifact": {
"description": "These are the artifacts from the call. This can also be found at `call.artifact` on GET /call/:id.",
@@ -33788,7 +43379,7 @@
]
},
"assistant": {
- "description": "This is the assistant that is currently active. This is provided for convenience.\n\nThis matches one of the following:\n- `call.assistant`,\n- `call.assistantId`,\n- `call.squad[n].assistant`,\n- `call.squad[n].assistantId`,\n- `call.squadId->[n].assistant`,\n- `call.squadId->[n].assistantId`.",
+ "description": "This is the assistant that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateAssistantDTO"
@@ -33796,7 +43387,7 @@
]
},
"customer": {
- "description": "This is the customer associated with the call.\n\nThis matches one of the following:\n- `call.customer`,\n- `call.customerId`.",
+ "description": "This is the customer that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateCustomerDTO"
@@ -33804,13 +43395,21 @@
]
},
"call": {
- "description": "This is the call object.\n\nThis matches what was returned in POST /call.\n\nNote: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.",
+ "description": "This is the call that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/Call"
}
]
},
+ "chat": {
+ "description": "This is the chat object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Chat"
+ }
+ ]
+ },
"analysis": {
"description": "This is the analysis of the call. This can also be found at `call.analysis` on GET /call/:id.",
"allOf": [
@@ -33841,7 +43440,7 @@
"type": "object",
"properties": {
"phoneNumber": {
- "description": "This is the phone number associated with the call.\n\nThis matches one of the following:\n- `call.phoneNumber`,\n- `call.phoneNumberId`.",
+ "description": "This is the phone number that the message is associated with.",
"oneOf": [
{
"$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
@@ -33858,6 +43457,10 @@
{
"$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
"title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
}
]
},
@@ -33870,7 +43473,7 @@
},
"timestamp": {
"type": "number",
- "description": "This is the timestamp of when the message was sent in milliseconds since Unix Epoch."
+ "description": "This is the timestamp of the message."
},
"artifact": {
"description": "This is a live version of the `call.artifact`.\n\nThis matches what is stored on `call.artifact` after the call.",
@@ -33881,7 +43484,7 @@
]
},
"assistant": {
- "description": "This is the assistant that is currently active. This is provided for convenience.\n\nThis matches one of the following:\n- `call.assistant`,\n- `call.assistantId`,\n- `call.squad[n].assistant`,\n- `call.squad[n].assistantId`,\n- `call.squadId->[n].assistant`,\n- `call.squadId->[n].assistantId`.",
+ "description": "This is the assistant that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateAssistantDTO"
@@ -33889,7 +43492,7 @@
]
},
"customer": {
- "description": "This is the customer associated with the call.\n\nThis matches one of the following:\n- `call.customer`,\n- `call.customerId`.",
+ "description": "This is the customer that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateCustomerDTO"
@@ -33897,12 +43500,20 @@
]
},
"call": {
- "description": "This is the call object.\n\nThis matches what was returned in POST /call.\n\nNote: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.",
+ "description": "This is the call that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/Call"
}
]
+ },
+ "chat": {
+ "description": "This is the chat object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Chat"
+ }
+ ]
}
},
"required": [
@@ -33913,7 +43524,7 @@
"type": "object",
"properties": {
"phoneNumber": {
- "description": "This is the phone number associated with the call.\n\nThis matches one of the following:\n- `call.phoneNumber`,\n- `call.phoneNumberId`.",
+ "description": "This is the phone number that the message is associated with.",
"oneOf": [
{
"$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
@@ -33930,6 +43541,10 @@
{
"$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
"title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
}
]
},
@@ -33977,7 +43592,7 @@
},
"timestamp": {
"type": "number",
- "description": "This is the timestamp of when the message was sent in milliseconds since Unix Epoch."
+ "description": "This is the timestamp of the message."
},
"artifact": {
"description": "This is a live version of the `call.artifact`.\n\nThis matches what is stored on `call.artifact` after the call.",
@@ -33988,7 +43603,7 @@
]
},
"assistant": {
- "description": "This is the assistant that is currently active. This is provided for convenience.\n\nThis matches one of the following:\n- `call.assistant`,\n- `call.assistantId`,\n- `call.squad[n].assistant`,\n- `call.squad[n].assistantId`,\n- `call.squadId->[n].assistant`,\n- `call.squadId->[n].assistantId`.",
+ "description": "This is the assistant that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateAssistantDTO"
@@ -33996,7 +43611,7 @@
]
},
"customer": {
- "description": "This is the customer associated with the call.\n\nThis matches one of the following:\n- `call.customer`,\n- `call.customerId`.",
+ "description": "This is the customer that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateCustomerDTO"
@@ -34004,12 +43619,20 @@
]
},
"call": {
- "description": "This is the call object.\n\nThis matches what was returned in POST /call.\n\nNote: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.",
+ "description": "This is the call that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/Call"
}
]
+ },
+ "chat": {
+ "description": "This is the chat object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Chat"
+ }
+ ]
}
},
"required": [
@@ -34021,7 +43644,7 @@
"type": "object",
"properties": {
"phoneNumber": {
- "description": "This is the phone number associated with the call.\n\nThis matches one of the following:\n- `call.phoneNumber`,\n- `call.phoneNumberId`.",
+ "description": "This is the phone number that the message is associated with.",
"oneOf": [
{
"$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
@@ -34038,6 +43661,10 @@
{
"$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
"title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
}
]
},
@@ -34050,7 +43677,7 @@
},
"timestamp": {
"type": "number",
- "description": "This is the timestamp of when the message was sent in milliseconds since Unix Epoch."
+ "description": "This is the timestamp of the message."
},
"artifact": {
"description": "This is a live version of the `call.artifact`.\n\nThis matches what is stored on `call.artifact` after the call.",
@@ -34061,7 +43688,7 @@
]
},
"assistant": {
- "description": "This is the assistant that is currently active. This is provided for convenience.\n\nThis matches one of the following:\n- `call.assistant`,\n- `call.assistantId`,\n- `call.squad[n].assistant`,\n- `call.squad[n].assistantId`,\n- `call.squadId->[n].assistant`,\n- `call.squadId->[n].assistantId`.",
+ "description": "This is the assistant that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateAssistantDTO"
@@ -34069,7 +43696,7 @@
]
},
"customer": {
- "description": "This is the customer associated with the call.\n\nThis matches one of the following:\n- `call.customer`,\n- `call.customerId`.",
+ "description": "This is the customer that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateCustomerDTO"
@@ -34077,13 +43704,21 @@
]
},
"call": {
- "description": "This is the call object.\n\nThis matches what was returned in POST /call.\n\nNote: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.",
+ "description": "This is the call that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/Call"
}
]
},
+ "chat": {
+ "description": "This is the chat object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Chat"
+ }
+ ]
+ },
"output": {
"type": "object",
"description": "This is the output of the model. It can be a token or tool call."
@@ -34098,7 +43733,7 @@
"type": "object",
"properties": {
"phoneNumber": {
- "description": "This is the phone number associated with the call.\n\nThis matches one of the following:\n- `call.phoneNumber`,\n- `call.phoneNumberId`.",
+ "description": "This is the phone number that the message is associated with.",
"oneOf": [
{
"$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
@@ -34115,6 +43750,10 @@
{
"$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
"title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
}
]
},
@@ -34148,7 +43787,112 @@
},
"timestamp": {
"type": "number",
- "description": "This is the timestamp of when the message was sent in milliseconds since Unix Epoch."
+ "description": "This is the timestamp of the message."
+ },
+ "artifact": {
+ "description": "This is a live version of the `call.artifact`.\n\nThis matches what is stored on `call.artifact` after the call.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Artifact"
+ }
+ ]
+ },
+ "assistant": {
+ "description": "This is the assistant that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateAssistantDTO"
+ }
+ ]
+ },
+ "customer": {
+ "description": "This is the customer that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateCustomerDTO"
+ }
+ ]
+ },
+ "call": {
+ "description": "This is the call that the message is associated with.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Call"
+ }
+ ]
+ },
+ "chat": {
+ "description": "This is the chat object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Chat"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "request"
+ ]
+ },
+ "ServerMessageSpeechUpdate": {
+ "type": "object",
+ "properties": {
+ "phoneNumber": {
+ "description": "This is the phone number that the message is associated with.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
+ "title": "ByoPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTwilioPhoneNumberDTO",
+ "title": "TwilioPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVonagePhoneNumberDTO",
+ "title": "VonagePhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
+ "title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "status": {
+ "type": "string",
+ "description": "This is the status of the speech update.",
+ "enum": [
+ "started",
+ "stopped"
+ ]
+ },
+ "role": {
+ "type": "string",
+ "description": "This is the role which the speech update is for.",
+ "enum": [
+ "assistant",
+ "user"
+ ]
+ },
+ "turn": {
+ "type": "number",
+ "description": "This is the turn number of the speech update (0-indexed)."
+ },
+ "timestamp": {
+ "type": "number",
+ "description": "This is the timestamp of the message."
},
"artifact": {
"description": "This is a live version of the `call.artifact`.\n\nThis matches what is stored on `call.artifact` after the call.",
@@ -34159,7 +43903,7 @@
]
},
"assistant": {
- "description": "This is the assistant that is currently active. This is provided for convenience.\n\nThis matches one of the following:\n- `call.assistant`,\n- `call.assistantId`,\n- `call.squad[n].assistant`,\n- `call.squad[n].assistantId`,\n- `call.squadId->[n].assistant`,\n- `call.squadId->[n].assistantId`.",
+ "description": "This is the assistant that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateAssistantDTO"
@@ -34167,7 +43911,7 @@
]
},
"customer": {
- "description": "This is the customer associated with the call.\n\nThis matches one of the following:\n- `call.customer`,\n- `call.customerId`.",
+ "description": "This is the customer that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateCustomerDTO"
@@ -34175,103 +43919,18 @@
]
},
"call": {
- "description": "This is the call object.\n\nThis matches what was returned in POST /call.\n\nNote: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.",
+ "description": "This is the call that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/Call"
}
]
- }
- },
- "required": [
- "type",
- "request"
- ]
- },
- "ServerMessageSpeechUpdate": {
- "type": "object",
- "properties": {
- "phoneNumber": {
- "description": "This is the phone number associated with the call.\n\nThis matches one of the following:\n- `call.phoneNumber`,\n- `call.phoneNumberId`.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
- "title": "ByoPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/CreateTwilioPhoneNumberDTO",
- "title": "TwilioPhoneNumber"
- },
- {
- "$ref": "#/components/schemas/CreateVonagePhoneNumberDTO",
- "title": "VonagePhoneNumber"
- },
- {
- "$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
- "title": "VapiPhoneNumber"
- }
- ]
},
- "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"
- ]
- },
- "status": {
- "type": "string",
- "description": "This is the status of the speech update.",
- "enum": [
- "started",
- "stopped"
- ]
- },
- "role": {
- "type": "string",
- "description": "This is the role which the speech update is for.",
- "enum": [
- "assistant",
- "user"
- ]
- },
- "turn": {
- "type": "number",
- "description": "This is the turn number of the speech update (0-indexed)."
- },
- "timestamp": {
- "type": "number",
- "description": "This is the timestamp of when the message was sent in milliseconds since Unix Epoch."
- },
- "artifact": {
- "description": "This is a live version of the `call.artifact`.\n\nThis matches what is stored on `call.artifact` after the call.",
+ "chat": {
+ "description": "This is the chat object.",
"allOf": [
{
- "$ref": "#/components/schemas/Artifact"
- }
- ]
- },
- "assistant": {
- "description": "This is the assistant that is currently active. This is provided for convenience.\n\nThis matches one of the following:\n- `call.assistant`,\n- `call.assistantId`,\n- `call.squad[n].assistant`,\n- `call.squad[n].assistantId`,\n- `call.squadId->[n].assistant`,\n- `call.squadId->[n].assistantId`.",
- "allOf": [
- {
- "$ref": "#/components/schemas/CreateAssistantDTO"
- }
- ]
- },
- "customer": {
- "description": "This is the customer associated with the call.\n\nThis matches one of the following:\n- `call.customer`,\n- `call.customerId`.",
- "allOf": [
- {
- "$ref": "#/components/schemas/CreateCustomerDTO"
- }
- ]
- },
- "call": {
- "description": "This is the call object.\n\nThis matches what was returned in POST /call.\n\nNote: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.",
- "allOf": [
- {
- "$ref": "#/components/schemas/Call"
+ "$ref": "#/components/schemas/Chat"
}
]
}
@@ -34286,7 +43945,7 @@
"type": "object",
"properties": {
"phoneNumber": {
- "description": "This is the phone number associated with the call.\n\nThis matches one of the following:\n- `call.phoneNumber`,\n- `call.phoneNumberId`.",
+ "description": "This is the phone number that the message is associated with.",
"oneOf": [
{
"$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
@@ -34303,6 +43962,10 @@
{
"$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
"title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
}
]
},
@@ -34336,8 +43999,9 @@
"assistant-request-returned-invalid-assistant",
"assistant-request-returned-no-assistant",
"assistant-request-returned-forwarding-phone-number",
- "call.start.error-get-org",
- "call.start.error-get-subscription",
+ "scheduled-call-deleted",
+ "call.start.error-vapifault-get-org",
+ "call.start.error-vapifault-get-subscription",
"call.start.error-get-assistant",
"call.start.error-get-phone-number",
"call.start.error-get-customer",
@@ -34345,6 +44009,11 @@
"call.start.error-vapi-number-international",
"call.start.error-vapi-number-outbound-daily-limit",
"call.start.error-get-transport",
+ "call.start.error-subscription-wallet-does-not-exist",
+ "call.start.error-subscription-frozen",
+ "call.start.error-subscription-insufficient-credits",
+ "call.start.error-subscription-upgrade-failed",
+ "call.start.error-subscription-concurrency-limit-reached",
"assistant-not-valid",
"database-error",
"assistant-not-found",
@@ -34412,7 +44081,6 @@
"call.in-progress.error-vapifault-azure-speech-transcriber-failed",
"call.in-progress.error-pipeline-no-available-llm-model",
"worker-shutdown",
- "unknown-error",
"vonage-disconnected",
"vonage-failed-to-connect-call",
"vonage-completed",
@@ -34422,6 +44090,9 @@
"call.in-progress.error-vapifault-transport-never-connected",
"call.in-progress.error-vapifault-transport-connected-but-call-not-active",
"call.in-progress.error-vapifault-call-started-but-connection-to-transport-missing",
+ "call.in-progress.error-vapifault-worker-died",
+ "call.in-progress.twilio-completed-call",
+ "call.in-progress.sip-completed-call",
"call.in-progress.error-vapifault-openai-llm-failed",
"call.in-progress.error-vapifault-azure-openai-llm-failed",
"call.in-progress.error-vapifault-groq-llm-failed",
@@ -34431,6 +44102,7 @@
"call.in-progress.error-vapifault-inflection-ai-llm-failed",
"call.in-progress.error-vapifault-cerebras-llm-failed",
"call.in-progress.error-vapifault-deep-seek-llm-failed",
+ "call.in-progress.error-vapifault-chat-pipeline-failed-to-start",
"pipeline-error-openai-400-bad-request-validation-failed",
"pipeline-error-openai-401-unauthorized",
"pipeline-error-openai-401-incorrect-api-key",
@@ -34698,6 +44370,7 @@
"pipeline-error-cartesia-socket-hang-up",
"pipeline-error-cartesia-requested-payment",
"pipeline-error-cartesia-500-server-error",
+ "pipeline-error-cartesia-502-server-error",
"pipeline-error-cartesia-503-server-error",
"pipeline-error-cartesia-522-server-error",
"call.in-progress.error-vapifault-cartesia-socket-hang-up",
@@ -34718,6 +44391,7 @@
"pipeline-error-eleven-labs-invalid-api-key",
"pipeline-error-eleven-labs-invalid-voice-samples",
"pipeline-error-eleven-labs-voice-disabled-by-owner",
+ "pipeline-error-eleven-labs-vapi-voice-disabled-by-owner",
"pipeline-error-eleven-labs-blocked-account-in-probation",
"pipeline-error-eleven-labs-blocked-content-against-their-policy",
"pipeline-error-eleven-labs-missing-samples-for-voice-clone",
@@ -34726,6 +44400,7 @@
"pipeline-error-eleven-labs-max-character-limit-exceeded",
"pipeline-error-eleven-labs-blocked-voice-potentially-against-terms-of-service-and-awaiting-verification",
"pipeline-error-eleven-labs-500-server-error",
+ "pipeline-error-eleven-labs-503-server-error",
"call.in-progress.error-vapifault-eleven-labs-voice-not-found",
"call.in-progress.error-vapifault-eleven-labs-quota-exceeded",
"call.in-progress.error-vapifault-eleven-labs-unauthorized-access",
@@ -34747,6 +44422,7 @@
"call.in-progress.error-vapifault-eleven-labs-max-character-limit-exceeded",
"call.in-progress.error-vapifault-eleven-labs-blocked-voice-potentially-against-terms-of-service-and-awaiting-verification",
"call.in-progress.error-providerfault-eleven-labs-500-server-error",
+ "call.in-progress.error-providerfault-eleven-labs-503-server-error",
"pipeline-error-playht-request-timed-out",
"pipeline-error-playht-invalid-voice",
"pipeline-error-playht-unexpected-error",
@@ -34782,6 +44458,7 @@
"pipeline-error-deepgram-returning-500-invalid-json",
"pipeline-error-deepgram-returning-502-network-error",
"pipeline-error-deepgram-returning-502-bad-gateway-ehostunreach",
+ "pipeline-error-deepgram-returning-econnreset",
"call.in-progress.error-vapifault-deepgram-returning-400-no-such-model-language-tier-combination",
"call.in-progress.error-vapifault-deepgram-returning-401-invalid-credentials",
"call.in-progress.error-vapifault-deepgram-returning-404-not-found",
@@ -34800,6 +44477,7 @@
"assistant-forwarded-call",
"assistant-join-timed-out",
"call.in-progress.error-assistant-did-not-receive-customer-audio",
+ "call.in-progress.error-transfer-failed",
"customer-busy",
"customer-ended-call",
"customer-did-not-answer",
@@ -34809,9 +44487,16 @@
"phone-call-provider-closed-websocket",
"call.forwarding.operator-busy",
"silence-timed-out",
- "call.in-progress.error-sip-telephony-provider-failed-to-connect-call",
+ "call.in-progress.error-sip-inbound-call-failed-to-connect",
+ "call.in-progress.error-providerfault-outbound-sip-403-forbidden",
+ "call.in-progress.error-providerfault-outbound-sip-407-proxy-authentication-required",
+ "call.in-progress.error-providerfault-outbound-sip-503-service-unavailable",
+ "call.in-progress.error-providerfault-outbound-sip-480-temporarily-unavailable",
+ "call.in-progress.error-sip-outbound-call-failed-to-connect",
"call.ringing.hook-executed-say",
"call.ringing.hook-executed-transfer",
+ "call.ringing.sip-inbound-caller-hungup-before-call-connect",
+ "call.ringing.error-sip-inbound-call-failed-to-connect",
"twilio-failed-to-connect-call",
"twilio-reported-customer-misdialed",
"vonage-rejected",
@@ -34868,7 +44553,7 @@
},
"timestamp": {
"type": "number",
- "description": "This is the timestamp of when the message was sent in milliseconds since Unix Epoch."
+ "description": "This is the timestamp of the message."
},
"artifact": {
"description": "This is a live version of the `call.artifact`.\n\nThis matches what is stored on `call.artifact` after the call.",
@@ -34879,7 +44564,7 @@
]
},
"assistant": {
- "description": "This is the assistant that is currently active. This is provided for convenience.\n\nThis matches one of the following:\n- `call.assistant`,\n- `call.assistantId`,\n- `call.squad[n].assistant`,\n- `call.squad[n].assistantId`,\n- `call.squadId->[n].assistant`,\n- `call.squadId->[n].assistantId`.",
+ "description": "This is the assistant that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateAssistantDTO"
@@ -34887,7 +44572,7 @@
]
},
"customer": {
- "description": "This is the customer associated with the call.\n\nThis matches one of the following:\n- `call.customer`,\n- `call.customerId`.",
+ "description": "This is the customer that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateCustomerDTO"
@@ -34895,13 +44580,21 @@
]
},
"call": {
- "description": "This is the call object.\n\nThis matches what was returned in POST /call.\n\nNote: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.",
+ "description": "This is the call that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/Call"
}
]
},
+ "chat": {
+ "description": "This is the chat object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Chat"
+ }
+ ]
+ },
"transcript": {
"type": "string",
"description": "This is the transcript of the call. This is only sent if the status is \"forwarding\"."
@@ -34924,7 +44617,7 @@
"type": "object",
"properties": {
"phoneNumber": {
- "description": "This is the phone number associated with the call.\n\nThis matches one of the following:\n- `call.phoneNumber`,\n- `call.phoneNumberId`.",
+ "description": "This is the phone number that the message is associated with.",
"oneOf": [
{
"$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
@@ -34941,6 +44634,10 @@
{
"$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
"title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
}
]
},
@@ -34989,7 +44686,7 @@
},
"timestamp": {
"type": "number",
- "description": "This is the timestamp of when the message was sent in milliseconds since Unix Epoch."
+ "description": "This is the timestamp of the message."
},
"artifact": {
"description": "This is a live version of the `call.artifact`.\n\nThis matches what is stored on `call.artifact` after the call.",
@@ -35000,7 +44697,7 @@
]
},
"assistant": {
- "description": "This is the assistant that is currently active. This is provided for convenience.\n\nThis matches one of the following:\n- `call.assistant`,\n- `call.assistantId`,\n- `call.squad[n].assistant`,\n- `call.squad[n].assistantId`,\n- `call.squadId->[n].assistant`,\n- `call.squadId->[n].assistantId`.",
+ "description": "This is the assistant that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateAssistantDTO"
@@ -35008,7 +44705,7 @@
]
},
"customer": {
- "description": "This is the customer associated with the call.\n\nThis matches one of the following:\n- `call.customer`,\n- `call.customerId`.",
+ "description": "This is the customer that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateCustomerDTO"
@@ -35016,13 +44713,21 @@
]
},
"call": {
- "description": "This is the call object.\n\nThis matches what was returned in POST /call.\n\nNote: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.",
+ "description": "This is the call that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/Call"
}
]
},
+ "chat": {
+ "description": "This is the chat object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Chat"
+ }
+ ]
+ },
"toolCallList": {
"description": "This is the list of tool calls that the model is requesting.",
"type": "array",
@@ -35040,7 +44745,7 @@
"type": "object",
"properties": {
"phoneNumber": {
- "description": "This is the phone number associated with the call.\n\nThis matches one of the following:\n- `call.phoneNumber`,\n- `call.phoneNumberId`.",
+ "description": "This is the phone number that the message is associated with.",
"oneOf": [
{
"$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
@@ -35057,6 +44762,10 @@
{
"$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
"title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
}
]
},
@@ -35069,7 +44778,7 @@
},
"timestamp": {
"type": "number",
- "description": "This is the timestamp of when the message was sent in milliseconds since Unix Epoch."
+ "description": "This is the timestamp of the message."
},
"artifact": {
"description": "This is a live version of the `call.artifact`.\n\nThis matches what is stored on `call.artifact` after the call.",
@@ -35080,7 +44789,7 @@
]
},
"assistant": {
- "description": "This is the assistant that is currently active. This is provided for convenience.\n\nThis matches one of the following:\n- `call.assistant`,\n- `call.assistantId`,\n- `call.squad[n].assistant`,\n- `call.squad[n].assistantId`,\n- `call.squadId->[n].assistant`,\n- `call.squadId->[n].assistantId`.",
+ "description": "This is the assistant that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateAssistantDTO"
@@ -35088,7 +44797,7 @@
]
},
"customer": {
- "description": "This is the customer associated with the call.\n\nThis matches one of the following:\n- `call.customer`,\n- `call.customerId`.",
+ "description": "This is the customer that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateCustomerDTO"
@@ -35096,12 +44805,20 @@
]
},
"call": {
- "description": "This is the call object.\n\nThis matches what was returned in POST /call.\n\nNote: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.",
+ "description": "This is the call that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/Call"
}
]
+ },
+ "chat": {
+ "description": "This is the chat object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Chat"
+ }
+ ]
}
},
"required": [
@@ -35112,7 +44829,7 @@
"type": "object",
"properties": {
"phoneNumber": {
- "description": "This is the phone number associated with the call.\n\nThis matches one of the following:\n- `call.phoneNumber`,\n- `call.phoneNumberId`.",
+ "description": "This is the phone number that the message is associated with.",
"oneOf": [
{
"$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
@@ -35129,6 +44846,10 @@
{
"$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
"title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
}
]
},
@@ -35146,10 +44867,6 @@
"$ref": "#/components/schemas/TransferDestinationAssistant",
"title": "Assistant"
},
- {
- "$ref": "#/components/schemas/TransferDestinationStep",
- "title": "Step"
- },
{
"$ref": "#/components/schemas/TransferDestinationNumber",
"title": "Number"
@@ -35162,7 +44879,7 @@
},
"timestamp": {
"type": "number",
- "description": "This is the timestamp of when the message was sent in milliseconds since Unix Epoch."
+ "description": "This is the timestamp of the message."
},
"artifact": {
"description": "This is a live version of the `call.artifact`.\n\nThis matches what is stored on `call.artifact` after the call.",
@@ -35173,7 +44890,7 @@
]
},
"assistant": {
- "description": "This is the assistant that is currently active. This is provided for convenience.\n\nThis matches one of the following:\n- `call.assistant`,\n- `call.assistantId`,\n- `call.squad[n].assistant`,\n- `call.squad[n].assistantId`,\n- `call.squadId->[n].assistant`,\n- `call.squadId->[n].assistantId`.",
+ "description": "This is the assistant that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateAssistantDTO"
@@ -35181,7 +44898,7 @@
]
},
"customer": {
- "description": "This is the customer associated with the call.\n\nThis matches one of the following:\n- `call.customer`,\n- `call.customerId`.",
+ "description": "This is the customer that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateCustomerDTO"
@@ -35189,13 +44906,21 @@
]
},
"call": {
- "description": "This is the call object.\n\nThis matches what was returned in POST /call.\n\nNote: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.",
+ "description": "This is the call that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/Call"
}
]
},
+ "chat": {
+ "description": "This is the chat object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Chat"
+ }
+ ]
+ },
"toAssistant": {
"description": "This is the assistant that the call is being transferred to. This is only sent if `destination.type` is \"assistant\".",
"allOf": [
@@ -35229,7 +44954,7 @@
"type": "object",
"properties": {
"phoneNumber": {
- "description": "This is the phone number associated with the call.\n\nThis matches one of the following:\n- `call.phoneNumber`,\n- `call.phoneNumberId`.",
+ "description": "This is the phone number that the message is associated with.",
"oneOf": [
{
"$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
@@ -35246,6 +44971,10 @@
{
"$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
"title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
}
]
},
@@ -35259,7 +44988,7 @@
},
"timestamp": {
"type": "number",
- "description": "This is the timestamp of when the message was sent in milliseconds since Unix Epoch."
+ "description": "This is the timestamp of the message."
},
"artifact": {
"description": "This is a live version of the `call.artifact`.\n\nThis matches what is stored on `call.artifact` after the call.",
@@ -35270,7 +44999,7 @@
]
},
"assistant": {
- "description": "This is the assistant that is currently active. This is provided for convenience.\n\nThis matches one of the following:\n- `call.assistant`,\n- `call.assistantId`,\n- `call.squad[n].assistant`,\n- `call.squad[n].assistantId`,\n- `call.squadId->[n].assistant`,\n- `call.squadId->[n].assistantId`.",
+ "description": "This is the assistant that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateAssistantDTO"
@@ -35278,7 +45007,7 @@
]
},
"customer": {
- "description": "This is the customer associated with the call.\n\nThis matches one of the following:\n- `call.customer`,\n- `call.customerId`.",
+ "description": "This is the customer that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateCustomerDTO"
@@ -35286,13 +45015,21 @@
]
},
"call": {
- "description": "This is the call object.\n\nThis matches what was returned in POST /call.\n\nNote: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.",
+ "description": "This is the call that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/Call"
}
]
},
+ "chat": {
+ "description": "This is the chat object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Chat"
+ }
+ ]
+ },
"role": {
"type": "string",
"description": "This is the role for which the transcript is for.",
@@ -35325,7 +45062,7 @@
"type": "object",
"properties": {
"phoneNumber": {
- "description": "This is the phone number associated with the call.\n\nThis matches one of the following:\n- `call.phoneNumber`,\n- `call.phoneNumberId`.",
+ "description": "This is the phone number that the message is associated with.",
"oneOf": [
{
"$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
@@ -35342,6 +45079,10 @@
{
"$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
"title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
}
]
},
@@ -35354,7 +45095,7 @@
},
"timestamp": {
"type": "number",
- "description": "This is the timestamp of when the message was sent in milliseconds since Unix Epoch."
+ "description": "This is the timestamp of the message."
},
"artifact": {
"description": "This is a live version of the `call.artifact`.\n\nThis matches what is stored on `call.artifact` after the call.",
@@ -35365,7 +45106,7 @@
]
},
"assistant": {
- "description": "This is the assistant that is currently active. This is provided for convenience.\n\nThis matches one of the following:\n- `call.assistant`,\n- `call.assistantId`,\n- `call.squad[n].assistant`,\n- `call.squad[n].assistantId`,\n- `call.squadId->[n].assistant`,\n- `call.squadId->[n].assistantId`.",
+ "description": "This is the assistant that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateAssistantDTO"
@@ -35373,7 +45114,7 @@
]
},
"customer": {
- "description": "This is the customer associated with the call.\n\nThis matches one of the following:\n- `call.customer`,\n- `call.customerId`.",
+ "description": "This is the customer that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateCustomerDTO"
@@ -35381,12 +45122,20 @@
]
},
"call": {
- "description": "This is the call object.\n\nThis matches what was returned in POST /call.\n\nNote: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.",
+ "description": "This is the call that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/Call"
}
]
+ },
+ "chat": {
+ "description": "This is the chat object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Chat"
+ }
+ ]
}
},
"required": [
@@ -35397,7 +45146,7 @@
"type": "object",
"properties": {
"phoneNumber": {
- "description": "This is the phone number associated with the call.\n\nThis matches one of the following:\n- `call.phoneNumber`,\n- `call.phoneNumberId`.",
+ "description": "This is the phone number that the message is associated with.",
"oneOf": [
{
"$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
@@ -35414,6 +45163,10 @@
{
"$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
"title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
}
]
},
@@ -35426,7 +45179,7 @@
},
"timestamp": {
"type": "number",
- "description": "This is the timestamp of when the message was sent in milliseconds since Unix Epoch."
+ "description": "This is the timestamp of the message."
},
"artifact": {
"description": "This is a live version of the `call.artifact`.\n\nThis matches what is stored on `call.artifact` after the call.",
@@ -35437,7 +45190,7 @@
]
},
"assistant": {
- "description": "This is the assistant that is currently active. This is provided for convenience.\n\nThis matches one of the following:\n- `call.assistant`,\n- `call.assistantId`,\n- `call.squad[n].assistant`,\n- `call.squad[n].assistantId`,\n- `call.squadId->[n].assistant`,\n- `call.squadId->[n].assistantId`.",
+ "description": "This is the assistant that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateAssistantDTO"
@@ -35445,7 +45198,7 @@
]
},
"customer": {
- "description": "This is the customer associated with the call.\n\nThis matches one of the following:\n- `call.customer`,\n- `call.customerId`.",
+ "description": "This is the customer that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateCustomerDTO"
@@ -35453,13 +45206,21 @@
]
},
"call": {
- "description": "This is the call object.\n\nThis matches what was returned in POST /call.\n\nNote: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.",
+ "description": "This is the call that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/Call"
}
]
},
+ "chat": {
+ "description": "This is the chat object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Chat"
+ }
+ ]
+ },
"language": {
"type": "string",
"description": "This is the language the transcriber is switched to."
@@ -35474,7 +45235,7 @@
"type": "object",
"properties": {
"phoneNumber": {
- "description": "This is the phone number associated with the call.\n\nThis matches one of the following:\n- `call.phoneNumber`,\n- `call.phoneNumberId`.",
+ "description": "This is the phone number that the message is associated with.",
"oneOf": [
{
"$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
@@ -35491,6 +45252,10 @@
{
"$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
"title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
}
]
},
@@ -35503,7 +45268,7 @@
},
"timestamp": {
"type": "number",
- "description": "This is the timestamp of when the message was sent in milliseconds since Unix Epoch."
+ "description": "This is the timestamp of the message."
},
"artifact": {
"description": "This is a live version of the `call.artifact`.\n\nThis matches what is stored on `call.artifact` after the call.",
@@ -35514,7 +45279,7 @@
]
},
"assistant": {
- "description": "This is the assistant that is currently active. This is provided for convenience.\n\nThis matches one of the following:\n- `call.assistant`,\n- `call.assistantId`,\n- `call.squad[n].assistant`,\n- `call.squad[n].assistantId`,\n- `call.squadId->[n].assistant`,\n- `call.squadId->[n].assistantId`.",
+ "description": "This is the assistant that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateAssistantDTO"
@@ -35522,7 +45287,7 @@
]
},
"customer": {
- "description": "This is the customer associated with the call.\n\nThis matches one of the following:\n- `call.customer`,\n- `call.customerId`.",
+ "description": "This is the customer that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateCustomerDTO"
@@ -35530,13 +45295,21 @@
]
},
"call": {
- "description": "This is the call object.\n\nThis matches what was returned in POST /call.\n\nNote: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.",
+ "description": "This is the call that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/Call"
}
]
},
+ "chat": {
+ "description": "This is the chat object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Chat"
+ }
+ ]
+ },
"input": {
"type": "string",
"description": "This is the voice input content"
@@ -35551,7 +45324,7 @@
"type": "object",
"properties": {
"phoneNumber": {
- "description": "This is the phone number associated with the call.\n\nThis matches one of the following:\n- `call.phoneNumber`,\n- `call.phoneNumberId`.",
+ "description": "This is the phone number that the message is associated with.",
"oneOf": [
{
"$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
@@ -35568,6 +45341,10 @@
{
"$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
"title": "VapiPhoneNumber"
+ },
+ {
+ "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
+ "title": "TelnyxPhoneNumber"
}
]
},
@@ -35580,7 +45357,7 @@
},
"timestamp": {
"type": "number",
- "description": "This is the timestamp of when the message was sent in milliseconds since Unix Epoch."
+ "description": "This is the timestamp of the message."
},
"artifact": {
"description": "This is a live version of the `call.artifact`.\n\nThis matches what is stored on `call.artifact` after the call.",
@@ -35591,7 +45368,7 @@
]
},
"assistant": {
- "description": "This is the assistant that is currently active. This is provided for convenience.\n\nThis matches one of the following:\n- `call.assistant`,\n- `call.assistantId`,\n- `call.squad[n].assistant`,\n- `call.squad[n].assistantId`,\n- `call.squadId->[n].assistant`,\n- `call.squadId->[n].assistantId`.",
+ "description": "This is the assistant that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateAssistantDTO"
@@ -35599,7 +45376,7 @@
]
},
"customer": {
- "description": "This is the customer associated with the call.\n\nThis matches one of the following:\n- `call.customer`,\n- `call.customerId`.",
+ "description": "This is the customer that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/CreateCustomerDTO"
@@ -35607,13 +45384,21 @@
]
},
"call": {
- "description": "This is the call object.\n\nThis matches what was returned in POST /call.\n\nNote: This might get stale during the call. To get the latest call object, especially after the call is ended, use GET /call/:id.",
+ "description": "This is the call that the message is associated with.",
"allOf": [
{
"$ref": "#/components/schemas/Call"
}
]
},
+ "chat": {
+ "description": "This is the chat object.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Chat"
+ }
+ ]
+ },
"text": {
"type": "string",
"description": "This is the text to be synthesized."
@@ -35728,11 +45513,10 @@
},
"assistantId": {
"type": "string",
- "nullable": true,
- "description": "This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead."
+ "description": "This is the assistant ID that will be used for the call. To use a transient assistant, use `assistant` instead.\n\nTo start a call with:\n- Assistant, use `assistantId` or `assistant`\n- Squad, use `squadId` or `squad`\n- Workflow, use `workflowId` or `workflow`"
},
"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.",
+ "description": "This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead.\n\nTo start a call with:\n- Assistant, use `assistant`\n- Squad, use `squad`\n- Workflow, use `workflow`",
"allOf": [
{
"$ref": "#/components/schemas/CreateAssistantDTO"
@@ -35749,16 +45533,36 @@
},
"squadId": {
"type": "string",
- "description": "This is the squad that will be used for the call. To use a transient squad, use `squad` instead."
+ "description": "This is the squad that will be used for the call. To use a transient squad, use `squad` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`"
},
"squad": {
- "description": "This is a squad that will be used for the call. To use an existing squad, use `squadId` instead.",
+ "description": "This is a squad that will be used for the call. To use an existing squad, use `squadId` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`",
"allOf": [
{
"$ref": "#/components/schemas/CreateSquadDTO"
}
]
},
+ "workflowId": {
+ "type": "string",
+ "description": "This is the workflow that will be used for the call. To use a transient workflow, use `workflow` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`"
+ },
+ "workflow": {
+ "description": "This is a workflow that will be used for the call. To use an existing workflow, use `workflowId` instead.\n\nTo start a call with:\n- Assistant, use `assistant` or `assistantId`\n- Squad, use `squad` or `squadId`\n- Workflow, use `workflow` or `workflowId`",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CreateWorkflowDTO"
+ }
+ ]
+ },
+ "workflowOverrides": {
+ "description": "These are the overrides for the `workflow` or `workflowId`'s settings and template variables.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/WorkflowOverrides"
+ }
+ ]
+ },
"error": {
"type": "string",
"description": "This is the error if the call shouldn't be accepted. This is spoken to the customer.\n\nIf this is sent, `assistantId`, `assistant`, `squadId`, `squad`, and `destination` are ignored."
@@ -35810,20 +45614,17 @@
"type": "object",
"properties": {
"message": {
- "type": "array",
"description": "This is the message that will be spoken to the user.\n\nIf this is not returned, assistant will speak:\n1. a `request-complete` or `request-failed` message from `tool.messages`, if it exists\n2. a response generated by the model, if not",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/ToolMessageComplete",
- "title": "ToolMessageComplete"
- },
- {
- "$ref": "#/components/schemas/ToolMessageFailed",
- "title": "ToolMessageFailed"
- }
- ]
- }
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ }
+ ]
},
"name": {
"type": "string",
@@ -35840,6 +45641,10 @@
"error": {
"type": "string",
"description": "This is the error if the tool call was not successful. This is added to the conversation history.\n\nFurther, if this is returned, assistant will speak:\n1. the `message`, if it exists and is of type `request-failed`\n2. a `request-failed` message from `tool.messages`, if it exists\n3. a response generated by the model, if neither exist"
+ },
+ "metadata": {
+ "type": "object",
+ "description": "This is optional metadata for the tool call result to be sent to the client."
}
},
"required": [
@@ -35873,10 +45678,6 @@
"$ref": "#/components/schemas/TransferDestinationAssistant",
"title": "Assistant"
},
- {
- "$ref": "#/components/schemas/TransferDestinationStep",
- "title": "Step"
- },
{
"$ref": "#/components/schemas/TransferDestinationNumber",
"title": "Number"
@@ -36002,6 +45803,11 @@
"say"
]
},
+ "interruptAssistantEnabled": {
+ "type": "boolean",
+ "description": "This is the flag for whether the message should replace existing assistant speech.\n\n@default false",
+ "default": false
+ },
"content": {
"type": "string",
"description": "This is the content to say."
@@ -36012,7 +45818,7 @@
},
"interruptionsEnabled": {
"type": "boolean",
- "description": "This is the flag for whether the message is interruptible."
+ "description": "This is the flag for whether the message is interruptible by the user."
}
}
},
@@ -36096,69 +45902,6 @@
"message"
]
},
- "UserMessage": {
- "type": "object",
- "properties": {
- "role": {
- "type": "string",
- "description": "The role of the user in the conversation."
- },
- "message": {
- "type": "string",
- "description": "The message content from the user."
- },
- "time": {
- "type": "number",
- "description": "The timestamp when the message was sent."
- },
- "endTime": {
- "type": "number",
- "description": "The timestamp when the message ended."
- },
- "secondsFromStart": {
- "type": "number",
- "description": "The number of seconds from the start of the conversation."
- },
- "duration": {
- "type": "number",
- "description": "The duration of the message in seconds."
- }
- },
- "required": [
- "role",
- "message",
- "time",
- "endTime",
- "secondsFromStart"
- ]
- },
- "SystemMessage": {
- "type": "object",
- "properties": {
- "role": {
- "type": "string",
- "description": "The role of the system in the conversation."
- },
- "message": {
- "type": "string",
- "description": "The message content from the system."
- },
- "time": {
- "type": "number",
- "description": "The timestamp when the message was sent."
- },
- "secondsFromStart": {
- "type": "number",
- "description": "The number of seconds from the start of the conversation."
- }
- },
- "required": [
- "role",
- "message",
- "time",
- "secondsFromStart"
- ]
- },
"BotMessage": {
"type": "object",
"properties": {
@@ -36260,6 +46003,10 @@
"secondsFromStart": {
"type": "number",
"description": "The number of seconds from the start of the conversation."
+ },
+ "metadata": {
+ "type": "object",
+ "description": "The metadata for the tool call result."
}
},
"required": [
@@ -36498,7 +46245,8 @@
"enum": [
"twilio",
"google",
- "openai"
+ "openai",
+ "vapi"
]
},
"promptTextTokens": {
@@ -36533,14 +46281,64 @@
"cost"
]
},
- "FunctionToolWithToolCall": {
+ "KnowledgeBaseCost": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
+ "type": {
+ "type": "string",
+ "description": "This is the type of cost, always 'knowledge-base' for this class.",
+ "enum": [
+ "knowledge-base"
+ ]
+ },
+ "model": {
+ "type": "object",
+ "description": "This is the model that was used for processing the knowledge base."
+ },
+ "promptTokens": {
+ "type": "number",
+ "description": "This is the number of prompt tokens used in the knowledge base query."
+ },
+ "completionTokens": {
+ "type": "number",
+ "description": "This is the number of completion tokens generated in the knowledge base query."
+ },
+ "cost": {
+ "type": "number",
+ "description": "This is the cost of the component in USD."
+ }
+ },
+ "required": [
+ "type",
+ "model",
+ "promptTokens",
+ "completionTokens",
+ "cost"
+ ]
+ },
+ "ChatCost": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "This is the type of cost, always 'chat' for this class.",
+ "enum": [
+ "chat"
+ ]
},
+ "cost": {
+ "type": "number",
+ "description": "This is the cost of the component in USD."
+ }
+ },
+ "required": [
+ "type",
+ "cost"
+ ]
+ },
+ "FunctionToolWithToolCall": {
+ "type": "object",
+ "properties": {
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -36572,22 +46370,27 @@
],
"description": "The type of tool. \"function\" for Function tool."
},
- "toolCall": {
- "$ref": "#/components/schemas/ToolCall"
+ "async": {
+ "type": "boolean",
+ "example": false,
+ "description": "This determines if the tool is async.\n\n If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\n If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\n Defaults to synchronous (`false`)."
},
- "function": {
- "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "server": {
+ "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.",
"allOf": [
{
- "$ref": "#/components/schemas/OpenAIFunction"
+ "$ref": "#/components/schemas/Server"
}
]
},
- "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.",
+ "toolCall": {
+ "$ref": "#/components/schemas/ToolCall"
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
}
@@ -36600,11 +46403,6 @@
"GhlToolWithToolCall": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -36649,14 +46447,6 @@
"$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"
- }
- ]
}
},
"required": [
@@ -36668,11 +46458,6 @@
"MakeToolWithToolCall": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -36717,14 +46502,6 @@
"$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"
- }
- ]
}
},
"required": [
@@ -36736,11 +46513,6 @@
"BashToolWithToolCall": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -36779,6 +46551,14 @@
],
"description": "The sub type of tool."
},
+ "server": {
+ "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
+ },
"toolCall": {
"$ref": "#/components/schemas/ToolCall"
},
@@ -36797,14 +46577,6 @@
"$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"
- }
- ]
}
},
"required": [
@@ -36817,11 +46589,6 @@
"ComputerToolWithToolCall": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -36860,6 +46627,14 @@
],
"description": "The sub type of tool."
},
+ "server": {
+ "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
+ },
"toolCall": {
"$ref": "#/components/schemas/ToolCall"
},
@@ -36890,14 +46665,6 @@
"$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"
- }
- ]
}
},
"required": [
@@ -36912,11 +46679,6 @@
"TextEditorToolWithToolCall": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -36955,6 +46717,14 @@
],
"description": "The sub type of tool."
},
+ "server": {
+ "description": "\n This is the server where a `tool-calls` webhook will be sent.\n\n Notes:\n - Webhook is sent to this server when a tool call is made.\n - Webhook contains the call, assistant, and phone number objects.\n - Webhook contains the variables set on the assistant.\n - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.\n - Webhook expects a response with tool call result.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Server"
+ }
+ ]
+ },
"toolCall": {
"$ref": "#/components/schemas/ToolCall"
},
@@ -36973,14 +46743,6 @@
"$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"
- }
- ]
}
},
"required": [
@@ -36993,11 +46755,6 @@
"GoogleCalendarCreateEventToolWithToolCall": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
- },
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -37039,12 +46796,106 @@
"$ref": "#/components/schemas/OpenAIFunction"
}
]
+ }
+ },
+ "required": [
+ "type",
+ "toolCall"
+ ]
+ },
+ "GoogleSheetsRowAppendToolWithToolCall": {
+ "type": "object",
+ "properties": {
+ "messages": {
+ "type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
+ }
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "google.sheets.row.append"
+ ],
+ "description": "The type of tool. \"google.sheets.row.append\" for Google Sheets tool."
+ },
+ "toolCall": {
+ "$ref": "#/components/schemas/ToolCall"
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "toolCall"
+ ]
+ },
+ "GoHighLevelCalendarAvailabilityToolWithToolCall": {
+ "type": "object",
+ "properties": {
+ "messages": {
+ "type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
+ }
},
- "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.",
+ "type": {
+ "type": "string",
+ "enum": [
+ "gohighlevel.calendar.availability.check"
+ ],
+ "description": "The type of tool. \"gohighlevel.calendar.availability.check\" for GoHighLevel Calendar availability check tool."
+ },
+ "toolCall": {
+ "$ref": "#/components/schemas/ToolCall"
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
}
@@ -37054,14 +46905,60 @@
"toolCall"
]
},
- "GoogleSheetsRowAppendToolWithToolCall": {
+ "GoHighLevelCalendarEventCreateToolWithToolCall": {
"type": "object",
"properties": {
- "async": {
- "type": "boolean",
- "description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
- "example": false
+ "messages": {
+ "type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
+ }
},
+ "type": {
+ "type": "string",
+ "enum": [
+ "gohighlevel.calendar.event.create"
+ ],
+ "description": "The type of tool. \"gohighlevel.calendar.event.create\" for GoHighLevel Calendar event create tool."
+ },
+ "toolCall": {
+ "$ref": "#/components/schemas/ToolCall"
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenAIFunction"
+ }
+ ]
+ }
+ },
+ "required": [
+ "type",
+ "toolCall"
+ ]
+ },
+ "GoHighLevelContactCreateToolWithToolCall": {
+ "type": "object",
+ "properties": {
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
@@ -37089,9 +46986,9 @@
"type": {
"type": "string",
"enum": [
- "google.sheets.row.append"
+ "gohighlevel.contact.create"
],
- "description": "The type of tool. \"google.sheets.row.append\" for Google Sheets tool."
+ "description": "The type of tool. \"gohighlevel.contact.create\" for GoHighLevel contact create tool."
},
"toolCall": {
"$ref": "#/components/schemas/ToolCall"
@@ -37103,12 +47000,55 @@
"$ref": "#/components/schemas/OpenAIFunction"
}
]
+ }
+ },
+ "required": [
+ "type",
+ "toolCall"
+ ]
+ },
+ "GoHighLevelContactGetToolWithToolCall": {
+ "type": "object",
+ "properties": {
+ "messages": {
+ "type": "array",
+ "description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ToolMessageStart",
+ "title": "ToolMessageStart"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageComplete",
+ "title": "ToolMessageComplete"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageFailed",
+ "title": "ToolMessageFailed"
+ },
+ {
+ "$ref": "#/components/schemas/ToolMessageDelayed",
+ "title": "ToolMessageDelayed"
+ }
+ ]
+ }
},
- "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.",
+ "type": {
+ "type": "string",
+ "enum": [
+ "gohighlevel.contact.get"
+ ],
+ "description": "The type of tool. \"gohighlevel.contact.get\" for GoHighLevel contact get tool."
+ },
+ "toolCall": {
+ "$ref": "#/components/schemas/ToolCall"
+ },
+ "function": {
+ "description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
- "$ref": "#/components/schemas/Server"
+ "$ref": "#/components/schemas/OpenAIFunction"
}
]
}