Dispatch a custom tool call (internal)
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/agents/custom-tools/internal/dispatch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tool_name": "lookup_order_status",
"args": {
"order_id": "SO-10432"
},
"agent_id": "agt_support_02",
"agent_run_id": "run_7f21aa",
"conversation_id": "conv_5521"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/agents/custom-tools/internal/dispatch"
payload = {
"tool_name": "lookup_order_status",
"args": { "order_id": "SO-10432" },
"agent_id": "agt_support_02",
"agent_run_id": "run_7f21aa",
"conversation_id": "conv_5521"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tool_name: 'lookup_order_status',
args: {order_id: 'SO-10432'},
agent_id: 'agt_support_02',
agent_run_id: 'run_7f21aa',
conversation_id: 'conv_5521'
})
};
fetch('https://api.orbit.devotel.io/api/v1/agents/custom-tools/internal/dispatch', 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.orbit.devotel.io/api/v1/agents/custom-tools/internal/dispatch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tool_name' => 'lookup_order_status',
'args' => [
'order_id' => 'SO-10432'
],
'agent_id' => 'agt_support_02',
'agent_run_id' => 'run_7f21aa',
'conversation_id' => 'conv_5521'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/agents/custom-tools/internal/dispatch"
payload := strings.NewReader("{\n \"tool_name\": \"lookup_order_status\",\n \"args\": {\n \"order_id\": \"SO-10432\"\n },\n \"agent_id\": \"agt_support_02\",\n \"agent_run_id\": \"run_7f21aa\",\n \"conversation_id\": \"conv_5521\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/agents/custom-tools/internal/dispatch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tool_name\": \"lookup_order_status\",\n \"args\": {\n \"order_id\": \"SO-10432\"\n },\n \"agent_id\": \"agt_support_02\",\n \"agent_run_id\": \"run_7f21aa\",\n \"conversation_id\": \"conv_5521\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/agents/custom-tools/internal/dispatch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tool_name\": \"lookup_order_status\",\n \"args\": {\n \"order_id\": \"SO-10432\"\n },\n \"agent_id\": \"agt_support_02\",\n \"agent_run_id\": \"run_7f21aa\",\n \"conversation_id\": \"conv_5521\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"ok": true,
"status": 123,
"duration_ms": 123,
"response_body": "<unknown>",
"error": "<string>",
"spoken_message": "<string>",
"spoken_start_message": "<string>"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Agents
Dispatch a custom tool call (internal)
Internal service-to-service endpoint (X-Internal-Token auth) invoked by the agent runtime when the model picks a tenant-owned custom tool. It looks up the tool by name, decrypts its webhook secret server-side, and fans out an HMAC-signed POST to the tool’s executor URL (with SSRF re-validation and a per-tool timeout), returning the executor response plus any rotating spoken completion/failure message. Plaintext secrets never leave the API process.
POST
/
api
/
v1
/
agents
/
custom-tools
/
internal
/
dispatch
Dispatch a custom tool call (internal)
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/agents/custom-tools/internal/dispatch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tool_name": "lookup_order_status",
"args": {
"order_id": "SO-10432"
},
"agent_id": "agt_support_02",
"agent_run_id": "run_7f21aa",
"conversation_id": "conv_5521"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/agents/custom-tools/internal/dispatch"
payload = {
"tool_name": "lookup_order_status",
"args": { "order_id": "SO-10432" },
"agent_id": "agt_support_02",
"agent_run_id": "run_7f21aa",
"conversation_id": "conv_5521"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tool_name: 'lookup_order_status',
args: {order_id: 'SO-10432'},
agent_id: 'agt_support_02',
agent_run_id: 'run_7f21aa',
conversation_id: 'conv_5521'
})
};
fetch('https://api.orbit.devotel.io/api/v1/agents/custom-tools/internal/dispatch', 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.orbit.devotel.io/api/v1/agents/custom-tools/internal/dispatch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tool_name' => 'lookup_order_status',
'args' => [
'order_id' => 'SO-10432'
],
'agent_id' => 'agt_support_02',
'agent_run_id' => 'run_7f21aa',
'conversation_id' => 'conv_5521'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/agents/custom-tools/internal/dispatch"
payload := strings.NewReader("{\n \"tool_name\": \"lookup_order_status\",\n \"args\": {\n \"order_id\": \"SO-10432\"\n },\n \"agent_id\": \"agt_support_02\",\n \"agent_run_id\": \"run_7f21aa\",\n \"conversation_id\": \"conv_5521\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/agents/custom-tools/internal/dispatch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tool_name\": \"lookup_order_status\",\n \"args\": {\n \"order_id\": \"SO-10432\"\n },\n \"agent_id\": \"agt_support_02\",\n \"agent_run_id\": \"run_7f21aa\",\n \"conversation_id\": \"conv_5521\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/agents/custom-tools/internal/dispatch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tool_name\": \"lookup_order_status\",\n \"args\": {\n \"order_id\": \"SO-10432\"\n },\n \"agent_id\": \"agt_support_02\",\n \"agent_run_id\": \"run_7f21aa\",\n \"conversation_id\": \"conv_5521\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"ok": true,
"status": 123,
"duration_ms": 123,
"response_body": "<unknown>",
"error": "<string>",
"spoken_message": "<string>",
"spoken_start_message": "<string>"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
⌘I