Get a tool
curl --request GET \
--url https://api.talkpilot.io/v1/agents/{agentId}/tools/{toolId} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.talkpilot.io/v1/agents/{agentId}/tools/{toolId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.talkpilot.io/v1/agents/{agentId}/tools/{toolId}', 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.talkpilot.io/v1/agents/{agentId}/tools/{toolId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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.talkpilot.io/v1/agents/{agentId}/tools/{toolId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.talkpilot.io/v1/agents/{agentId}/tools/{toolId}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.talkpilot.io/v1/agents/{agentId}/tools/{toolId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"display_name": "<string>",
"description": "<string>",
"tool_type": "http_request",
"config": {},
"is_enabled": true,
"priority": 123,
"employee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
Tools
Get a tool
GET
/
v1
/
agents
/
{agentId}
/
tools
/
{toolId}
Get a tool
curl --request GET \
--url https://api.talkpilot.io/v1/agents/{agentId}/tools/{toolId} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.talkpilot.io/v1/agents/{agentId}/tools/{toolId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.talkpilot.io/v1/agents/{agentId}/tools/{toolId}', 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.talkpilot.io/v1/agents/{agentId}/tools/{toolId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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.talkpilot.io/v1/agents/{agentId}/tools/{toolId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.talkpilot.io/v1/agents/{agentId}/tools/{toolId}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.talkpilot.io/v1/agents/{agentId}/tools/{toolId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"display_name": "<string>",
"description": "<string>",
"tool_type": "http_request",
"config": {},
"is_enabled": true,
"priority": 123,
"employee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
Authorizations
API key for external access. Format: tp_live_<32-hex-chars>.
Create keys in the TalkPilot Dashboard under Settings > API.
Response
Tool details
Internal tool name (used in LLM function calling)
Human-readable display name
Tool description (shown to the LLM to decide when to use it)
Tool types accepted by the API:
http_request— Make HTTP requests to external APIstransfer_call— Blind or warm call transfermonitored_transfer— SIP INVITE transfer with monitoringend_call— End the call with optional goodbye messageextract_variable— Extract structured data (email, phone, etc.)play_tone— Play DTMF tonesknowledge_base— Search the agent's knowledge baseset_call_result— Record a call outcome (no config)identify_caller— Caller identification handshake via your webhooksswitch_agent— Hand the call over to another agentverify_value— Deterministic check of a dictated value against rulesresolve_contact— Establish how to reach the caller before booking (phone mode)list_available_slots— Offer free appointment slots from the connected calendarbook_appointment— Book the chosen slot (same config aslist_available_slots)
Available options:
http_request, transfer_call, monitored_transfer, end_call, extract_variable, play_tone, knowledge_base, set_call_result, identify_caller, switch_agent, verify_value, resolve_contact, list_available_slots, book_appointment Tool-specific configuration (schema depends on tool_type)
Execution priority (lower number = higher priority)
Optional link to an employee, for transfer tools only (transfer_call, monitored_transfer). When set, config.phone_number is derived from employees.phone_number and kept in sync automatically — changing the employee's number changes the transfer target. null means the number is managed on the tool itself.