Pular para o conteúdo principal
POST
/
tools

​
Endpoint

POST https://gateway.orkeia.ai/tools Autenticação
Requer cabeçalho authorization: <seu_token>.

​
Corpo da Requisição (JSON)

O serviço espera um wrapper com a propriedade tool. (O environment é tratado no servidor.)
Atenção: o campo type não existe nesta interface. Utilize os campos definidos em Tool (abaixo). 
{
  "tool": {
    "name": "Minha Ferramenta",
    "description": "Descrição da ferramenta",
    "code": "export async function run(input){ return { ok: true }; }",
    "entryFunctionName": "run",
    "sectors": ["engineering", "legal"],
    "publisher": "Orkeia",
    "enabled": true,
    "environments": ["prod"],
    "mcp": {
      "url": "https://tools.orkeia.ai/my-tool",
      "transport": "sse"
    }
  }
}

​
Exemplo (cURL)

curl -X POST "https://gateway.orkeia.ai/tools"   -H "authorization:  <seu_token>"   -H "Content-Type: application/json"   -d '{
    "tool": {
      "name": "Minha Ferramenta",
      "description": "Descrição da ferramenta",
      "code": "export async function run(input){ return { ok: true }; }",
      "entryFunctionName": "run",
      "sectors": ["engineering", "legal"],
      "publisher": "Orkeia",
      "enabled": true,
      "environments": ["prod"],
      "mcp": {
        "url": "https://tools.orkeia.ai/my-tool",
        "transport": "sse"
      }
    }
  }'

​
Respostas

​
Response - Success

response
{
  "status": "OK",
  "data": { "id": "TOOL_123456" }
}

​
500 — Server Error

{
  "status": "ERROR",
  "code": "server/error",
  "data": null
}

​
400 — Client Error

{
  "status": "ERROR",
  "code": "client/error",
  "data": null
}

​
Interface de Referência (Tool)

export interface Tool {
  id?: string;
  name: string;
  description: string;
  code?: string;
  entryFunctionName?: string;
  sectors: string[];
  publisher: string;
  enabled: boolean;
  environments: string[];
  mcp?: {
    url: string;
    transport: 'sse' | 'streamable-http';
  };
}

​
Campos

NomeTipoObrigatórioDescriçãoExemplo
idstringNãoIdentificador único (retornado pelo backend).TOOL_123456
namestringSimNome da ferramenta.Minha Ferramenta
descriptionstringSimDescrição curta sobre a funcionalidade.Executa operações de integração
codestringNãoCódigo fonte executável da ferramenta (quando aplicável).export async function run(){...}
entryFunctionNamestringNãoNome da função exportada no code que será invocada.run
sectorsstring[]SimSetores autorizados a utilizar a ferramenta.["engineering","legal"]
publisherstringSimPublicador/organização responsável.Orkeia
enabledbooleanSimIndica se a ferramenta está habilitada.true
environmentsstring[]SimAmbientes em que a ferramenta está disponível.["prod","staging"]
mcpobjetoNãoConfiguração para uso via Model Context Protocol (MCP).{ "url": "...", "transport": "sse" }
mcp.urlstringNãoURL do servidor MCP.https://tools.orkeia.ai/my-tool
mcp.transport'sse' | 'streamable-http'NãoTipo de transporte MCP suportado.sse