Ctrl K

API Reference

Get mid call tool

Retrieve a specific mid call tool by ID

Updated 30 June 2026

On this page

This endpoint allows you to retrieve detailed information about a specific mid call tool.

Headers

stringrequired

Bearer token for authentication

stringrequired

Must be application/json

stringrequired

Must be application/json

Path Parameters

idintegerrequired

The unique identifier of the tool

Response fields

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": [
    {
      "key": "source",
      "value": "voxlink"
    }
  ],
  "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"
}