Pular para o conteúdo principal
GET
/
tools
/
:id
Detalhar Ferramenta
curl --request GET \
  --url https://api.example.com/tools/:id

Documentation Index

Fetch the complete documentation index at: https://docs.orkeia.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

GET https://gateway.orkeia.ai/tools/{id} Autenticação
Requer cabeçalho authorization: <seu_token>.

​
Parâmetros de Caminho

NomeTipoObrigatórioDescriçãoExemplo
idstringSimIdentificador único da ferramenta.TOOL_123456

​
Exemplo (cURL)

curl -X GET "https://gateway.orkeia.ai/tools/TOOL_123456"   -H "authorization:  <seu_token>"

​
Respostas

​
Response - Success

response
{
  "status": "OK",
  "data": {
    "id": "TOOL_123456",
    "name": "Ferramenta X",
    "description": "Descrição da ferramenta",
    "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
}

​
Campos

CampoTipoDescrição
idstringID da ferramenta.
namestringNome da ferramenta.
descriptionstringDescrição da ferramenta.
codestringCódigo executável associado (quando aplicável).
entryFunctionNamestringFunção de entrada no code.
sectorsstring[]Setores permitidos.
publisherstringQuem publicou/criou a ferramenta.
enabledbooleanIndica se está habilitada.
environmentsstring[]Ambientes em que está disponível.
mcpobjetoConfiguração MCP (quando aplicável).
mcp.urlstringURL do MCP.
mcp.transport’sse’ | ‘streamable-http’Tipo de transporte MCP.
createdAtstringData de criação no formato ISO 8601.