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": "<string>",
"agent_id": "<string>",
"agent_run_id": "<string>",
"args": {},
"conversation_id": "<string>"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/agents/custom-tools/internal/dispatch"
payload = {
"tool_name": "<string>",
"agent_id": "<string>",
"agent_run_id": "<string>",
"args": {},
"conversation_id": "<string>"
}
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: '<string>',
agent_id: '<string>',
agent_run_id: '<string>',
args: {},
conversation_id: '<string>'
})
};
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' => '<string>',
'agent_id' => '<string>',
'agent_run_id' => '<string>',
'args' => [
],
'conversation_id' => '<string>'
]),
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\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_run_id\": \"<string>\",\n \"args\": {},\n \"conversation_id\": \"<string>\"\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\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_run_id\": \"<string>\",\n \"args\": {},\n \"conversation_id\": \"<string>\"\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\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_run_id\": \"<string>\",\n \"args\": {},\n \"conversation_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"ok": true,
"status": 200,
"duration_ms": 240,
"response_body": {
"order_number": "A-1042",
"status": "shipped"
},
"error": null,
"error_code": null,
"attempts": [
{
"attempt": 1,
"ok": true,
"status": 200,
"duration_ms": 240
}
],
"spoken_message": "The order check is done.",
"spoken_start_message": null
},
"meta": {
"request_id": "req_01J9Z8ABCDEF",
"timestamp": "2026-08-29T14:33:00.000Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Dispatch a custom tool invocation from the agent runtime
Execute a custom tool invocation on behalf of the agent runtime, keyed by tool_name. Resolves the tool, decrypts its executor secret server-side (plaintext never crosses the runtime pod boundary), and calls the executor URL with an HMAC-signed payload — honouring the tool’s configured retry and on-error fallback policy. Disabled tools return 409; unknown ones 404. Errors are LLM-safe strings, never raw executor or network exceptions. Internal server-to-server surface — requires an internal credential, not an operator API key.
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": "<string>",
"agent_id": "<string>",
"agent_run_id": "<string>",
"args": {},
"conversation_id": "<string>"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/agents/custom-tools/internal/dispatch"
payload = {
"tool_name": "<string>",
"agent_id": "<string>",
"agent_run_id": "<string>",
"args": {},
"conversation_id": "<string>"
}
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: '<string>',
agent_id: '<string>',
agent_run_id: '<string>',
args: {},
conversation_id: '<string>'
})
};
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' => '<string>',
'agent_id' => '<string>',
'agent_run_id' => '<string>',
'args' => [
],
'conversation_id' => '<string>'
]),
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\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_run_id\": \"<string>\",\n \"args\": {},\n \"conversation_id\": \"<string>\"\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\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_run_id\": \"<string>\",\n \"args\": {},\n \"conversation_id\": \"<string>\"\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\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_run_id\": \"<string>\",\n \"args\": {},\n \"conversation_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"ok": true,
"status": 200,
"duration_ms": 240,
"response_body": {
"order_number": "A-1042",
"status": "shipped"
},
"error": null,
"error_code": null,
"attempts": [
{
"attempt": 1,
"ok": true,
"status": 200,
"duration_ms": 240
}
],
"spoken_message": "The order check is done.",
"spoken_start_message": null
},
"meta": {
"request_id": "req_01J9Z8ABCDEF",
"timestamp": "2026-08-29T14:33:00.000Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
1 - 255Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
true, false Body
The tool invocation to dispatch.