{ "service": "vapi", "displayName": "Vapi", "categories": [ "AI", "Communication" ], "authTypes": [ "api_key" ], "auth": [ { "type": "api_key", "label": "API Key", "placeholder": "vapi_api_key", "description": "Vapi API key used with the Authorization Bearer header.", "extraFields": [] } ], "homepageUrl": "https://vapi.ai", "actions": [ { "id": "vapi.create_analytics_query", "service": "vapi", "name": "create_analytics_query", "description": "Create and execute one or more Vapi analytics queries across call and subscription data.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "queries": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "The analytics queries to execute.", "minItems": 1 } }, "additionalProperties": true, "required": [ "queries" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The query name returned by the analytics request." }, "rows": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "A list of raw Vapi objects." }, "result": { "description": "A raw JSON value returned by Vapi." } }, "additionalProperties": true, "description": "A Vapi analytics query result." }, "description": "The analytics results returned by Vapi." } }, "additionalProperties": false, "required": [ "results" ], "description": "The output payload for this action." } }, { "id": "vapi.create_assistant", "service": "vapi", "name": "create_assistant", "description": "Create a new Vapi assistant with required transcriber, voice, and model settings plus optional messaging and duration controls.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "name": { "type": "string", "description": "Assistant identifier or display name." }, "model": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "voice": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "transcriber": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "firstMessage": { "type": "string", "description": "The first message the assistant should say." }, "systemPrompt": { "type": "string", "description": "The system prompt that controls assistant behavior." }, "clientMessages": { "type": "array", "items": { "type": "string", "description": "A string item." }, "description": "A list of string values." }, "serverMessages": { "type": "array", "items": { "type": "string", "description": "A string item." }, "description": "A list of string values." }, "maxDurationSeconds": { "type": "integer", "description": "The maximum call duration in seconds." }, "voicemailDetection": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." } }, "additionalProperties": true, "required": [ "model", "voice", "transcriber" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "assistant": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the assistant." }, "name": { "type": "string", "description": "The assistant name." }, "orgId": { "type": "string", "description": "The organization identifier that owns the assistant." }, "model": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "voice": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "metadata": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "transcriber": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "createdAt": { "type": "string", "description": "When the assistant was created." }, "updatedAt": { "type": "string", "description": "When the assistant was last updated." }, "firstMessage": { "type": "string", "description": "The first message spoken by the assistant." } }, "additionalProperties": true, "description": "A Vapi assistant." } }, "additionalProperties": false, "required": [ "assistant" ], "description": "The assistant created by Vapi." } }, { "id": "vapi.create_eval", "service": "vapi", "name": "create_eval", "description": "Create a Vapi eval for a mock conversation and define the checkpoint messages used to evaluate model behavior.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "name": { "type": "string", "description": "The eval name." }, "type": { "type": "string", "description": "The eval type." }, "messages": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "The mock conversation and evaluation messages.", "minItems": 1 }, "description": { "type": "string", "description": "The eval description." } }, "additionalProperties": true, "required": [ "messages" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "eval": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A Vapi eval." } }, "additionalProperties": false, "required": [ "eval" ], "description": "The eval created by Vapi." } }, { "id": "vapi.create_openai_chat", "service": "vapi", "name": "create_openai_chat", "description": "Create an OpenAI-compatible Vapi chat response using an assistant or squad, with optional session and transport settings.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "name": { "type": "string", "description": "The chat name for reference." }, "input": { "anyOf": [ { "type": "string", "description": "A plain-text chat input." }, { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "A list of raw Vapi objects." } ], "description": "The input text or messages for the chat." }, "squad": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "stream": { "type": "boolean", "description": "Whether Vapi should stream the response. This connector only supports false." }, "squadId": { "type": "string", "description": "The identifier of an existing squad." }, "assistant": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "sessionId": { "type": "string", "description": "The identifier of an existing session." }, "transport": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "assistantId": { "type": "string", "description": "The identifier of an existing assistant." }, "previousChatId": { "type": "string", "description": "The previous chat identifier used as conversation context." }, "assistantOverrides": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." } }, "additionalProperties": true, "required": [ "input" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the OpenAI-compatible response." }, "object": { "type": "string", "description": "The response object type." }, "status": { "type": "string", "description": "The response status." }, "output": { "description": "A raw JSON value returned by Vapi." }, "error": { "type": "string", "description": "The response error message, when present." }, "message": { "type": "string", "description": "The response message, when present." }, "createdAt": { "type": "string", "description": "When the response was created." } }, "additionalProperties": true, "description": "A Vapi OpenAI-compatible chat response." } }, "additionalProperties": false, "required": [ "response" ], "description": "The OpenAI-compatible response returned by Vapi." } }, { "id": "vapi.create_phone_number", "service": "vapi", "name": "create_phone_number", "description": "Create a Vapi phone number using Vapi, Twilio, Vonage, Telnyx, or bring-your-own provider settings.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "name": { "type": "string", "description": "The display name of the phone number." }, "number": { "type": "string", "description": "The E.164 phone number, when the provider requires one." }, "sipUri": { "type": "string", "description": "The SIP URI used by Vapi-managed SIP numbers." }, "provider": { "type": "string", "enum": [ "byo-phone-number", "twilio", "vonage", "vapi", "telnyx" ], "description": "The phone number provider." }, "squadId": { "type": "string", "description": "The squad identifier attached to the phone number." }, "smsEnabled": { "type": "boolean", "description": "Whether SMS is enabled for the phone number." }, "workflowId": { "type": "string", "description": "The workflow identifier attached to the phone number." }, "assistantId": { "type": "string", "description": "The assistant identifier attached to the phone number." }, "credentialId": { "type": "string", "description": "The credential identifier used by the phone provider." }, "twilioApiKey": { "type": "string", "description": "The Twilio API key." }, "twilioApiSecret": { "type": "string", "description": "The Twilio API secret." }, "twilioAuthToken": { "type": "string", "description": "The Twilio auth token." }, "twilioAccountSid": { "type": "string", "description": "The Twilio account SID." }, "numberDesiredAreaCode": { "type": "string", "description": "The desired area code when Vapi provisions a number automatically." }, "numberE164CheckEnabled": { "type": "boolean", "description": "Whether E.164 validation should be enforced." } }, "additionalProperties": true, "required": [ "provider" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "phoneNumber": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the phone number." }, "name": { "type": "string", "description": "The display name of the phone number." }, "number": { "type": "string", "description": "The E.164 phone number." }, "provider": { "type": "string", "description": "The provider that manages the phone number." }, "status": { "type": "string", "description": "The phone number status reported by Vapi." }, "assistantId": { "type": "string", "description": "The assistant identifier attached to the phone number." }, "workflowId": { "type": "string", "description": "The workflow identifier attached to the phone number." }, "squadId": { "type": "string", "description": "The squad identifier attached to the phone number." }, "createdAt": { "type": "string", "description": "When the phone number was created." }, "updatedAt": { "type": "string", "description": "When the phone number was last updated." } }, "additionalProperties": true, "description": "A Vapi phone number." } }, "additionalProperties": false, "required": [ "phoneNumber" ], "description": "The phone number created by Vapi." } }, { "id": "vapi.create_policy", "service": "vapi", "name": "create_policy", "description": "Create a Vapi monitoring policy with severity, threshold, and schedule or interval configuration.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "name": { "type": "string", "description": "The policy name." }, "interval": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "schedule": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "severity": { "type": "string", "enum": [ "error", "warning", "info" ], "description": "The severity level of the policy." }, "threshold": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "monitorIds": { "type": "array", "items": { "type": "string", "description": "A string item." }, "description": "A list of string values." }, "lookbackWindowMinutes": { "type": "integer", "description": "The lookback window, in minutes." } }, "additionalProperties": true, "required": [ "name", "severity", "threshold", "lookbackWindowMinutes" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "policy": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the monitoring policy." }, "name": { "type": "string", "description": "The policy name." }, "severity": { "type": "string", "description": "The policy severity." }, "threshold": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "interval": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "schedule": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "monitorIds": { "type": "array", "items": { "type": "string", "description": "A string item." }, "description": "A list of string values." }, "lookbackWindowMinutes": { "type": "integer", "description": "The lookback window, in minutes." }, "createdAt": { "type": "string", "description": "When the policy was created." }, "updatedAt": { "type": "string", "description": "When the policy was last updated." } }, "additionalProperties": true, "description": "A Vapi monitoring policy." } }, "additionalProperties": false, "required": [ "policy" ], "description": "The monitoring policy created by Vapi." } }, { "id": "vapi.create_provider_resource", "service": "vapi", "name": "create_provider_resource", "description": "Create a pronunciation dictionary provider resource in Vapi, defaulting to the 11labs pronunciation-dictionary route used by the upstream toolkit.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "11labs", "cartesia" ], "description": "The provider that should own the resource. Defaults to 11labs." }, "resourceName": { "type": "string", "description": "The provider resource type. Defaults to pronunciation-dictionary." }, "name": { "type": "string", "description": "The display name of the pronunciation dictionary." }, "rules": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "The pronunciation rules to create.", "minItems": 1 } }, "additionalProperties": true, "required": [ "name", "rules" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "providerResource": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the provider resource." }, "provider": { "type": "string", "description": "The provider that owns the resource." }, "resourceName": { "type": "string", "description": "The provider resource type." }, "resourceId": { "type": "string", "description": "The provider-side resource identifier." }, "resource": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "orgId": { "type": "string", "description": "The organization identifier that owns the resource." }, "createdAt": { "type": "string", "description": "When the resource was created." }, "updatedAt": { "type": "string", "description": "When the resource was last updated." } }, "additionalProperties": true, "description": "A Vapi provider resource." } }, "additionalProperties": false, "required": [ "providerResource" ], "description": "The provider resource created by Vapi." } }, { "id": "vapi.create_scorecard", "service": "vapi", "name": "create_scorecard", "description": "Create a Vapi scorecard for observability and evaluation using structured output metrics and conditions.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "name": { "type": "string", "description": "The scorecard name." }, "metrics": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "The scorecard metrics.", "minItems": 1 }, "description": { "type": "string", "description": "The scorecard description." }, "assistantIds": { "type": "array", "items": { "type": "string", "description": "A string item." }, "description": "A list of string values." } }, "additionalProperties": true, "required": [ "metrics" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "scorecard": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A Vapi scorecard." } }, "additionalProperties": false, "required": [ "scorecard" ], "description": "The scorecard created by Vapi." } }, { "id": "vapi.create_session", "service": "vapi", "name": "create_session", "description": "Create a Vapi session with either an assistant identifier or an inline assistant configuration.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "name": { "type": "string", "description": "The session name." }, "assistant": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "assistantId": { "type": "string", "description": "The identifier of an existing assistant." } }, "additionalProperties": true, "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "session": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the session." }, "name": { "type": "string", "description": "The session name." }, "assistantId": { "type": "string", "description": "The assistant identifier attached to the session." }, "orgId": { "type": "string", "description": "The organization identifier that owns the session." }, "createdAt": { "type": "string", "description": "When the session was created." }, "updatedAt": { "type": "string", "description": "When the session was last updated." } }, "additionalProperties": true, "description": "A Vapi session." } }, "additionalProperties": false, "required": [ "session" ], "description": "The session created by Vapi." } }, { "id": "vapi.delete_call", "service": "vapi", "name": "delete_call", "description": "Delete a Vapi call by its unique identifier.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The unique identifier of the target resource." } }, "additionalProperties": true, "required": [ "id" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "call": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the call." }, "status": { "type": "string", "description": "The call status reported by Vapi." }, "type": { "type": "string", "description": "The call type." }, "cost": { "type": "number", "description": "The total cost for the call." }, "duration": { "type": "number", "description": "The call duration in seconds." }, "assistantId": { "type": "string", "description": "The assistant identifier attached to the call." }, "phoneNumberId": { "type": "string", "description": "The phone number identifier attached to the call." }, "createdAt": { "type": "string", "description": "When the call was created." }, "startedAt": { "type": "string", "description": "When the call started." }, "endedAt": { "type": "string", "description": "When the call ended." }, "messages": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "A list of raw Vapi objects." }, "artifact": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." } }, "additionalProperties": true, "description": "A Vapi call." } }, "additionalProperties": false, "required": [ "call" ], "description": "The deleted call returned by Vapi." } }, { "id": "vapi.delete_chat", "service": "vapi", "name": "delete_chat", "description": "Delete a Vapi chat by its unique identifier.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The unique identifier of the target resource." } }, "additionalProperties": true, "required": [ "id" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "chat": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the chat." }, "name": { "type": "string", "description": "The chat name." }, "assistantId": { "type": "string", "description": "The assistant identifier used for the chat." }, "sessionId": { "type": "string", "description": "The session identifier attached to the chat." }, "squadId": { "type": "string", "description": "The squad identifier attached to the chat." }, "previousChatId": { "type": "string", "description": "The previous chat identifier used as context." }, "createdAt": { "type": "string", "description": "When the chat was created." }, "updatedAt": { "type": "string", "description": "When the chat was last updated." }, "messages": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "A list of raw Vapi objects." }, "input": { "description": "A raw JSON value returned by Vapi." }, "output": { "description": "A raw JSON value returned by Vapi." } }, "additionalProperties": true, "description": "A Vapi chat." } }, "additionalProperties": false, "required": [ "chat" ], "description": "The deleted chat returned by Vapi." } }, { "id": "vapi.delete_eval", "service": "vapi", "name": "delete_eval", "description": "Delete a Vapi eval by its unique identifier.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The unique identifier of the target resource." } }, "additionalProperties": true, "required": [ "id" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "eval": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A Vapi eval." } }, "additionalProperties": false, "required": [ "eval" ], "description": "The deleted eval returned by Vapi." } }, { "id": "vapi.delete_eval_run", "service": "vapi", "name": "delete_eval_run", "description": "Delete a Vapi eval run by its unique identifier.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The unique identifier of the target resource." } }, "additionalProperties": true, "required": [ "id" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "details": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The details returned after deleting an eval run." } }, "additionalProperties": false, "required": [ "details" ], "description": "The deletion details returned by Vapi." } }, { "id": "vapi.delete_phone_number", "service": "vapi", "name": "delete_phone_number", "description": "Delete a Vapi phone number by its unique identifier.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The unique identifier of the target resource." } }, "additionalProperties": true, "required": [ "id" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "phoneNumber": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the phone number." }, "name": { "type": "string", "description": "The display name of the phone number." }, "number": { "type": "string", "description": "The E.164 phone number." }, "provider": { "type": "string", "description": "The provider that manages the phone number." }, "status": { "type": "string", "description": "The phone number status reported by Vapi." }, "assistantId": { "type": "string", "description": "The assistant identifier attached to the phone number." }, "workflowId": { "type": "string", "description": "The workflow identifier attached to the phone number." }, "squadId": { "type": "string", "description": "The squad identifier attached to the phone number." }, "createdAt": { "type": "string", "description": "When the phone number was created." }, "updatedAt": { "type": "string", "description": "When the phone number was last updated." } }, "additionalProperties": true, "description": "A Vapi phone number." } }, "additionalProperties": false, "required": [ "phoneNumber" ], "description": "The deleted phone number returned by Vapi." } }, { "id": "vapi.get_assistant", "service": "vapi", "name": "get_assistant", "description": "Retrieve a Vapi assistant by its unique identifier.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The unique identifier of the target resource." } }, "additionalProperties": true, "required": [ "id" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "assistant": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the assistant." }, "name": { "type": "string", "description": "The assistant name." }, "orgId": { "type": "string", "description": "The organization identifier that owns the assistant." }, "model": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "voice": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "metadata": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "transcriber": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "createdAt": { "type": "string", "description": "When the assistant was created." }, "updatedAt": { "type": "string", "description": "When the assistant was last updated." }, "firstMessage": { "type": "string", "description": "The first message spoken by the assistant." } }, "additionalProperties": true, "description": "A Vapi assistant." } }, "additionalProperties": false, "required": [ "assistant" ], "description": "The assistant returned by Vapi." } }, { "id": "vapi.get_call", "service": "vapi", "name": "get_call", "description": "Retrieve a single Vapi call by its unique identifier.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The unique identifier of the target resource." } }, "additionalProperties": true, "required": [ "id" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "call": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the call." }, "status": { "type": "string", "description": "The call status reported by Vapi." }, "type": { "type": "string", "description": "The call type." }, "cost": { "type": "number", "description": "The total cost for the call." }, "duration": { "type": "number", "description": "The call duration in seconds." }, "assistantId": { "type": "string", "description": "The assistant identifier attached to the call." }, "phoneNumberId": { "type": "string", "description": "The phone number identifier attached to the call." }, "createdAt": { "type": "string", "description": "When the call was created." }, "startedAt": { "type": "string", "description": "When the call started." }, "endedAt": { "type": "string", "description": "When the call ended." }, "messages": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "A list of raw Vapi objects." }, "artifact": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." } }, "additionalProperties": true, "description": "A Vapi call." } }, "additionalProperties": false, "required": [ "call" ], "description": "The call returned by Vapi." } }, { "id": "vapi.get_chat", "service": "vapi", "name": "get_chat", "description": "Retrieve a Vapi chat by its unique identifier.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The unique identifier of the target resource." } }, "additionalProperties": true, "required": [ "id" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "chat": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the chat." }, "name": { "type": "string", "description": "The chat name." }, "assistantId": { "type": "string", "description": "The assistant identifier used for the chat." }, "sessionId": { "type": "string", "description": "The session identifier attached to the chat." }, "squadId": { "type": "string", "description": "The squad identifier attached to the chat." }, "previousChatId": { "type": "string", "description": "The previous chat identifier used as context." }, "createdAt": { "type": "string", "description": "When the chat was created." }, "updatedAt": { "type": "string", "description": "When the chat was last updated." }, "messages": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "A list of raw Vapi objects." }, "input": { "description": "A raw JSON value returned by Vapi." }, "output": { "description": "A raw JSON value returned by Vapi." } }, "additionalProperties": true, "description": "A Vapi chat." } }, "additionalProperties": false, "required": [ "chat" ], "description": "The chat returned by Vapi." } }, { "id": "vapi.get_eval", "service": "vapi", "name": "get_eval", "description": "Retrieve a Vapi eval by its unique identifier.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The unique identifier of the target resource." } }, "additionalProperties": true, "required": [ "id" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "eval": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A Vapi eval." } }, "additionalProperties": false, "required": [ "eval" ], "description": "The eval returned by Vapi." } }, { "id": "vapi.get_file", "service": "vapi", "name": "get_file", "description": "Retrieve Vapi file metadata by file identifier.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The unique identifier of the target resource." } }, "additionalProperties": true, "required": [ "id" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "file": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the file." }, "name": { "type": "string", "description": "The file name." }, "status": { "type": "string", "description": "The file processing status." }, "url": { "type": "string", "description": "The canonical URL of the file." }, "path": { "type": "string", "description": "The storage path of the file." }, "bytes": { "type": "integer", "description": "The file size in bytes." }, "bucket": { "type": "string", "description": "The storage bucket name." }, "mimetype": { "type": "string", "description": "The file MIME type." }, "purpose": { "type": "string", "description": "The purpose assigned to the file." }, "metadata": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "orgId": { "type": "string", "description": "The organization identifier that owns the file." }, "createdAt": { "type": "string", "description": "When the file was created." }, "updatedAt": { "type": "string", "description": "When the file was last updated." }, "parsedTextUrl": { "type": "string", "description": "The URL of the parsed text artifact." } }, "additionalProperties": true, "description": "A Vapi file." } }, "additionalProperties": false, "required": [ "file" ], "description": "The file returned by Vapi." } }, { "id": "vapi.get_tool", "service": "vapi", "name": "get_tool", "description": "Retrieve a Vapi tool by its unique identifier.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The unique identifier of the target resource." } }, "additionalProperties": true, "required": [ "id" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "tool": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A Vapi tool." } }, "additionalProperties": false, "required": [ "tool" ], "description": "The tool returned by Vapi." } }, { "id": "vapi.list_assistants", "service": "vapi", "name": "list_assistants", "description": "List Vapi assistants with optional created/updated timestamp filters and a configurable page size.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "The maximum number of items to return." }, "createdAtGe": { "type": "string", "description": "Return items created on or after this ISO 8601 date-time string." }, "createdAtGt": { "type": "string", "description": "Return items created after this ISO 8601 date-time string." }, "createdAtLe": { "type": "string", "description": "Return items created on or before this ISO 8601 date-time string." }, "createdAtLt": { "type": "string", "description": "Return items created before this ISO 8601 date-time string." }, "updatedAtGe": { "type": "string", "description": "Return items updated on or after this ISO 8601 date-time string." }, "updatedAtGt": { "type": "string", "description": "Return items updated after this ISO 8601 date-time string." }, "updatedAtLe": { "type": "string", "description": "Return items updated on or before this ISO 8601 date-time string." }, "updatedAtLt": { "type": "string", "description": "Return items updated before this ISO 8601 date-time string." } }, "additionalProperties": true, "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "assistants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the assistant." }, "name": { "type": "string", "description": "The assistant name." }, "orgId": { "type": "string", "description": "The organization identifier that owns the assistant." }, "model": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "voice": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "metadata": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "transcriber": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "createdAt": { "type": "string", "description": "When the assistant was created." }, "updatedAt": { "type": "string", "description": "When the assistant was last updated." }, "firstMessage": { "type": "string", "description": "The first message spoken by the assistant." } }, "additionalProperties": true, "description": "A Vapi assistant." }, "description": "The assistants returned by Vapi." } }, "additionalProperties": false, "required": [ "assistants" ], "description": "The output payload for this action." } }, { "id": "vapi.list_calls", "service": "vapi", "name": "list_calls", "description": "List Vapi calls with optional filtering by call, assistant, phone number, and created or updated timestamps.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "description": "Filter results by a specific call identifier." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "The maximum number of items to return." }, "assistantId": { "type": "string", "description": "Filter results by the assistant identifier." }, "phoneNumberId": { "type": "string", "description": "Filter results by the phone number identifier." }, "createdAtGe": { "type": "string", "description": "Return items created on or after this ISO 8601 date-time string." }, "createdAtGt": { "type": "string", "description": "Return items created after this ISO 8601 date-time string." }, "createdAtLe": { "type": "string", "description": "Return items created on or before this ISO 8601 date-time string." }, "createdAtLt": { "type": "string", "description": "Return items created before this ISO 8601 date-time string." }, "updatedAtGe": { "type": "string", "description": "Return items updated on or after this ISO 8601 date-time string." }, "updatedAtGt": { "type": "string", "description": "Return items updated after this ISO 8601 date-time string." }, "updatedAtLe": { "type": "string", "description": "Return items updated on or before this ISO 8601 date-time string." }, "updatedAtLt": { "type": "string", "description": "Return items updated before this ISO 8601 date-time string." } }, "additionalProperties": true, "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "calls": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the call." }, "status": { "type": "string", "description": "The call status reported by Vapi." }, "type": { "type": "string", "description": "The call type." }, "cost": { "type": "number", "description": "The total cost for the call." }, "duration": { "type": "number", "description": "The call duration in seconds." }, "assistantId": { "type": "string", "description": "The assistant identifier attached to the call." }, "phoneNumberId": { "type": "string", "description": "The phone number identifier attached to the call." }, "createdAt": { "type": "string", "description": "When the call was created." }, "startedAt": { "type": "string", "description": "When the call started." }, "endedAt": { "type": "string", "description": "When the call ended." }, "messages": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "A list of raw Vapi objects." }, "artifact": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." } }, "additionalProperties": true, "description": "A Vapi call." }, "description": "The calls returned by Vapi." } }, "additionalProperties": false, "required": [ "calls" ], "description": "The output payload for this action." } }, { "id": "vapi.list_chats", "service": "vapi", "name": "list_chats", "description": "List Vapi chats with pagination plus optional assistant, squad, session, previous chat, and timestamp filters.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "description": "Filter by identifier." }, "page": { "type": "integer", "minimum": 1, "description": "The page number for pagination." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "The maximum number of items to return." }, "sortOrder": { "type": "string", "enum": [ "ASC", "DESC" ], "description": "The sort order for pagination." }, "createdAtGe": { "type": "string", "description": "Return items created on or after this ISO 8601 date-time string." }, "createdAtGt": { "type": "string", "description": "Return items created after this ISO 8601 date-time string." }, "createdAtLe": { "type": "string", "description": "Return items created on or before this ISO 8601 date-time string." }, "createdAtLt": { "type": "string", "description": "Return items created before this ISO 8601 date-time string." }, "updatedAtGe": { "type": "string", "description": "Return items updated on or after this ISO 8601 date-time string." }, "updatedAtGt": { "type": "string", "description": "Return items updated after this ISO 8601 date-time string." }, "updatedAtLe": { "type": "string", "description": "Return items updated on or before this ISO 8601 date-time string." }, "updatedAtLt": { "type": "string", "description": "Return items updated before this ISO 8601 date-time string." }, "squadId": { "type": "string", "description": "Filter results by the squad identifier." }, "sessionId": { "type": "string", "description": "Filter results by the session identifier." }, "assistantId": { "type": "string", "description": "Filter results by the assistant identifier." }, "assistantIdAny": { "type": "string", "description": "Filter results by multiple assistant identifiers separated by commas." }, "previousChatId": { "type": "string", "description": "Filter results by the previous chat identifier." } }, "additionalProperties": true, "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "chats": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the chat." }, "name": { "type": "string", "description": "The chat name." }, "assistantId": { "type": "string", "description": "The assistant identifier used for the chat." }, "sessionId": { "type": "string", "description": "The session identifier attached to the chat." }, "squadId": { "type": "string", "description": "The squad identifier attached to the chat." }, "previousChatId": { "type": "string", "description": "The previous chat identifier used as context." }, "createdAt": { "type": "string", "description": "When the chat was created." }, "updatedAt": { "type": "string", "description": "When the chat was last updated." }, "messages": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "A list of raw Vapi objects." }, "input": { "description": "A raw JSON value returned by Vapi." }, "output": { "description": "A raw JSON value returned by Vapi." } }, "additionalProperties": true, "description": "A Vapi chat." }, "description": "The chats returned by Vapi." }, "metadata": { "type": "object", "properties": { "page": { "type": "integer", "description": "The current page number." }, "limit": { "type": "integer", "description": "The configured page size." }, "total": { "type": "integer", "description": "The total number of matching items." }, "currentPage": { "type": "integer", "description": "The current page number reported by Vapi." }, "itemsPerPage": { "type": "integer", "description": "The number of items per page reported by Vapi." }, "totalItems": { "type": "integer", "description": "The total number of items reported by Vapi." } }, "additionalProperties": true, "description": "Pagination metadata returned by Vapi." } }, "additionalProperties": false, "required": [ "chats", "metadata" ], "description": "The output payload for this action." } }, { "id": "vapi.list_evals", "service": "vapi", "name": "list_evals", "description": "List Vapi evals with pagination plus optional identifier and timestamp-based filters.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "description": "Filter by identifier." }, "page": { "type": "integer", "minimum": 1, "description": "The page number for pagination." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "The maximum number of items to return." }, "sortOrder": { "type": "string", "enum": [ "ASC", "DESC" ], "description": "The sort order for pagination." }, "createdAtGe": { "type": "string", "description": "Return items created on or after this ISO 8601 date-time string." }, "createdAtGt": { "type": "string", "description": "Return items created after this ISO 8601 date-time string." }, "createdAtLe": { "type": "string", "description": "Return items created on or before this ISO 8601 date-time string." }, "createdAtLt": { "type": "string", "description": "Return items created before this ISO 8601 date-time string." }, "updatedAtGe": { "type": "string", "description": "Return items updated on or after this ISO 8601 date-time string." }, "updatedAtGt": { "type": "string", "description": "Return items updated after this ISO 8601 date-time string." }, "updatedAtLe": { "type": "string", "description": "Return items updated on or before this ISO 8601 date-time string." }, "updatedAtLt": { "type": "string", "description": "Return items updated before this ISO 8601 date-time string." } }, "additionalProperties": true, "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "evals": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A Vapi eval." }, "description": "The evals returned by Vapi." }, "metadata": { "type": "object", "properties": { "page": { "type": "integer", "description": "The current page number." }, "limit": { "type": "integer", "description": "The configured page size." }, "total": { "type": "integer", "description": "The total number of matching items." }, "currentPage": { "type": "integer", "description": "The current page number reported by Vapi." }, "itemsPerPage": { "type": "integer", "description": "The number of items per page reported by Vapi." }, "totalItems": { "type": "integer", "description": "The total number of items reported by Vapi." } }, "additionalProperties": true, "description": "Pagination metadata returned by Vapi." } }, "additionalProperties": false, "required": [ "evals", "metadata" ], "description": "The output payload for this action." } }, { "id": "vapi.list_insights", "service": "vapi", "name": "list_insights", "description": "List Vapi insights with pagination plus optional identifier and timestamp filters.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "description": "Filter by identifier." }, "page": { "type": "integer", "minimum": 1, "description": "The page number for pagination." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "The maximum number of items to return." }, "sortOrder": { "type": "string", "enum": [ "ASC", "DESC" ], "description": "The sort order for pagination." }, "createdAtGe": { "type": "string", "description": "Return items created on or after this ISO 8601 date-time string." }, "createdAtGt": { "type": "string", "description": "Return items created after this ISO 8601 date-time string." }, "createdAtLe": { "type": "string", "description": "Return items created on or before this ISO 8601 date-time string." }, "createdAtLt": { "type": "string", "description": "Return items created before this ISO 8601 date-time string." }, "updatedAtGe": { "type": "string", "description": "Return items updated on or after this ISO 8601 date-time string." }, "updatedAtGt": { "type": "string", "description": "Return items updated after this ISO 8601 date-time string." }, "updatedAtLe": { "type": "string", "description": "Return items updated on or before this ISO 8601 date-time string." }, "updatedAtLt": { "type": "string", "description": "Return items updated before this ISO 8601 date-time string." } }, "additionalProperties": true, "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "insights": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the insight." }, "name": { "type": "string", "description": "The insight name." }, "type": { "type": "string", "description": "The visualization type for the insight." }, "groupBy": { "type": "string", "description": "The field used to group the insight." }, "queries": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "A list of raw Vapi objects." }, "formulas": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "A list of raw Vapi objects." }, "formula": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "metadata": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "timeRange": { "description": "A raw JSON value returned by Vapi." }, "orgId": { "type": "string", "description": "The organization identifier that owns the insight." }, "createdAt": { "type": "string", "description": "When the insight was created." }, "updatedAt": { "type": "string", "description": "When the insight was last updated." } }, "additionalProperties": true, "description": "A Vapi insight." }, "description": "The insights returned by Vapi." }, "metadata": { "type": "object", "properties": { "page": { "type": "integer", "description": "The current page number." }, "limit": { "type": "integer", "description": "The configured page size." }, "total": { "type": "integer", "description": "The total number of matching items." }, "currentPage": { "type": "integer", "description": "The current page number reported by Vapi." }, "itemsPerPage": { "type": "integer", "description": "The number of items per page reported by Vapi." }, "totalItems": { "type": "integer", "description": "The total number of items reported by Vapi." } }, "additionalProperties": true, "description": "Pagination metadata returned by Vapi." } }, "additionalProperties": false, "required": [ "insights", "metadata" ], "description": "The output payload for this action." } }, { "id": "vapi.list_monitoring_policies", "service": "vapi", "name": "list_monitoring_policies", "description": "List Vapi monitoring policies with optional severity, monitor, and timestamp filters.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "description": "Filter by identifier." }, "page": { "type": "integer", "minimum": 1, "description": "The page number for pagination." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "The maximum number of items to return." }, "sortOrder": { "type": "string", "enum": [ "ASC", "DESC" ], "description": "The sort order for pagination." }, "createdAtGe": { "type": "string", "description": "Return items created on or after this ISO 8601 date-time string." }, "createdAtGt": { "type": "string", "description": "Return items created after this ISO 8601 date-time string." }, "createdAtLe": { "type": "string", "description": "Return items created on or before this ISO 8601 date-time string." }, "createdAtLt": { "type": "string", "description": "Return items created before this ISO 8601 date-time string." }, "updatedAtGe": { "type": "string", "description": "Return items updated on or after this ISO 8601 date-time string." }, "updatedAtGt": { "type": "string", "description": "Return items updated after this ISO 8601 date-time string." }, "updatedAtLe": { "type": "string", "description": "Return items updated on or before this ISO 8601 date-time string." }, "updatedAtLt": { "type": "string", "description": "Return items updated before this ISO 8601 date-time string." }, "severity": { "type": "string", "enum": [ "error", "warning", "info" ], "description": "The monitoring policy severity level." }, "monitorId": { "type": "string", "description": "Filter results by monitor identifier." } }, "additionalProperties": true, "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "policies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the monitoring policy." }, "name": { "type": "string", "description": "The policy name." }, "severity": { "type": "string", "description": "The policy severity." }, "threshold": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "interval": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "schedule": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "monitorIds": { "type": "array", "items": { "type": "string", "description": "A string item." }, "description": "A list of string values." }, "lookbackWindowMinutes": { "type": "integer", "description": "The lookback window, in minutes." }, "createdAt": { "type": "string", "description": "When the policy was created." }, "updatedAt": { "type": "string", "description": "When the policy was last updated." } }, "additionalProperties": true, "description": "A Vapi monitoring policy." }, "description": "The monitoring policies returned by Vapi." } }, "additionalProperties": false, "required": [ "policies" ], "description": "The output payload for this action." } }, { "id": "vapi.list_phone_numbers", "service": "vapi", "name": "list_phone_numbers", "description": "List Vapi phone numbers with optional created and updated timestamp filters.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "The maximum number of items to return." }, "createdAtGe": { "type": "string", "description": "Return items created on or after this ISO 8601 date-time string." }, "createdAtGt": { "type": "string", "description": "Return items created after this ISO 8601 date-time string." }, "createdAtLe": { "type": "string", "description": "Return items created on or before this ISO 8601 date-time string." }, "createdAtLt": { "type": "string", "description": "Return items created before this ISO 8601 date-time string." }, "updatedAtGe": { "type": "string", "description": "Return items updated on or after this ISO 8601 date-time string." }, "updatedAtGt": { "type": "string", "description": "Return items updated after this ISO 8601 date-time string." }, "updatedAtLe": { "type": "string", "description": "Return items updated on or before this ISO 8601 date-time string." }, "updatedAtLt": { "type": "string", "description": "Return items updated before this ISO 8601 date-time string." } }, "additionalProperties": true, "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "phoneNumbers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the phone number." }, "name": { "type": "string", "description": "The display name of the phone number." }, "number": { "type": "string", "description": "The E.164 phone number." }, "provider": { "type": "string", "description": "The provider that manages the phone number." }, "status": { "type": "string", "description": "The phone number status reported by Vapi." }, "assistantId": { "type": "string", "description": "The assistant identifier attached to the phone number." }, "workflowId": { "type": "string", "description": "The workflow identifier attached to the phone number." }, "squadId": { "type": "string", "description": "The squad identifier attached to the phone number." }, "createdAt": { "type": "string", "description": "When the phone number was created." }, "updatedAt": { "type": "string", "description": "When the phone number was last updated." } }, "additionalProperties": true, "description": "A Vapi phone number." }, "description": "The phone numbers returned by Vapi." } }, "additionalProperties": false, "required": [ "phoneNumbers" ], "description": "The output payload for this action." } }, { "id": "vapi.list_provider_resources", "service": "vapi", "name": "list_provider_resources", "description": "List Vapi provider resources for a provider and resource type with optional identifier and timestamp filters.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "description": "Filter by identifier." }, "page": { "type": "integer", "minimum": 1, "description": "The page number for pagination." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "The maximum number of items to return." }, "sortOrder": { "type": "string", "enum": [ "ASC", "DESC" ], "description": "The sort order for pagination." }, "createdAtGe": { "type": "string", "description": "Return items created on or after this ISO 8601 date-time string." }, "createdAtGt": { "type": "string", "description": "Return items created after this ISO 8601 date-time string." }, "createdAtLe": { "type": "string", "description": "Return items created on or before this ISO 8601 date-time string." }, "createdAtLt": { "type": "string", "description": "Return items created before this ISO 8601 date-time string." }, "updatedAtGe": { "type": "string", "description": "Return items updated on or after this ISO 8601 date-time string." }, "updatedAtGt": { "type": "string", "description": "Return items updated after this ISO 8601 date-time string." }, "updatedAtLe": { "type": "string", "description": "Return items updated on or before this ISO 8601 date-time string." }, "updatedAtLt": { "type": "string", "description": "Return items updated before this ISO 8601 date-time string." }, "provider": { "type": "string", "enum": [ "11labs", "cartesia" ], "description": "The provider that owns the resource." }, "resourceName": { "type": "string", "description": "The provider resource type, such as pronunciation-dictionary." }, "resourceId": { "type": "string", "description": "Filter results by the provider-side resource identifier." } }, "additionalProperties": true, "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "providerResources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the provider resource." }, "provider": { "type": "string", "description": "The provider that owns the resource." }, "resourceName": { "type": "string", "description": "The provider resource type." }, "resourceId": { "type": "string", "description": "The provider-side resource identifier." }, "resource": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "orgId": { "type": "string", "description": "The organization identifier that owns the resource." }, "createdAt": { "type": "string", "description": "When the resource was created." }, "updatedAt": { "type": "string", "description": "When the resource was last updated." } }, "additionalProperties": true, "description": "A Vapi provider resource." }, "description": "The provider resources returned by Vapi." }, "metadata": { "type": "object", "properties": { "page": { "type": "integer", "description": "The current page number." }, "limit": { "type": "integer", "description": "The configured page size." }, "total": { "type": "integer", "description": "The total number of matching items." }, "currentPage": { "type": "integer", "description": "The current page number reported by Vapi." }, "itemsPerPage": { "type": "integer", "description": "The number of items per page reported by Vapi." }, "totalItems": { "type": "integer", "description": "The total number of items reported by Vapi." } }, "additionalProperties": true, "description": "Pagination metadata returned by Vapi." } }, "additionalProperties": false, "required": [ "providerResources", "metadata" ], "description": "The output payload for this action." } }, { "id": "vapi.list_scorecards", "service": "vapi", "name": "list_scorecards", "description": "List Vapi scorecards with pagination plus optional identifier and timestamp filters.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "description": "Filter by identifier." }, "page": { "type": "integer", "minimum": 1, "description": "The page number for pagination." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "The maximum number of items to return." }, "sortOrder": { "type": "string", "enum": [ "ASC", "DESC" ], "description": "The sort order for pagination." }, "createdAtGe": { "type": "string", "description": "Return items created on or after this ISO 8601 date-time string." }, "createdAtGt": { "type": "string", "description": "Return items created after this ISO 8601 date-time string." }, "createdAtLe": { "type": "string", "description": "Return items created on or before this ISO 8601 date-time string." }, "createdAtLt": { "type": "string", "description": "Return items created before this ISO 8601 date-time string." }, "updatedAtGe": { "type": "string", "description": "Return items updated on or after this ISO 8601 date-time string." }, "updatedAtGt": { "type": "string", "description": "Return items updated after this ISO 8601 date-time string." }, "updatedAtLe": { "type": "string", "description": "Return items updated on or before this ISO 8601 date-time string." }, "updatedAtLt": { "type": "string", "description": "Return items updated before this ISO 8601 date-time string." } }, "additionalProperties": true, "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "scorecards": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A Vapi scorecard." }, "description": "The scorecards returned by Vapi." }, "metadata": { "type": "object", "properties": { "page": { "type": "integer", "description": "The current page number." }, "limit": { "type": "integer", "description": "The configured page size." }, "total": { "type": "integer", "description": "The total number of matching items." }, "currentPage": { "type": "integer", "description": "The current page number reported by Vapi." }, "itemsPerPage": { "type": "integer", "description": "The number of items per page reported by Vapi." }, "totalItems": { "type": "integer", "description": "The total number of items reported by Vapi." } }, "additionalProperties": true, "description": "Pagination metadata returned by Vapi." } }, "additionalProperties": false, "required": [ "scorecards", "metadata" ], "description": "The output payload for this action." } }, { "id": "vapi.list_sessions", "service": "vapi", "name": "list_sessions", "description": "List Vapi sessions with pagination plus optional identifier, name, assistant, workflow, squad, and timestamp filters.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "description": "Filter by identifier." }, "page": { "type": "integer", "minimum": 1, "description": "The page number for pagination." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "The maximum number of items to return." }, "sortOrder": { "type": "string", "enum": [ "ASC", "DESC" ], "description": "The sort order for pagination." }, "createdAtGe": { "type": "string", "description": "Return items created on or after this ISO 8601 date-time string." }, "createdAtGt": { "type": "string", "description": "Return items created after this ISO 8601 date-time string." }, "createdAtLe": { "type": "string", "description": "Return items created on or before this ISO 8601 date-time string." }, "createdAtLt": { "type": "string", "description": "Return items created before this ISO 8601 date-time string." }, "updatedAtGe": { "type": "string", "description": "Return items updated on or after this ISO 8601 date-time string." }, "updatedAtGt": { "type": "string", "description": "Return items updated after this ISO 8601 date-time string." }, "updatedAtLe": { "type": "string", "description": "Return items updated on or before this ISO 8601 date-time string." }, "updatedAtLt": { "type": "string", "description": "Return items updated before this ISO 8601 date-time string." }, "name": { "type": "string", "description": "Filter results by a specific session name." }, "squadId": { "type": "string", "description": "Filter results by the squad identifier." }, "workflowId": { "type": "string", "description": "Filter results by the workflow identifier." }, "assistantId": { "type": "string", "description": "Filter results by the assistant identifier." }, "assistantIdAny": { "type": "string", "description": "Filter results by multiple assistant identifiers separated by commas." } }, "additionalProperties": true, "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "sessions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the session." }, "name": { "type": "string", "description": "The session name." }, "assistantId": { "type": "string", "description": "The assistant identifier attached to the session." }, "orgId": { "type": "string", "description": "The organization identifier that owns the session." }, "createdAt": { "type": "string", "description": "When the session was created." }, "updatedAt": { "type": "string", "description": "When the session was last updated." } }, "additionalProperties": true, "description": "A Vapi session." }, "description": "The sessions returned by Vapi." }, "metadata": { "type": "object", "properties": { "page": { "type": "integer", "description": "The current page number." }, "limit": { "type": "integer", "description": "The configured page size." }, "total": { "type": "integer", "description": "The total number of matching items." }, "currentPage": { "type": "integer", "description": "The current page number reported by Vapi." }, "itemsPerPage": { "type": "integer", "description": "The number of items per page reported by Vapi." }, "totalItems": { "type": "integer", "description": "The total number of items reported by Vapi." } }, "additionalProperties": true, "description": "Pagination metadata returned by Vapi." } }, "additionalProperties": false, "required": [ "sessions", "metadata" ], "description": "The output payload for this action." } }, { "id": "vapi.list_structured_outputs", "service": "vapi", "name": "list_structured_outputs", "description": "List Vapi structured outputs with pagination plus optional identifier, name, and timestamp filters.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "description": "Filter by identifier." }, "page": { "type": "integer", "minimum": 1, "description": "The page number for pagination." }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "The maximum number of items to return." }, "sortOrder": { "type": "string", "enum": [ "ASC", "DESC" ], "description": "The sort order for pagination." }, "createdAtGe": { "type": "string", "description": "Return items created on or after this ISO 8601 date-time string." }, "createdAtGt": { "type": "string", "description": "Return items created after this ISO 8601 date-time string." }, "createdAtLe": { "type": "string", "description": "Return items created on or before this ISO 8601 date-time string." }, "createdAtLt": { "type": "string", "description": "Return items created before this ISO 8601 date-time string." }, "updatedAtGe": { "type": "string", "description": "Return items updated on or after this ISO 8601 date-time string." }, "updatedAtGt": { "type": "string", "description": "Return items updated after this ISO 8601 date-time string." }, "updatedAtLe": { "type": "string", "description": "Return items updated on or before this ISO 8601 date-time string." }, "updatedAtLt": { "type": "string", "description": "Return items updated before this ISO 8601 date-time string." }, "name": { "type": "string", "description": "Filter results by a specific structured output name." } }, "additionalProperties": true, "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "structuredOutputs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the structured output." }, "name": { "type": "string", "description": "The structured output name." }, "schema": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "createdAt": { "type": "string", "description": "When the structured output was created." }, "updatedAt": { "type": "string", "description": "When the structured output was last updated." } }, "additionalProperties": true, "description": "A Vapi structured output definition." }, "description": "The structured outputs returned by Vapi." }, "metadata": { "type": "object", "properties": { "page": { "type": "integer", "description": "The current page number." }, "limit": { "type": "integer", "description": "The configured page size." }, "total": { "type": "integer", "description": "The total number of matching items." }, "currentPage": { "type": "integer", "description": "The current page number reported by Vapi." }, "itemsPerPage": { "type": "integer", "description": "The number of items per page reported by Vapi." }, "totalItems": { "type": "integer", "description": "The total number of items reported by Vapi." } }, "additionalProperties": true, "description": "Pagination metadata returned by Vapi." } }, "additionalProperties": false, "required": [ "structuredOutputs", "metadata" ], "description": "The output payload for this action." } }, { "id": "vapi.test_code_tool_execution", "service": "vapi", "name": "test_code_tool_execution", "description": "Execute TypeScript code inside Vapi's code tool sandbox and return the logs, result, and execution outcome.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "code": { "type": "string", "description": "The TypeScript code that should be executed in Vapi's sandbox." } }, "additionalProperties": true, "required": [ "code" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Whether the code execution completed successfully." }, "result": { "description": "A raw JSON value returned by Vapi." }, "error": { "type": "string", "description": "The error message returned by the execution." }, "logs": { "type": "array", "items": { "type": "string", "description": "A log line emitted during execution." }, "description": "Console logs emitted during execution." }, "executionTimeMs": { "type": "number", "description": "The execution duration in milliseconds." } }, "additionalProperties": false, "description": "The result of testing code in Vapi's code tool environment." } }, { "id": "vapi.update_assistant", "service": "vapi", "name": "update_assistant", "description": "Update an existing Vapi assistant and keep only the fields that should change in the request body.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The unique identifier of the target resource." }, "name": { "type": "string", "description": "The updated assistant name." }, "model": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "voice": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "metadata": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "serverUrl": { "type": "string", "description": "The server URL that should receive assistant events." }, "messagePlan": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "monitorPlan": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "transcriber": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "analysisPlan": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "artifactPlan": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "firstMessage": { "type": "string", "description": "The first message that the assistant should say." }, "hipaaEnabled": { "type": "boolean", "description": "Whether HIPAA mode should be enabled." }, "credentialIds": { "type": "array", "items": { "type": "string", "description": "A string item." }, "description": "A list of string values." }, "clientMessages": { "type": "array", "items": { "type": "string", "description": "A string item." }, "description": "A list of string values." }, "maxDurationPlan": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "serverMessages": { "type": "array", "items": { "type": "string", "description": "A string item." }, "description": "A list of string values." }, "backgroundSound": { "type": "string", "description": "The background sound profile to use during calls." }, "endCallMessage": { "type": "string", "description": "The message spoken before ending the call." }, "endCallPhrases": { "type": "array", "items": { "type": "string", "description": "A string item." }, "description": "A list of string values." }, "stopSpeakingPlan": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "serverUrlSecret": { "type": "string", "description": "The secret used to authenticate requests to the server URL." }, "startSpeakingPlan": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "voicemailMessage": { "type": "string", "description": "The message spoken when voicemail is detected." }, "firstMessageMode": { "type": "string", "description": "Whether the assistant should speak first or wait for the user." }, "backchannelEnabled": { "type": "boolean", "description": "Whether verbal backchannel acknowledgments are enabled." }, "maxDurationSeconds": { "type": "integer", "description": "The maximum call duration in seconds." }, "responseDelaySeconds": { "type": "number", "description": "The delay before the assistant responds." }, "silenceTimeoutSeconds": { "type": "integer", "description": "The silence timeout, in seconds." }, "transportConfigurations": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "A list of raw Vapi objects." }, "llmRequestDelaySeconds": { "type": "number", "description": "The delay before sending LLM requests." }, "backgroundDenoisingEnabled": { "type": "boolean", "description": "Whether background denoising is enabled." }, "modelOutputInMessagesEnabled": { "type": "boolean", "description": "Whether model output should be included in message payloads." }, "numWordsToInterruptAssistant": { "type": "integer", "description": "The number of spoken words required to interrupt the assistant." } }, "additionalProperties": true, "required": [ "id" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "assistant": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the assistant." }, "name": { "type": "string", "description": "The assistant name." }, "orgId": { "type": "string", "description": "The organization identifier that owns the assistant." }, "model": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "voice": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "metadata": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "transcriber": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "createdAt": { "type": "string", "description": "When the assistant was created." }, "updatedAt": { "type": "string", "description": "When the assistant was last updated." }, "firstMessage": { "type": "string", "description": "The first message spoken by the assistant." } }, "additionalProperties": true, "description": "A Vapi assistant." } }, "additionalProperties": false, "required": [ "assistant" ], "description": "The updated assistant returned by Vapi." } }, { "id": "vapi.update_eval", "service": "vapi", "name": "update_eval", "description": "Update a Vapi eval and keep only the fields that should change in the request body.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The unique identifier of the target resource." }, "name": { "type": "string", "description": "The updated eval name." }, "type": { "type": "string", "description": "The updated eval type." }, "messages": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "A list of raw Vapi objects." }, "description": { "type": "string", "description": "The updated eval description." } }, "additionalProperties": true, "required": [ "id" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "eval": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A Vapi eval." } }, "additionalProperties": false, "required": [ "eval" ], "description": "The updated eval returned by Vapi." } }, { "id": "vapi.update_insight", "service": "vapi", "name": "update_insight", "description": "Update a Vapi insight by replacing its name, queries, formulas, grouping, and time range settings.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The unique identifier of the target resource." }, "name": { "type": "string", "description": "The updated insight name." }, "type": { "type": "string", "description": "The updated insight type." }, "formula": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "groupBy": { "type": "string", "description": "The grouping field for the insight." }, "queries": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "The updated query definitions.", "minItems": 1 }, "formulas": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "A list of raw Vapi objects." }, "metadata": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "timeRange": { "anyOf": [ { "type": "string", "description": "A named time range." }, { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." } ], "description": "The updated time range for the insight." } }, "additionalProperties": true, "required": [ "id", "type", "queries" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "insight": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the insight." }, "name": { "type": "string", "description": "The insight name." }, "type": { "type": "string", "description": "The visualization type for the insight." }, "groupBy": { "type": "string", "description": "The field used to group the insight." }, "queries": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "A list of raw Vapi objects." }, "formulas": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "A list of raw Vapi objects." }, "formula": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "metadata": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "timeRange": { "description": "A raw JSON value returned by Vapi." }, "orgId": { "type": "string", "description": "The organization identifier that owns the insight." }, "createdAt": { "type": "string", "description": "When the insight was created." }, "updatedAt": { "type": "string", "description": "When the insight was last updated." } }, "additionalProperties": true, "description": "A Vapi insight." } }, "additionalProperties": false, "required": [ "insight" ], "description": "The updated insight returned by Vapi." } }, { "id": "vapi.update_phone_number", "service": "vapi", "name": "update_phone_number", "description": "Update a Vapi phone number and keep only the fields that should change in the request body.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The unique identifier of the target resource." }, "name": { "type": "string", "description": "The updated display name of the phone number." }, "hooks": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "A list of raw Vapi objects." }, "number": { "type": "string", "description": "The updated E.164 phone number." }, "server": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "sipUri": { "type": "string", "description": "The updated SIP URI." }, "squadId": { "type": "string", "description": "The updated squad identifier." }, "smsEnabled": { "type": "boolean", "description": "Whether SMS is enabled." }, "workflowId": { "type": "string", "description": "The updated workflow identifier." }, "assistantId": { "type": "string", "description": "The updated assistant identifier." }, "credentialId": { "type": "string", "description": "The updated credential identifier." }, "authentication": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "twilioApiKey": { "type": "string", "description": "The updated Twilio API key." }, "twilioApiSecret": { "type": "string", "description": "The updated Twilio API secret." }, "twilioAuthToken": { "type": "string", "description": "The updated Twilio auth token." }, "twilioAccountSid": { "type": "string", "description": "The updated Twilio account SID." }, "fallbackDestination": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "numberE164CheckEnabled": { "type": "boolean", "description": "Whether E.164 validation is enabled." } }, "additionalProperties": true, "required": [ "id" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "phoneNumber": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the phone number." }, "name": { "type": "string", "description": "The display name of the phone number." }, "number": { "type": "string", "description": "The E.164 phone number." }, "provider": { "type": "string", "description": "The provider that manages the phone number." }, "status": { "type": "string", "description": "The phone number status reported by Vapi." }, "assistantId": { "type": "string", "description": "The assistant identifier attached to the phone number." }, "workflowId": { "type": "string", "description": "The workflow identifier attached to the phone number." }, "squadId": { "type": "string", "description": "The squad identifier attached to the phone number." }, "createdAt": { "type": "string", "description": "When the phone number was created." }, "updatedAt": { "type": "string", "description": "When the phone number was last updated." } }, "additionalProperties": true, "description": "A Vapi phone number." } }, "additionalProperties": false, "required": [ "phoneNumber" ], "description": "The updated phone number returned by Vapi." } }, { "id": "vapi.update_tool", "service": "vapi", "name": "update_tool", "description": "Update a Vapi tool configuration, including function definitions, HTTP request settings, and retry policies.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The unique identifier of the target resource." }, "url": { "type": "string", "description": "The request URL for apiRequest tools." }, "type": { "type": "string", "description": "The tool type." }, "async": { "type": "boolean", "description": "Whether the tool executes asynchronously." }, "method": { "type": "string", "description": "The HTTP method for apiRequest tools." }, "server": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "function": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "messages": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "A list of raw Vapi objects." }, "backoffPlan": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "destinations": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "description": "A list of raw Vapi objects." }, "rejectionPlan": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "variableExtractionPlan": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." } }, "additionalProperties": true, "required": [ "id" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "tool": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A Vapi tool." } }, "additionalProperties": false, "required": [ "tool" ], "description": "The updated tool returned by Vapi." } }, { "id": "vapi.upload_file", "service": "vapi", "name": "upload_file", "description": "Upload a file to Vapi knowledge storage from a public URL or base64 payload and return the resulting file metadata.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "file": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "description": "The filename that will be uploaded to Vapi." }, "mimetype": { "type": "string", "description": "The MIME type of the uploaded file." }, "url": { "type": "string", "description": "A public URL that the local runtime fetches before uploading to Vapi.", "format": "uri" }, "contentBase64": { "type": "string", "description": "Base64-encoded file content used when no public URL is available." } }, "additionalProperties": false, "required": [ "name" ], "description": "A file payload to upload to Vapi." } }, "additionalProperties": true, "required": [ "file" ], "description": "The input payload for this action." }, "outputSchema": { "type": "object", "properties": { "file": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the file." }, "name": { "type": "string", "description": "The file name." }, "status": { "type": "string", "description": "The file processing status." }, "url": { "type": "string", "description": "The canonical URL of the file." }, "path": { "type": "string", "description": "The storage path of the file." }, "bytes": { "type": "integer", "description": "The file size in bytes." }, "bucket": { "type": "string", "description": "The storage bucket name." }, "mimetype": { "type": "string", "description": "The file MIME type." }, "purpose": { "type": "string", "description": "The purpose assigned to the file." }, "metadata": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw JSON object returned by Vapi." }, "orgId": { "type": "string", "description": "The organization identifier that owns the file." }, "createdAt": { "type": "string", "description": "When the file was created." }, "updatedAt": { "type": "string", "description": "When the file was last updated." }, "parsedTextUrl": { "type": "string", "description": "The URL of the parsed text artifact." } }, "additionalProperties": true, "description": "A Vapi file." } }, "additionalProperties": false, "required": [ "file" ], "description": "The uploaded file returned by Vapi." } } ] }