Skip to main content
PUT
/
tools
/
:id

​
Endpoint

PUT https://gateway.orkeia.ai/tools/{id} Authentication
Requires header authorization: <your_token>.

​
Path Parameters

NameTypeRequiredDescriptionExample
idstringYesUnique 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

FieldTypeDescription
idstringID of the tool.
namestringName of the tool.
descriptionstringDescription of the tool.
codestringExecutable code associated (when applicable).
entryFunctionNamestringEntry function in code.
sectorsstring[]Allowed sectors.
publisherstringWho published/created the tool.
enabledbooleanIndicates if it is enabled.
environmentsstring[]Environments in which it is available.
mcpobjectMCP configuration (when applicable).
mcp.urlstringURL of the MCP.
mcp.transport’sse’ | ‘streamable-http’Type of MCP transport.
createdAtstringCreation date in ISO 8601 format.