curl --request PATCH \
--url https://api.orbit.devotel.io/api/v1/agents/custom-tools/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"json_schema": {},
"executor_url": "<string>",
"executor_secret": "<string>",
"enabled": true,
"timeout_ms": 30500
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/agents/custom-tools/{id}"
payload = {
"description": "<string>",
"json_schema": {},
"executor_url": "<string>",
"executor_secret": "<string>",
"enabled": True,
"timeout_ms": 30500
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
json_schema: {},
executor_url: '<string>',
executor_secret: '<string>',
enabled: true,
timeout_ms: 30500
})
};
fetch('https://api.orbit.devotel.io/api/v1/agents/custom-tools/{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.orbit.devotel.io/api/v1/agents/custom-tools/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'json_schema' => [
],
'executor_url' => '<string>',
'executor_secret' => '<string>',
'enabled' => true,
'timeout_ms' => 30500
]),
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/{id}"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"json_schema\": {},\n \"executor_url\": \"<string>\",\n \"executor_secret\": \"<string>\",\n \"enabled\": true,\n \"timeout_ms\": 30500\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.orbit.devotel.io/api/v1/agents/custom-tools/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"json_schema\": {},\n \"executor_url\": \"<string>\",\n \"executor_secret\": \"<string>\",\n \"enabled\": true,\n \"timeout_ms\": 30500\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/agents/custom-tools/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"json_schema\": {},\n \"executor_url\": \"<string>\",\n \"executor_secret\": \"<string>\",\n \"enabled\": true,\n \"timeout_ms\": 30500\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "ctl_01J9Z8ABCDEF",
"name": "check_order_status",
"description": "Look up an order's fulfilment status and ETA.",
"enabled": false,
"timeout_ms": 15000,
"execution_mode": "webhook"
},
"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>"
}
}Update a custom tool
Partially update a custom tool: description, argument schema, executor URL or secret (send null to clear the secret), enabled flag, timeout, confirmation mode, execution mode, spoken messages, and retry / on-error policy. Switching to webhook execution requires an HTTPS executor URL that passes the platform’s SSRF validation (public host, no private or metadata endpoints); requests that only swap populated fields return the tool unchanged. Returns 404 when no tool with that id exists.
curl --request PATCH \
--url https://api.orbit.devotel.io/api/v1/agents/custom-tools/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"json_schema": {},
"executor_url": "<string>",
"executor_secret": "<string>",
"enabled": true,
"timeout_ms": 30500
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/agents/custom-tools/{id}"
payload = {
"description": "<string>",
"json_schema": {},
"executor_url": "<string>",
"executor_secret": "<string>",
"enabled": True,
"timeout_ms": 30500
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
json_schema: {},
executor_url: '<string>',
executor_secret: '<string>',
enabled: true,
timeout_ms: 30500
})
};
fetch('https://api.orbit.devotel.io/api/v1/agents/custom-tools/{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.orbit.devotel.io/api/v1/agents/custom-tools/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'json_schema' => [
],
'executor_url' => '<string>',
'executor_secret' => '<string>',
'enabled' => true,
'timeout_ms' => 30500
]),
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/{id}"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"json_schema\": {},\n \"executor_url\": \"<string>\",\n \"executor_secret\": \"<string>\",\n \"enabled\": true,\n \"timeout_ms\": 30500\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.orbit.devotel.io/api/v1/agents/custom-tools/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"json_schema\": {},\n \"executor_url\": \"<string>\",\n \"executor_secret\": \"<string>\",\n \"enabled\": true,\n \"timeout_ms\": 30500\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/agents/custom-tools/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"json_schema\": {},\n \"executor_url\": \"<string>\",\n \"executor_secret\": \"<string>\",\n \"enabled\": true,\n \"timeout_ms\": 30500\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "ctl_01J9Z8ABCDEF",
"name": "check_order_status",
"description": "Look up an order's fulfilment status and ETA.",
"enabled": false,
"timeout_ms": 15000,
"execution_mode": "webhook"
},
"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
Sandbox opt-in for Clerk-session-authenticated requests. 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 Path Parameters
The custom tool id.
1 - 200Body
Fields to update; only provided fields change.
Fields to update; only provided fields change.
1 - 1000JSON Schema for the tool's arguments (replaces).
2000New secret value; null clears the existing secret.
8 - 5121000 <= x <= 60000never, always "client" tools are executed by the calling SDK and never dispatched to a webhook.
webhook, client