Create Tool

Creates a new tool in Vapi.

POST

Body

Arguments

stringrequired

Discriminator value: apiRequest

array of object

These are the messages that will be spoken to the user as the tool is running.

For some tools, this is auto-filled based on special fields like tool.destinations. For others like the function tool, these can be custom configured.

stringrequired

number

This is the timeout in seconds for the request. Defaults to 20 seconds. @default 20

string

The credential ID for API request authentication

array of string

This is the paths to encrypt in the request body if credentialId and encryptionPlan are defined.

string

This is the name of the tool. This will be passed to the model. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.

string

This is the description of the tool. This will be passed to the model.

stringrequired

This is where the request will be sent.

object

array of object

Static key-value pairs merged into the request body or function arguments. Values support Liquid templates.

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

curl --request POST \ --url "https://connect.mindcloud.co/v2/universal/apps/vapi/actions/create-tool/run" \ --header "Authorization: Bearer $MINDCLOUD_API_TOKEN" \ --header "Content-Type: application/json" \ --data '{ "version": "0.0.6", "arguments": { "type": "", "method": "", "url": "" } }'

{ "success": true, "data": [ { "backoffPlan": {}, "body": {}, "createdAt": "string", "credentialId": "string", "description": "string", "encryptedPaths": [ "string" ], "headers": {}, "id": "string", "messages": [ {} ], "method": "string", "name": "Ava Chen", "orgId": "string", "parameters": [ {} ], "rejectionPlan": {}, "timeoutSeconds": 1, "type": "string", "updatedAt": "string", "url": "https://example.com", "variableExtractionPlan": {} } ], "meta": {} }

Body

Every app you connect,one REST pattern