List Tools | Vapi

curl https://api.vapi.ai/tool \
     -H "Authorization: Bearer <token>"

[
  {
    "type": "apiRequest",
    "createdAt": "2024-01-15T09:30:00Z",
    "id": "string",
    "method": "POST",
    "orgId": "string",
    "updatedAt": "2024-01-15T09:30:00Z",
    "url": "string",
    "backoffPlan": {
      "type": "fixed",
      "maxRetries": 0,
      "baseDelaySeconds": 1,
      "excludedStatusCodes": [
        400,
        401,
        403,
        404
      ]
    },
    "body": {
      "type": "string",
      "items": {},
      "properties": {},
      "description": "string",
      "pattern": "string",
      "format": "date-time",
      "required": [
        "string"
      ],
      "enum": [
        "string"
      ],
      "title": "string"
    },
    "credentialId": "550e8400-e29b-41d4-a716-446655440000",
    "description": "string",
    "encryptedPaths": [
      "string"
    ],
    "headers": {
      "type": "string",
      "items": {},
      "properties": {},
      "description": "string",
      "pattern": "string",
      "format": "date-time",
      "required": [
        "string"
      ],
      "enum": [
        "string"
      ],
      "title": "string"
    },
    "messages": [
      {
        "contents": [
          {
            "type": "text",
            "text": "string",
            "language": "aa"
          }
        ],
        "type": "request-start",
        "blocking": false,
        "content": "string",
        "conditions": [
          {
            "operator": "eq",
            "param": "string",
            "value": "string"
          }
        ]
      }
    ],
    "name": "string",
    "rejectionPlan": {
      "conditions": [
        {
          "type": "regex",
          "regex": "\\\\b(cancel|stop|wait)\\\\b - Matches whole words"
        }
      ]
    },
    "timeoutSeconds": 20,
    "variableExtractionPlan": {
      "schema": {
        "type": "string",
        "items": {},
        "properties": {},
        "description": "string",
        "pattern": "string",
        "format": "date-time",
        "required": [
          "string"
        ],
        "enum": [
          "string"
        ],
        "title": "string"
      },
      "aliases": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  }
]

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

Query parameters

limitdoubleOptional0-1000

This is the maximum number of items to return. Defaults to 100.

createdAtGtdatetimeOptional

This will return items where the createdAt is greater than the specified value.

createdAtLtdatetimeOptional

This will return items where the createdAt is less than the specified value.

createdAtGedatetimeOptional

This will return items where the createdAt is greater than or equal to the specified value.

createdAtLedatetimeOptional

This will return items where the createdAt is less than or equal to the specified value.

updatedAtGtdatetimeOptional

This will return items where the updatedAt is greater than the specified value.

updatedAtLtdatetimeOptional

This will return items where the updatedAt is less than the specified value.

updatedAtGedatetimeOptional

This will return items where the updatedAt is greater than or equal to the specified value.

updatedAtLedatetimeOptional

This will return items where the updatedAt is less than or equal to the specified value.

Response

apiRequestobject

codeobject

dtmfobject

endCallobject

functionobject

transferCallobject

handoffobject

bashobject

computerobject

textEditorobject

queryobject

google.calendar.event.createobject

google.sheets.row.appendobject

google.calendar.availability.checkobject

slack.message.sendobject

smsobject

mcpobject

gohighlevel.calendar.availability.checkobject

gohighlevel.calendar.event.createobject

gohighlevel.contact.createobject

gohighlevel.contact.getobject

sipRequestobject

voicemailobject