Vapi integration (AI, Communication). Imported from open-connector.
https://api.vapi.ai/assistant
| Param | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | The maximum number of items to return. |
| createdAtGe | string | optional | Return items created on or after this ISO 8601 date-time string. |
| createdAtGt | string | optional | Return items created after this ISO 8601 date-time string. |
| createdAtLe | string | optional | Return items created on or before this ISO 8601 date-time string. |
| createdAtLt | string | optional | Return items created before this ISO 8601 date-time string. |
| updatedAtGe | string | optional | Return items updated on or after this ISO 8601 date-time string. |
| updatedAtGt | string | optional | Return items updated after this ISO 8601 date-time string. |
| updatedAtLe | string | optional | Return items updated on or before this ISO 8601 date-time string. |
| updatedAtLt | string | optional | Return items updated before this ISO 8601 date-time string. |
/assistant
| Param | Type | Required | Description |
|---|---|---|---|
| name | string | optional | Assistant identifier or display name. |
| model | object | required | A raw JSON object returned by Vapi. |
| voice | object | required | A raw JSON object returned by Vapi. |
| transcriber | object | required | A raw JSON object returned by Vapi. |
| firstMessage | string | optional | The first message the assistant should say. |
| systemPrompt | string | optional | The system prompt that controls assistant behavior. |
| clientMessages | array | optional | A list of string values. |
| serverMessages | array | optional | A list of string values. |
| maxDurationSeconds | integer | optional | The maximum call duration in seconds. |
| voicemailDetection | object | optional | A raw JSON object returned by Vapi. |
/assistant/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The unique identifier of the target resource. |
/assistant/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The unique identifier of the target resource. |
| name | string | optional | The updated assistant name. |
| model | object | optional | A raw JSON object returned by Vapi. |
| voice | object | optional | A raw JSON object returned by Vapi. |
| metadata | object | optional | A raw JSON object returned by Vapi. |
| serverUrl | string | optional | The server URL that should receive assistant events. |
| messagePlan | object | optional | A raw JSON object returned by Vapi. |
| monitorPlan | object | optional | A raw JSON object returned by Vapi. |
| transcriber | object | optional | A raw JSON object returned by Vapi. |
| analysisPlan | object | optional | A raw JSON object returned by Vapi. |
| artifactPlan | object | optional | A raw JSON object returned by Vapi. |
| firstMessage | string | optional | The first message that the assistant should say. |
| hipaaEnabled | boolean | optional | Whether HIPAA mode should be enabled. |
| credentialIds | array | optional | A list of string values. |
| clientMessages | array | optional | A list of string values. |
| maxDurationPlan | object | optional | A raw JSON object returned by Vapi. |
| serverMessages | array | optional | A list of string values. |
| backgroundSound | string | optional | The background sound profile to use during calls. |
| endCallMessage | string | optional | The message spoken before ending the call. |
| endCallPhrases | array | optional | A list of string values. |
| stopSpeakingPlan | object | optional | A raw JSON object returned by Vapi. |
| serverUrlSecret | string | optional | The secret used to authenticate requests to the server URL. |
| startSpeakingPlan | object | optional | A raw JSON object returned by Vapi. |
| voicemailMessage | string | optional | The message spoken when voicemail is detected. |
| firstMessageMode | string | optional | Whether the assistant should speak first or wait for the user. |
| backchannelEnabled | boolean | optional | Whether verbal backchannel acknowledgments are enabled. |
| maxDurationSeconds | integer | optional | The maximum call duration in seconds. |
| responseDelaySeconds | number | optional | The delay before the assistant responds. |
| silenceTimeoutSeconds | integer | optional | The silence timeout, in seconds. |
| transportConfigurations | array | optional | A list of raw Vapi objects. |
| llmRequestDelaySeconds | number | optional | The delay before sending LLM requests. |
| backgroundDenoisingEnabled | boolean | optional | Whether background denoising is enabled. |
| modelOutputInMessagesEnabled | boolean | optional | Whether model output should be included in message payloads. |
| numWordsToInterruptAssistant | integer | optional | The number of spoken words required to interrupt the assistant. |
/call
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | optional | Filter results by a specific call identifier. |
| limit | integer | optional | The maximum number of items to return. |
| assistantId | string | optional | Filter results by the assistant identifier. |
| phoneNumberId | string | optional | Filter results by the phone number identifier. |
| createdAtGe | string | optional | Return items created on or after this ISO 8601 date-time string. |
| createdAtGt | string | optional | Return items created after this ISO 8601 date-time string. |
| createdAtLe | string | optional | Return items created on or before this ISO 8601 date-time string. |
| createdAtLt | string | optional | Return items created before this ISO 8601 date-time string. |
| updatedAtGe | string | optional | Return items updated on or after this ISO 8601 date-time string. |
| updatedAtGt | string | optional | Return items updated after this ISO 8601 date-time string. |
| updatedAtLe | string | optional | Return items updated on or before this ISO 8601 date-time string. |
| updatedAtLt | string | optional | Return items updated before this ISO 8601 date-time string. |
/call/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The unique identifier of the target resource. |
/call/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The unique identifier of the target resource. |
/chat
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | optional | Filter by identifier. |
| page | integer | optional | The page number for pagination. |
| limit | integer | optional | The maximum number of items to return. |
| sortOrder | string | optional | The sort order for pagination. |
| createdAtGe | string | optional | Return items created on or after this ISO 8601 date-time string. |
| createdAtGt | string | optional | Return items created after this ISO 8601 date-time string. |
| createdAtLe | string | optional | Return items created on or before this ISO 8601 date-time string. |
| createdAtLt | string | optional | Return items created before this ISO 8601 date-time string. |
| updatedAtGe | string | optional | Return items updated on or after this ISO 8601 date-time string. |
| updatedAtGt | string | optional | Return items updated after this ISO 8601 date-time string. |
| updatedAtLe | string | optional | Return items updated on or before this ISO 8601 date-time string. |
| updatedAtLt | string | optional | Return items updated before this ISO 8601 date-time string. |
| squadId | string | optional | Filter results by the squad identifier. |
| sessionId | string | optional | Filter results by the session identifier. |
| assistantId | string | optional | Filter results by the assistant identifier. |
| assistantIdAny | string | optional | Filter results by multiple assistant identifiers separated by commas. |
| previousChatId | string | optional | Filter results by the previous chat identifier. |
/chat/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The unique identifier of the target resource. |
/chat/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The unique identifier of the target resource. |
/chat/responses
| Param | Type | Required | Description |
|---|---|---|---|
| name | string | optional | The chat name for reference. |
| input | string | required | The input text or messages for the chat. |
| squad | object | optional | A raw JSON object returned by Vapi. |
| stream | boolean | optional | Whether Vapi should stream the response. This connector only supports false. |
| squadId | string | optional | The identifier of an existing squad. |
| assistant | object | optional | A raw JSON object returned by Vapi. |
| sessionId | string | optional | The identifier of an existing session. |
| transport | object | optional | A raw JSON object returned by Vapi. |
| assistantId | string | optional | The identifier of an existing assistant. |
| previousChatId | string | optional | The previous chat identifier used as conversation context. |
| assistantOverrides | object | optional | A raw JSON object returned by Vapi. |
/analytics
| Param | Type | Required | Description |
|---|---|---|---|
| queries | array | required | The analytics queries to execute. |
/eval
| Param | Type | Required | Description |
|---|---|---|---|
| name | string | optional | The eval name. |
| type | string | optional | The eval type. |
| messages | array | required | The mock conversation and evaluation messages. |
| description | string | optional | The eval description. |
/eval/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The unique identifier of the target resource. |
/eval/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The unique identifier of the target resource. |
| name | string | optional | The updated eval name. |
| type | string | optional | The updated eval type. |
| messages | array | optional | A list of raw Vapi objects. |
| description | string | optional | The updated eval description. |
/eval/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The unique identifier of the target resource. |
/eval/run/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The unique identifier of the target resource. |
/eval
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | optional | Filter by identifier. |
| page | integer | optional | The page number for pagination. |
| limit | integer | optional | The maximum number of items to return. |
| sortOrder | string | optional | The sort order for pagination. |
| createdAtGe | string | optional | Return items created on or after this ISO 8601 date-time string. |
| createdAtGt | string | optional | Return items created after this ISO 8601 date-time string. |
| createdAtLe | string | optional | Return items created on or before this ISO 8601 date-time string. |
| createdAtLt | string | optional | Return items created before this ISO 8601 date-time string. |
| updatedAtGe | string | optional | Return items updated on or after this ISO 8601 date-time string. |
| updatedAtGt | string | optional | Return items updated after this ISO 8601 date-time string. |
| updatedAtLe | string | optional | Return items updated on or before this ISO 8601 date-time string. |
| updatedAtLt | string | optional | Return items updated before this ISO 8601 date-time string. |
/file/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The unique identifier of the target resource. |
/file
| Param | Type | Required | Description |
|---|---|---|---|
| file | object | required | A file payload to upload to Vapi. |
/monitoring/policy
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | optional | Filter by identifier. |
| page | integer | optional | The page number for pagination. |
| limit | integer | optional | The maximum number of items to return. |
| sortOrder | string | optional | The sort order for pagination. |
| createdAtGe | string | optional | Return items created on or after this ISO 8601 date-time string. |
| createdAtGt | string | optional | Return items created after this ISO 8601 date-time string. |
| createdAtLe | string | optional | Return items created on or before this ISO 8601 date-time string. |
| createdAtLt | string | optional | Return items created before this ISO 8601 date-time string. |
| updatedAtGe | string | optional | Return items updated on or after this ISO 8601 date-time string. |
| updatedAtGt | string | optional | Return items updated after this ISO 8601 date-time string. |
| updatedAtLe | string | optional | Return items updated on or before this ISO 8601 date-time string. |
| updatedAtLt | string | optional | Return items updated before this ISO 8601 date-time string. |
| severity | string | optional | The monitoring policy severity level. |
| monitorId | string | optional | Filter results by monitor identifier. |
/monitoring/policy
| Param | Type | Required | Description |
|---|---|---|---|
| name | string | required | The policy name. |
| interval | object | optional | A raw JSON object returned by Vapi. |
| schedule | object | optional | A raw JSON object returned by Vapi. |
| severity | string | required | The severity level of the policy. |
| threshold | object | required | A raw JSON object returned by Vapi. |
| monitorIds | array | optional | A list of string values. |
| lookbackWindowMinutes | integer | required | The lookback window, in minutes. |
/provider/{provider}/{resourceName}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | optional | Filter by identifier. |
| page | integer | optional | The page number for pagination. |
| limit | integer | optional | The maximum number of items to return. |
| sortOrder | string | optional | The sort order for pagination. |
| createdAtGe | string | optional | Return items created on or after this ISO 8601 date-time string. |
| createdAtGt | string | optional | Return items created after this ISO 8601 date-time string. |
| createdAtLe | string | optional | Return items created on or before this ISO 8601 date-time string. |
| createdAtLt | string | optional | Return items created before this ISO 8601 date-time string. |
| updatedAtGe | string | optional | Return items updated on or after this ISO 8601 date-time string. |
| updatedAtGt | string | optional | Return items updated after this ISO 8601 date-time string. |
| updatedAtLe | string | optional | Return items updated on or before this ISO 8601 date-time string. |
| updatedAtLt | string | optional | Return items updated before this ISO 8601 date-time string. |
| provider | string | required | The provider that owns the resource. |
| resourceName | string | required | The provider resource type, such as pronunciation-dictionary. |
| resourceId | string | optional | Filter results by the provider-side resource identifier. |
/provider/{provider}/{resourceName}
| Param | Type | Required | Description |
|---|---|---|---|
| provider | string | required | The provider that should own the resource. Defaults to 11labs. |
| resourceName | string | required | The provider resource type. Defaults to pronunciation-dictionary. |
| name | string | required | The display name of the pronunciation dictionary. |
| rules | array | required | The pronunciation rules to create. |
/phone-number
| Param | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | The maximum number of items to return. |
| createdAtGe | string | optional | Return items created on or after this ISO 8601 date-time string. |
| createdAtGt | string | optional | Return items created after this ISO 8601 date-time string. |
| createdAtLe | string | optional | Return items created on or before this ISO 8601 date-time string. |
| createdAtLt | string | optional | Return items created before this ISO 8601 date-time string. |
| updatedAtGe | string | optional | Return items updated on or after this ISO 8601 date-time string. |
| updatedAtGt | string | optional | Return items updated after this ISO 8601 date-time string. |
| updatedAtLe | string | optional | Return items updated on or before this ISO 8601 date-time string. |
| updatedAtLt | string | optional | Return items updated before this ISO 8601 date-time string. |
/phone-number
| Param | Type | Required | Description |
|---|---|---|---|
| name | string | optional | The display name of the phone number. |
| number | string | optional | The E.164 phone number, when the provider requires one. |
| sipUri | string | optional | The SIP URI used by Vapi-managed SIP numbers. |
| provider | string | required | The phone number provider. |
| squadId | string | optional | The squad identifier attached to the phone number. |
| smsEnabled | boolean | optional | Whether SMS is enabled for the phone number. |
| workflowId | string | optional | The workflow identifier attached to the phone number. |
| assistantId | string | optional | The assistant identifier attached to the phone number. |
| credentialId | string | optional | The credential identifier used by the phone provider. |
| twilioApiKey | string | optional | The Twilio API key. |
| twilioApiSecret | string | optional | The Twilio API secret. |
| twilioAuthToken | string | optional | The Twilio auth token. |
| twilioAccountSid | string | optional | The Twilio account SID. |
| numberDesiredAreaCode | string | optional | The desired area code when Vapi provisions a number automatically. |
| numberE164CheckEnabled | boolean | optional | Whether E.164 validation should be enforced. |
/phone-number/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The unique identifier of the target resource. |
| name | string | optional | The updated display name of the phone number. |
| hooks | array | optional | A list of raw Vapi objects. |
| number | string | optional | The updated E.164 phone number. |
| server | object | optional | A raw JSON object returned by Vapi. |
| sipUri | string | optional | The updated SIP URI. |
| squadId | string | optional | The updated squad identifier. |
| smsEnabled | boolean | optional | Whether SMS is enabled. |
| workflowId | string | optional | The updated workflow identifier. |
| assistantId | string | optional | The updated assistant identifier. |
| credentialId | string | optional | The updated credential identifier. |
| authentication | object | optional | A raw JSON object returned by Vapi. |
| twilioApiKey | string | optional | The updated Twilio API key. |
| twilioApiSecret | string | optional | The updated Twilio API secret. |
| twilioAuthToken | string | optional | The updated Twilio auth token. |
| twilioAccountSid | string | optional | The updated Twilio account SID. |
| fallbackDestination | object | optional | A raw JSON object returned by Vapi. |
| numberE164CheckEnabled | boolean | optional | Whether E.164 validation is enabled. |
/phone-number/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The unique identifier of the target resource. |
/structured-output
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | optional | Filter by identifier. |
| page | integer | optional | The page number for pagination. |
| limit | integer | optional | The maximum number of items to return. |
| sortOrder | string | optional | The sort order for pagination. |
| createdAtGe | string | optional | Return items created on or after this ISO 8601 date-time string. |
| createdAtGt | string | optional | Return items created after this ISO 8601 date-time string. |
| createdAtLe | string | optional | Return items created on or before this ISO 8601 date-time string. |
| createdAtLt | string | optional | Return items created before this ISO 8601 date-time string. |
| updatedAtGe | string | optional | Return items updated on or after this ISO 8601 date-time string. |
| updatedAtGt | string | optional | Return items updated after this ISO 8601 date-time string. |
| updatedAtLe | string | optional | Return items updated on or before this ISO 8601 date-time string. |
| updatedAtLt | string | optional | Return items updated before this ISO 8601 date-time string. |
| name | string | optional | Filter results by a specific structured output name. |
/reporting/insight
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | optional | Filter by identifier. |
| page | integer | optional | The page number for pagination. |
| limit | integer | optional | The maximum number of items to return. |
| sortOrder | string | optional | The sort order for pagination. |
| createdAtGe | string | optional | Return items created on or after this ISO 8601 date-time string. |
| createdAtGt | string | optional | Return items created after this ISO 8601 date-time string. |
| createdAtLe | string | optional | Return items created on or before this ISO 8601 date-time string. |
| createdAtLt | string | optional | Return items created before this ISO 8601 date-time string. |
| updatedAtGe | string | optional | Return items updated on or after this ISO 8601 date-time string. |
| updatedAtGt | string | optional | Return items updated after this ISO 8601 date-time string. |
| updatedAtLe | string | optional | Return items updated on or before this ISO 8601 date-time string. |
| updatedAtLt | string | optional | Return items updated before this ISO 8601 date-time string. |
/reporting/insight/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The unique identifier of the target resource. |
| name | string | optional | The updated insight name. |
| type | string | required | The updated insight type. |
| formula | object | optional | A raw JSON object returned by Vapi. |
| groupBy | string | optional | The grouping field for the insight. |
| queries | array | required | The updated query definitions. |
| formulas | array | optional | A list of raw Vapi objects. |
| metadata | object | optional | A raw JSON object returned by Vapi. |
| timeRange | string | optional | The updated time range for the insight. |
/observability/scorecard
| Param | Type | Required | Description |
|---|---|---|---|
| name | string | optional | The scorecard name. |
| metrics | array | required | The scorecard metrics. |
| description | string | optional | The scorecard description. |
| assistantIds | array | optional | A list of string values. |
/observability/scorecard
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | optional | Filter by identifier. |
| page | integer | optional | The page number for pagination. |
| limit | integer | optional | The maximum number of items to return. |
| sortOrder | string | optional | The sort order for pagination. |
| createdAtGe | string | optional | Return items created on or after this ISO 8601 date-time string. |
| createdAtGt | string | optional | Return items created after this ISO 8601 date-time string. |
| createdAtLe | string | optional | Return items created on or before this ISO 8601 date-time string. |
| createdAtLt | string | optional | Return items created before this ISO 8601 date-time string. |
| updatedAtGe | string | optional | Return items updated on or after this ISO 8601 date-time string. |
| updatedAtGt | string | optional | Return items updated after this ISO 8601 date-time string. |
| updatedAtLe | string | optional | Return items updated on or before this ISO 8601 date-time string. |
| updatedAtLt | string | optional | Return items updated before this ISO 8601 date-time string. |
/session
| Param | Type | Required | Description |
|---|---|---|---|
| name | string | optional | The session name. |
| assistant | object | optional | A raw JSON object returned by Vapi. |
| assistantId | string | optional | The identifier of an existing assistant. |
/session
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | optional | Filter by identifier. |
| page | integer | optional | The page number for pagination. |
| limit | integer | optional | The maximum number of items to return. |
| sortOrder | string | optional | The sort order for pagination. |
| createdAtGe | string | optional | Return items created on or after this ISO 8601 date-time string. |
| createdAtGt | string | optional | Return items created after this ISO 8601 date-time string. |
| createdAtLe | string | optional | Return items created on or before this ISO 8601 date-time string. |
| createdAtLt | string | optional | Return items created before this ISO 8601 date-time string. |
| updatedAtGe | string | optional | Return items updated on or after this ISO 8601 date-time string. |
| updatedAtGt | string | optional | Return items updated after this ISO 8601 date-time string. |
| updatedAtLe | string | optional | Return items updated on or before this ISO 8601 date-time string. |
| updatedAtLt | string | optional | Return items updated before this ISO 8601 date-time string. |
| name | string | optional | Filter results by a specific session name. |
| squadId | string | optional | Filter results by the squad identifier. |
| workflowId | string | optional | Filter results by the workflow identifier. |
| assistantId | string | optional | Filter results by the assistant identifier. |
| assistantIdAny | string | optional | Filter results by multiple assistant identifiers separated by commas. |
/tool/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The unique identifier of the target resource. |
/tool/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The unique identifier of the target resource. |
| url | string | optional | The request URL for apiRequest tools. |
| type | string | optional | The tool type. |
| async | boolean | optional | Whether the tool executes asynchronously. |
| method | string | optional | The HTTP method for apiRequest tools. |
| server | object | optional | A raw JSON object returned by Vapi. |
| function | object | optional | A raw JSON object returned by Vapi. |
| messages | array | optional | A list of raw Vapi objects. |
| backoffPlan | object | optional | A raw JSON object returned by Vapi. |
| destinations | array | optional | A list of raw Vapi objects. |
| rejectionPlan | object | optional | A raw JSON object returned by Vapi. |
| variableExtractionPlan | object | optional | A raw JSON object returned by Vapi. |
/tool/test
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | required | The TypeScript code that should be executed in Vapi's sandbox. |