Skip to main content
GET
/
tool
/
{id}
Get Tool
curl --request GET \
  --url https://api.vapi.ai/tool/{id} \
  --header 'Authorization: Bearer <token>'
{
  "async": false,
  "messages": [
    {
      "type": "request-start",
      "content": "<string>",
      "conditions": [
        {
          "value": "<string>",
          "operator": "eq",
          "param": "<string>"
        }
      ]
    }
  ],
  "type": "dtmf",
  "id": "<string>",
  "orgId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "function": {
    "name": "<string>",
    "description": "<string>",
    "parameters": {
      "type": "object",
      "properties": {},
      "required": [
        "<string>"
      ]
    }
  },
  "server": {
    "timeoutSeconds": 20,
    "url": "<string>",
    "secret": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Retrieve your API Key from Dashboard.

Path Parameters

​
id
string
required

Response

200 - application/json
​
type
enum<string>
required

The type of tool. "dtmf" for DTMF tool.

Available options:
dtmf
​
id
string
required

This is the unique identifier for the tool.

​
orgId
string
required

This is the unique identifier for the organization that this tool belongs to.

​
createdAt
string<date-time>
required

This is the ISO 8601 date-time string of when the tool was created.

​
updatedAt
string<date-time>
required

This is the ISO 8601 date-time string of when the tool was last updated.

​
async
boolean

This determines if the tool is async.

If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.

If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.

Defaults to synchronous (false).

Example:

false

​
messages
(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · 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.

​
function
object

This is the function definition of the tool.

For endCall, transferCall, and dtmf tools, this is auto-filled based on tool-specific fields like tool.destinations. But, even in those cases, you can provide a custom function definition for advanced use cases.

An example of an advanced use case is if you want to customize the message that's spoken for endCall tool. You can specify a function where it returns an argument "reason". Then, in messages array, you can have many "request-complete" messages. One of these messages will be triggered if the messages[].conditions matches the "reason" argument.

​
server
object

This is the server that will be hit when this tool is requested by the model.

All requests will be sent with the call object among other things. You can find more details in the Server URL documentation.

This overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.