Get custom tool

curl --request GET \
  --url https://api.example.com/v2/ai-agents/{ai_agent_id}/custom-tools/{tool_id}

const options = {method: 'GET'};

fetch('https://api.example.com/v2/ai-agents/{ai_agent_id}/custom-tools/{tool_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v2/ai-agents/{ai_agent_id}/custom-tools/{tool_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v2/ai-agents/{ai_agent_id}/custom-tools/{tool_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/ai-agents/{ai_agent_id}/custom-tools/{tool_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "openai_tool": {
    "description": "Get the delivery date for a customer's order",
    "name": "get_delivery_date",
    "parameters": {
      "additionalProperties": false,
      "properties": {
        "order_id": {
          "description": "The customer's order ID",
          "type": "string"
        }
      },
      "required": [
        "order_id"
      ],
      "type": "object"
    }
  },
  "additional_tool_info": {
    "api": {
      "endpoint": "https://api.example.com/test",
      "headers": {
        "Content-Type": "application/json"
      },
      "method": "POST",
      "parameters": {
        "fixed_params": {
          "api_key": {
            "description": "API key for authentication",
            "value": "test-api-key"
          }
        },
        "runtime_params": {}
      }
    },
    "tool_type": "custom"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "tool_id": "<string>",
  "tool_start_message": "<string>",
  "tool_delayed_message": "<string>",
  "tool_complete_message": "<string>",
  "tool_failed_message": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

ai-agents

{ai_agent_id}

custom-tools

{tool_id}

Get custom tool

curl --request GET \
  --url https://api.example.com/v2/ai-agents/{ai_agent_id}/custom-tools/{tool_id}

const options = {method: 'GET'};

fetch('https://api.example.com/v2/ai-agents/{ai_agent_id}/custom-tools/{tool_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v2/ai-agents/{ai_agent_id}/custom-tools/{tool_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v2/ai-agents/{ai_agent_id}/custom-tools/{tool_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/ai-agents/{ai_agent_id}/custom-tools/{tool_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "openai_tool": {
    "description": "Get the delivery date for a customer's order",
    "name": "get_delivery_date",
    "parameters": {
      "additionalProperties": false,
      "properties": {
        "order_id": {
          "description": "The customer's order ID",
          "type": "string"
        }
      },
      "required": [
        "order_id"
      ],
      "type": "object"
    }
  },
  "additional_tool_info": {
    "api": {
      "endpoint": "https://api.example.com/test",
      "headers": {
        "Content-Type": "application/json"
      },
      "method": "POST",
      "parameters": {
        "fixed_params": {
          "api_key": {
            "description": "API key for authentication",
            "value": "test-api-key"
          }
        },
        "runtime_params": {}
      }
    },
    "tool_type": "custom"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "tool_id": "<string>",
  "tool_start_message": "<string>",
  "tool_delayed_message": "<string>",
  "tool_complete_message": "<string>",
  "tool_failed_message": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Path Parameters

ai_agent_id

string

required

tool_id

string

required

Response

Successful Response

openai_tool

OpenAIFormatFunctionDefinition · object

required

OpenAI function definition containing the tool's interface specification

Show child attributes

Example:

{
  "description": "Get the delivery date for a customer's order",
  "name": "get_delivery_date",
  "parameters": {
    "additionalProperties": false,
    "properties": {
      "order_id": {
        "description": "The customer's order ID",
        "type": "string"
      }
    },
    "required": ["order_id"],
    "type": "object"
  }
}

additional_tool_info

AdditionalCustomToolInfo · object

required

Complete configuration for the custom tool including API details

Show child attributes

created_at

string<date-time>

required

Timestamp indicating when this custom tool was created

updated_at

string<date-time>

required

Timestamp indicating when this custom tool was last modified

tool_id

string

Unique identifier for the custom tool

tool_start_message

string | null

Optional message to display when the tool is started

tool_delayed_message

string | null

Optional message to display when the tool is delayed

tool_complete_message

string | null

Optional message to display when the tool is completed

tool_failed_message

string | null

Optional message to display when the tool fails

API Reference

AI Agents v2

Built-in Tools

Custom Tools

Calls

Call Recording

Post-call Analysis

Phone Numbers

Knowledge Bases

Prompt Generation

Public Sharing

Webhook Subscriptions

API Keys

Get custom tool

Path Parameters

Response