Update Tool
curl --request PUT \
--url https://api.example.com/tools/:idimport requests
url = "https://api.example.com/tools/:id"
response = requests.put(url)
print(response.text)const options = {method: 'PUT'};
fetch('https://api.example.com/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.example.com/tools/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/tools/:id"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.example.com/tools/:id")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/tools/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_bodyTools
Update Tool
Updates the data of a tool.
PUT
/
tools
/
:id
Update Tool
curl --request PUT \
--url https://api.example.com/tools/:idimport requests
url = "https://api.example.com/tools/:id"
response = requests.put(url)
print(response.text)const options = {method: 'PUT'};
fetch('https://api.example.com/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.example.com/tools/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/tools/:id"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.example.com/tools/:id")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/tools/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_bodyEndpoint
PUT https://gateway.orkeia.ai/tools/{id}
AuthenticationRequires header
authorization: <your_token>.
Path Parameters
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| id | string | Yes | Unique identifier of the tool. | TOOL_123456 |
Request Body (JSON)
{
"name": "Nova Ferramenta",
"description": "Descrição atualizada",
"code": "export async function run(input){ return { ok: true }; }",
"entryFunctionName": "run",
"sectors": ["engineering"],
"publisher": "Orkeia",
"enabled": true,
"environments": ["prod"],
"mcp": {
"url": "https://tools.orkeia.ai/my-tool",
"transport": "sse"
}
}
Example (cURL)
curl -X PUT "https://gateway.orkeia.ai/tools/TOOL_123456" -H "authorization: <your_token>" -H "Content-Type: application/json" -d '{
"name": "Nova Ferramenta",
"description": "Descrição atualizada",
"code": "export async function run(input){ return { ok: true }; }",
"entryFunctionName": "run",
"sectors": ["engineering"],
"publisher": "Orkeia",
"enabled": true,
"environments": ["prod"],
"mcp": { "url": "https://tools.orkeia.ai/my-tool", "transport": "sse" }
}'
Responses
Response - Success
response
{
"status": "OK",
"data": {
"id": "TOOL_123456",
"name": "Nova Ferramenta",
"description": "Descrição atualizada",
"code": "export async function run(input){ return { ok: true }; }",
"entryFunctionName": "run",
"sectors": ["engineering"],
"publisher": "Orkeia",
"enabled": true,
"environments": ["prod"],
"mcp": {
"url": "https://tools.orkeia.ai/my-tool",
"transport": "sse"
},
"createdAt": "2024-07-15T14:25:18.000Z"
}
}
500 — Server Error
{
"status": "ERROR",
"code": "server/error",
"data": null
}
400 — Client Error
{
"status": "ERROR",
"code": "client/error",
"data": null
}
Fields
| Field | Type | Description |
|---|---|---|
| id | string | ID of the tool. |
| name | string | Name of the tool. |
| description | string | Description of the tool. |
| code | string | Executable code associated (when applicable). |
| entryFunctionName | string | Entry function in code. |
| sectors | string[] | Allowed sectors. |
| publisher | string | Who published/created the tool. |
| enabled | boolean | Indicates if it is enabled. |
| environments | string[] | Environments in which it is available. |
| mcp | object | MCP configuration (when applicable). |
| mcp.url | string | URL of the MCP. |
| mcp.transport | ’sse’ | ‘streamable-http’ | Type of MCP transport. |
| createdAt | string | Creation date in ISO 8601 format. |
Was this page helpful?
⌘I
