VoxLink.ai

API Reference

List mid call tools

Retrieve all mid call tools

Updated 30 June 2026

This endpoint allows you to retrieve all mid call tools. Mid call tools enable your AI assistants to interact with external APIs during a call.

Headers

stringrequired

Bearer token for authentication

stringrequired

Must be application/json

stringrequired

Must be application/json

Response fields

dataarray

Array of mid call tools

idinteger

  The unique identifier of the tool

namestring

  The name of the tool

descriptionstring

  Detailed explanation of when and how the AI should use this tool

typestring

  Tool type: `http` or `automation`

endpointstring

  The API endpoint URL that will be called

methodstring

  HTTP method (GET, POST, PUT, PATCH, DELETE)

body_formatstring

  Request body encoding: `json` or `form`

timeoutinteger

  Request timeout in seconds (1-30)

headersarray

  HTTP headers to send with the request

namestring

      Header name

valuestring

      Header value

static_fieldsarray

  Fixed key/value pairs always sent with the request

keystring

      Field key

valuestring

      Field value

schemaarray

  Parameters that the AI will extract and send to the endpoint

namestring

      Parameter name

typestring

      Parameter type (string, number, float, boolean)

descriptionstring

      Description to help AI understand how to extract this parameter

requiredboolean

      Whether the AI must collect this parameter

created_atstring

  ISO 8601 timestamp when the tool was created

updated_atstring

  ISO 8601 timestamp when the tool was last updated
[
  {
    "id": 1,
    "name": "get_weather",
    "description": "Use this tool to get the current weather in a specific city. Call this when the customer asks about weather conditions.",
    "type": "http",
    "endpoint": "https://api.openweathermap.org/data/2.5/weather?city={city}",
    "method": "GET",
    "body_format": "json",
    "timeout": 10,
    "headers": [
      {
        "name": "Content-Type",
        "value": "application/json"
      },
      {
        "name": "Authorization",
        "value": "Bearer sk_..."
      }
    ],
    "static_fields": [],
    "schema": [
      {
        "name": "city",
        "type": "string",
        "description": "The city name to get weather for",
        "required": true
      },
      {
        "name": "days",
        "type": "number",
        "description": "Number of forecast days",
        "required": false
      }
    ],
    "created_at": "2025-10-10T12:00:00.000000Z",
    "updated_at": "2025-10-10T12:00:00.000000Z"
  },
  {
    "id": 2,
    "name": "send_notification",
    "description": "Use this tool to send a notification to the customer. Call this when customer requests updates.",
    "type": "http",
    "endpoint": "https://api.yourcompany.com/notifications/send",
    "method": "POST",
    "body_format": "json",
    "timeout": 15,
    "headers": [
      {
        "name": "Content-Type",
        "value": "application/json"
      }
    ],
    "static_fields": [
      {
        "key": "caller",
        "value": "{{customer_phone}}"
      }
    ],
    "schema": [
      {
        "name": "message",
        "type": "string",
        "description": "The notification message to send",
        "required": true
      },
      {
        "name": "send_sms",
        "type": "boolean",
        "description": "Whether to also send SMS notification",
        "required": false
      }
    ],
    "created_at": "2025-10-09T14:30:00.000000Z",
    "updated_at": "2025-10-10T09:15:00.000000Z"
  }
]

Assigning Tools to Assistants

To use these tools with assistants, see:

Related guides