cURL
curl --request POST \
--url https://api.example.com/toolsimport requests
url = "https://api.example.com/tools"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/tools', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$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"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/tools")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/tools")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyHerramientas
Tools create
Crea una nueva herramienta en el ambiente.
POST
/
tools
cURL
curl --request POST \
--url https://api.example.com/toolsimport requests
url = "https://api.example.com/tools"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/tools', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$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"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/tools")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/tools")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyEndpoint
POST https://gateway.orkeia.ai/tools
AutenticaciónRequiere el encabezado
authorization: <tu_token>.
Cuerpo de la Solicitud (JSON)
El servicio espera un envoltorio con la propiedadtool. (Elenvironmentse maneja en el servidor.)
Atención: el campotypeno existe en esta interfaz. Utilice los campos definidos enTool(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
| Nombre | Tipo | Obligatorio | Descripción | Ejemplo |
|---|---|---|---|---|
| id | string | No | Identificador único (retornado por el backend). | TOOL_123456 |
| name | string | Sí | Nombre de la herramienta. | Mi Herramienta |
| description | string | Sí | Descripción corta sobre la funcionalidad. | Ejecuta operaciones de integración |
| code | string | No | Código fuente ejecutable de la herramienta (cuando aplicable). | export async function run(){...} |
| entryFunctionName | string | No | Nombre de la función exportada en code que será invocada. | run |
| sectors | string[] | Sí | Sectores autorizados a utilizar la herramienta. | ["engineering","legal"] |
| publisher | string | Sí | Publicador/organización responsable. | Orkeia |
| enabled | boolean | Sí | Indica si la herramienta está habilitada. | true |
| environments | string[] | Sí | Ambientes en los que la herramienta está disponible. | ["prod","staging"] |
| mcp | objeto | No | Configuración para uso via Model Context Protocol (MCP). | { "url": "...", "transport": "sse" } |
| mcp.url | string | No | URL del servidor MCP. | https://tools.orkeia.ai/my-tool |
| mcp.transport | 'sse' | 'streamable-http' | No | Tipo de transporte MCP soportado. | sse |
¿Esta página le ayudó?
⌘I