curl --request POST \
--url https://api.orbit.devotel.io/api/v1/agents/custom-tools \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"name": "lookup_order",
"description": "Look up an order's status and tracking number by order id.",
"json_schema": {
"type": "object",
"properties": {
"order_id": {
"type": "string"
}
},
"required": [
"order_id"
]
},
"executor_url": "https://api.example.com/orbit/tools/lookup-order",
"timeout_ms": 15000
}
EOFimport requests
url = "https://api.orbit.devotel.io/api/v1/agents/custom-tools"
payload = {
"name": "lookup_order",
"description": "Look up an order's status and tracking number by order id.",
"json_schema": {
"type": "object",
"properties": { "order_id": { "type": "string" } },
"required": ["order_id"]
},
"executor_url": "https://api.example.com/orbit/tools/lookup-order",
"timeout_ms": 15000
}
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({
name: 'lookup_order',
description: 'Look up an order\'s status and tracking number by order id.',
json_schema: {
type: 'object',
properties: {order_id: {type: 'string'}},
required: ['order_id']
},
executor_url: 'https://api.example.com/orbit/tools/lookup-order',
timeout_ms: 15000
})
};
fetch('https://api.orbit.devotel.io/api/v1/agents/custom-tools', 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",
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([
'name' => 'lookup_order',
'description' => 'Look up an order\'s status and tracking number by order id.',
'json_schema' => [
'type' => 'object',
'properties' => [
'order_id' => [
'type' => 'string'
]
],
'required' => [
'order_id'
]
],
'executor_url' => 'https://api.example.com/orbit/tools/lookup-order',
'timeout_ms' => 15000
]),
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"
payload := strings.NewReader("{\n \"name\": \"lookup_order\",\n \"description\": \"Look up an order's status and tracking number by order id.\",\n \"json_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"order_id\"\n ]\n },\n \"executor_url\": \"https://api.example.com/orbit/tools/lookup-order\",\n \"timeout_ms\": 15000\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"lookup_order\",\n \"description\": \"Look up an order's status and tracking number by order id.\",\n \"json_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"order_id\"\n ]\n },\n \"executor_url\": \"https://api.example.com/orbit/tools/lookup-order\",\n \"timeout_ms\": 15000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/agents/custom-tools")
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 \"name\": \"lookup_order\",\n \"description\": \"Look up an order's status and tracking number by order id.\",\n \"json_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"order_id\"\n ]\n },\n \"executor_url\": \"https://api.example.com/orbit/tools/lookup-order\",\n \"timeout_ms\": 15000\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"json_schema": {},
"executor_url": "<string>",
"executor_secret_set": true,
"enabled": true,
"timeout_ms": 123,
"confirmation": "never",
"created_by_user_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Create a custom agent tool
Register a new webhook-backed custom tool for your agents. Supply a lowercase snake_case name, a description the model reads to decide when to call it, an optional JSON-Schema for the tool’s parameters, and the HTTPS executor_url Orbit POSTs to when an agent invokes the tool. An optional executor_secret is stored encrypted and used to HMAC-sign each dispatch. Names that collide with a built-in tool are rejected, and the executor URL is SSRF-checked at write time. Requires an owner, admin, or developer role.
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/agents/custom-tools \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"name": "lookup_order",
"description": "Look up an order's status and tracking number by order id.",
"json_schema": {
"type": "object",
"properties": {
"order_id": {
"type": "string"
}
},
"required": [
"order_id"
]
},
"executor_url": "https://api.example.com/orbit/tools/lookup-order",
"timeout_ms": 15000
}
EOFimport requests
url = "https://api.orbit.devotel.io/api/v1/agents/custom-tools"
payload = {
"name": "lookup_order",
"description": "Look up an order's status and tracking number by order id.",
"json_schema": {
"type": "object",
"properties": { "order_id": { "type": "string" } },
"required": ["order_id"]
},
"executor_url": "https://api.example.com/orbit/tools/lookup-order",
"timeout_ms": 15000
}
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({
name: 'lookup_order',
description: 'Look up an order\'s status and tracking number by order id.',
json_schema: {
type: 'object',
properties: {order_id: {type: 'string'}},
required: ['order_id']
},
executor_url: 'https://api.example.com/orbit/tools/lookup-order',
timeout_ms: 15000
})
};
fetch('https://api.orbit.devotel.io/api/v1/agents/custom-tools', 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",
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([
'name' => 'lookup_order',
'description' => 'Look up an order\'s status and tracking number by order id.',
'json_schema' => [
'type' => 'object',
'properties' => [
'order_id' => [
'type' => 'string'
]
],
'required' => [
'order_id'
]
],
'executor_url' => 'https://api.example.com/orbit/tools/lookup-order',
'timeout_ms' => 15000
]),
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"
payload := strings.NewReader("{\n \"name\": \"lookup_order\",\n \"description\": \"Look up an order's status and tracking number by order id.\",\n \"json_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"order_id\"\n ]\n },\n \"executor_url\": \"https://api.example.com/orbit/tools/lookup-order\",\n \"timeout_ms\": 15000\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"lookup_order\",\n \"description\": \"Look up an order's status and tracking number by order id.\",\n \"json_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"order_id\"\n ]\n },\n \"executor_url\": \"https://api.example.com/orbit/tools/lookup-order\",\n \"timeout_ms\": 15000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/agents/custom-tools")
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 \"name\": \"lookup_order\",\n \"description\": \"Look up an order's status and tracking number by order id.\",\n \"json_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"order_id\"\n ]\n },\n \"executor_url\": \"https://api.example.com/orbit/tools/lookup-order\",\n \"timeout_ms\": 15000\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"json_schema": {},
"executor_url": "<string>",
"executor_secret_set": true,
"enabled": true,
"timeout_ms": 123,
"confirmation": "never",
"created_by_user_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
Dashboard JWT token from Clerk
Body
Lowercase snake_case identifier the model calls (e.g. lookup_order).
3 - 64What the tool does — the model reads this to decide when to call it.
1 - 1000HTTPS endpoint Orbit POSTs to when an agent invokes the tool.
2000JSON-Schema for the tool's parameters (max 32KB serialized).
Optional secret, stored encrypted, used to HMAC-sign each dispatch.
8 - 512Per-call timeout in milliseconds.
1000 <= x <= 60000Whether the tool call requires operator approval before it runs.
never, always