Saltar al contenido principal
POST
/
tools
cURL
curl --request POST \
  --url https://api.example.com/tools

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

POST https://gateway.orkeia.ai/tools Autenticación
Requiere el encabezado authorization: <tu_token>.

​
Cuerpo de la Solicitud (JSON)

El servicio espera un envoltorio con la propiedad tool. (El environment se maneja en el servidor.)
Atención: el campo type no existe en esta interfaz. Utilice los campos definidos en Tool (abajo). 
{
  "tool": {
    "name": "Mi Herramienta",
    "description": "Descripción de la herramienta",
    "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"
    }
  }
}

​
Ejemplo (cURL)

curl -X POST "https://gateway.orkeia.ai/tools"   -H "authorization:  <tu_token>"   -H "Content-Type: application/json"   -d '{
    "tool": {
      "name": "Mi Herramienta",
      "description": "Descripción de la herramienta",
      "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"
      }
    }
  }'

​
Respuestas

​
Response - Éxito

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

​
500 — Error del Servidor

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

​
400 — Error del Cliente

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

​
Interfaz de Referencia (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

NombreTipoObligatorioDescripciónEjemplo
idstringNoIdentificador único (retornado por el backend).TOOL_123456
namestringSíNombre de la herramienta.Mi Herramienta
descriptionstringSíDescripción corta sobre la funcionalidad.Ejecuta operaciones de integración
codestringNoCódigo fuente ejecutable de la herramienta (cuando aplicable).export async function run(){...}
entryFunctionNamestringNoNombre de la función exportada en code que será invocada.run
sectorsstring[]SíSectores autorizados a utilizar la herramienta.["engineering","legal"]
publisherstringSíPublicador/organización responsable.Orkeia
enabledbooleanSíIndica si la herramienta está habilitada.true
environmentsstring[]SíAmbientes en los que la herramienta está disponible.["prod","staging"]
mcpobjetoNoConfiguración para uso via Model Context Protocol (MCP).{ "url": "...", "transport": "sse" }
mcp.urlstringNoURL del servidor MCP.https://tools.orkeia.ai/my-tool
mcp.transport'sse' | 'streamable-http'NoTipo de transporte MCP soportado.sse