Update tool
curl --request PATCH \
--url https://api.sidenet.ai/v1/tools/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Get customer",
"description": "Fetches one customer by id",
"path": "/customers/{customerId}",
"input_schema": {
"type": "object",
"properties": {
"customerId": {
"type": "string"
}
},
"required": [
"customerId"
]
},
"output_schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"timeout_ms": 30000,
"is_enabled": true,
"operation_id": "getCustomer",
"tags": [
"customers"
],
"deprecated": false
}
'import requests
url = "https://api.sidenet.ai/v1/tools/{id}"
payload = {
"name": "Get customer",
"description": "Fetches one customer by id",
"path": "/customers/{customerId}",
"input_schema": {
"type": "object",
"properties": { "customerId": { "type": "string" } },
"required": ["customerId"]
},
"output_schema": {
"type": "object",
"properties": {
"id": { "type": "string" },
"name": { "type": "string" }
}
},
"timeout_ms": 30000,
"is_enabled": True,
"operation_id": "getCustomer",
"tags": ["customers"],
"deprecated": False
}
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({
name: 'Get customer',
description: 'Fetches one customer by id',
path: '/customers/{customerId}',
input_schema: {
type: 'object',
properties: {customerId: {type: 'string'}},
required: ['customerId']
},
output_schema: {type: 'object', properties: {id: {type: 'string'}, name: {type: 'string'}}},
timeout_ms: 30000,
is_enabled: true,
operation_id: 'getCustomer',
tags: ['customers'],
deprecated: false
})
};
fetch('https://api.sidenet.ai/v1/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.sidenet.ai/v1/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([
'name' => 'Get customer',
'description' => 'Fetches one customer by id',
'path' => '/customers/{customerId}',
'input_schema' => [
'type' => 'object',
'properties' => [
'customerId' => [
'type' => 'string'
]
],
'required' => [
'customerId'
]
],
'output_schema' => [
'type' => 'object',
'properties' => [
'id' => [
'type' => 'string'
],
'name' => [
'type' => 'string'
]
]
],
'timeout_ms' => 30000,
'is_enabled' => true,
'operation_id' => 'getCustomer',
'tags' => [
'customers'
],
'deprecated' => false
]),
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.sidenet.ai/v1/tools/{id}"
payload := strings.NewReader("{\n \"name\": \"Get customer\",\n \"description\": \"Fetches one customer by id\",\n \"path\": \"/customers/{customerId}\",\n \"input_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"customerId\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"customerId\"\n ]\n },\n \"output_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n }\n },\n \"timeout_ms\": 30000,\n \"is_enabled\": true,\n \"operation_id\": \"getCustomer\",\n \"tags\": [\n \"customers\"\n ],\n \"deprecated\": false\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.sidenet.ai/v1/tools/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Get customer\",\n \"description\": \"Fetches one customer by id\",\n \"path\": \"/customers/{customerId}\",\n \"input_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"customerId\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"customerId\"\n ]\n },\n \"output_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n }\n },\n \"timeout_ms\": 30000,\n \"is_enabled\": true,\n \"operation_id\": \"getCustomer\",\n \"tags\": [\n \"customers\"\n ],\n \"deprecated\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sidenet.ai/v1/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 \"name\": \"Get customer\",\n \"description\": \"Fetches one customer by id\",\n \"path\": \"/customers/{customerId}\",\n \"input_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"customerId\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"customerId\"\n ]\n },\n \"output_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n }\n },\n \"timeout_ms\": 30000,\n \"is_enabled\": true,\n \"operation_id\": \"getCustomer\",\n \"tags\": [\n \"customers\"\n ],\n \"deprecated\": false\n}"
response = http.request(request)
puts response.read_body{
"tool": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tool_provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"method": "<string>",
"path": "<string>",
"input_schema": {},
"output_schema": {},
"timeout_ms": 123,
"is_enabled": true,
"operation_id": "<string>",
"tags": [
"<string>"
],
"deprecated": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"rebuild": {
"scope": "<string>",
"tools": {
"affectedToolIds": [
"<string>"
],
"totalToolIds": 123,
"providerCounts": {
"api": 123,
"mcp": 123,
"other": 123
},
"mcpErrors": [
{
"providerId": "<string>",
"providerName": "<string>",
"error": "<string>"
}
]
},
"rebuilt": 123,
"failed": 123,
"skipped": 123,
"agents": [
{}
],
"failedAgents": [
{
"agentVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mastraId": "<string>",
"error": "<string>"
}
],
"totalBuildTime": 123
}
}Tools
Update tool
Updates a single tool (org-scoped via its provider). A name is normalised like on create — path punctuation (/, {}) stripped, and a name already used by ANOTHER tool in the provider disambiguated with the method and, if needed, a counter — so the saved name in the response may differ from the one sent. Reloads the org tools and rebuilds dependent agents.
PATCH
/
v1
/
tools
/
{id}
Update tool
curl --request PATCH \
--url https://api.sidenet.ai/v1/tools/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Get customer",
"description": "Fetches one customer by id",
"path": "/customers/{customerId}",
"input_schema": {
"type": "object",
"properties": {
"customerId": {
"type": "string"
}
},
"required": [
"customerId"
]
},
"output_schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"timeout_ms": 30000,
"is_enabled": true,
"operation_id": "getCustomer",
"tags": [
"customers"
],
"deprecated": false
}
'import requests
url = "https://api.sidenet.ai/v1/tools/{id}"
payload = {
"name": "Get customer",
"description": "Fetches one customer by id",
"path": "/customers/{customerId}",
"input_schema": {
"type": "object",
"properties": { "customerId": { "type": "string" } },
"required": ["customerId"]
},
"output_schema": {
"type": "object",
"properties": {
"id": { "type": "string" },
"name": { "type": "string" }
}
},
"timeout_ms": 30000,
"is_enabled": True,
"operation_id": "getCustomer",
"tags": ["customers"],
"deprecated": False
}
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({
name: 'Get customer',
description: 'Fetches one customer by id',
path: '/customers/{customerId}',
input_schema: {
type: 'object',
properties: {customerId: {type: 'string'}},
required: ['customerId']
},
output_schema: {type: 'object', properties: {id: {type: 'string'}, name: {type: 'string'}}},
timeout_ms: 30000,
is_enabled: true,
operation_id: 'getCustomer',
tags: ['customers'],
deprecated: false
})
};
fetch('https://api.sidenet.ai/v1/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.sidenet.ai/v1/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([
'name' => 'Get customer',
'description' => 'Fetches one customer by id',
'path' => '/customers/{customerId}',
'input_schema' => [
'type' => 'object',
'properties' => [
'customerId' => [
'type' => 'string'
]
],
'required' => [
'customerId'
]
],
'output_schema' => [
'type' => 'object',
'properties' => [
'id' => [
'type' => 'string'
],
'name' => [
'type' => 'string'
]
]
],
'timeout_ms' => 30000,
'is_enabled' => true,
'operation_id' => 'getCustomer',
'tags' => [
'customers'
],
'deprecated' => false
]),
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.sidenet.ai/v1/tools/{id}"
payload := strings.NewReader("{\n \"name\": \"Get customer\",\n \"description\": \"Fetches one customer by id\",\n \"path\": \"/customers/{customerId}\",\n \"input_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"customerId\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"customerId\"\n ]\n },\n \"output_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n }\n },\n \"timeout_ms\": 30000,\n \"is_enabled\": true,\n \"operation_id\": \"getCustomer\",\n \"tags\": [\n \"customers\"\n ],\n \"deprecated\": false\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.sidenet.ai/v1/tools/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Get customer\",\n \"description\": \"Fetches one customer by id\",\n \"path\": \"/customers/{customerId}\",\n \"input_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"customerId\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"customerId\"\n ]\n },\n \"output_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n }\n },\n \"timeout_ms\": 30000,\n \"is_enabled\": true,\n \"operation_id\": \"getCustomer\",\n \"tags\": [\n \"customers\"\n ],\n \"deprecated\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sidenet.ai/v1/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 \"name\": \"Get customer\",\n \"description\": \"Fetches one customer by id\",\n \"path\": \"/customers/{customerId}\",\n \"input_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"customerId\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"customerId\"\n ]\n },\n \"output_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n }\n },\n \"timeout_ms\": 30000,\n \"is_enabled\": true,\n \"operation_id\": \"getCustomer\",\n \"tags\": [\n \"customers\"\n ],\n \"deprecated\": false\n}"
response = http.request(request)
puts response.read_body{
"tool": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tool_provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"method": "<string>",
"path": "<string>",
"input_schema": {},
"output_schema": {},
"timeout_ms": 123,
"is_enabled": true,
"operation_id": "<string>",
"tags": [
"<string>"
],
"deprecated": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"rebuild": {
"scope": "<string>",
"tools": {
"affectedToolIds": [
"<string>"
],
"totalToolIds": 123,
"providerCounts": {
"api": 123,
"mcp": 123,
"other": 123
},
"mcpErrors": [
{
"providerId": "<string>",
"providerName": "<string>",
"error": "<string>"
}
]
},
"rebuilt": 123,
"failed": 123,
"skipped": 123,
"agents": [
{}
],
"failedAgents": [
{
"agentVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mastraId": "<string>",
"error": "<string>"
}
],
"totalBuildTime": 123
}
}Authorizations
Organization API key, generated in studio.sidenet.ai. Backend only — never in a browser.
Path Parameters
Example:
"c07f2b95-8d41-4e63-a029-5f7b1c8d3e40"
Body
application/json
Minimum string length:
1Example:
"Get customer"
Example:
"Fetches one customer by id"
Available options:
GET, POST, PUT, PATCH, DELETE Minimum string length:
1Example:
"/customers/{customerId}"
Show child attributes
Show child attributes
Example:
{
"type": "object",
"properties": { "customerId": { "type": "string" } },
"required": ["customerId"]
}
Show child attributes
Show child attributes
Example:
{
"type": "object",
"properties": {
"id": { "type": "string" },
"name": { "type": "string" }
}
}
Required range:
1000 <= x <= 120000Example:
30000
Example:
true
Example:
"getCustomer"
Example:
["customers"]
Example:
false