Crear Tool

Permite crear un Tool en una organización específica y generar automáticamente actions mediante un OpenAPI Schema.

Mediante esta interfaz, se puede crear un Tool en una organización específica. Al proporcionar api_schema, se generan actions de forma simultánea; si no se proporciona, solo se crea el contenedor del Tool.

Método de solicitud

POST

URL de la solicitud

https://api.${endpoint}/v1/org/tool/create

Autenticación de la solicitud

Utiliza la autenticación Basic con DevKey / DevSecret a nivel de cuenta y requiere que la cuenta que realiza la llamada tenga permiso de creación de Tool de la organización.

Solicitud

Ejemplo de solicitud

curl -X POST 'https://api.${endpoint}/v1/org/tool/create' \ -H 'Authorization: Basic ${BASIC_TOKEN}' \ -H 'Content-Type: application/json' \ -d '{ "org_id": "p-xxxx", "name": "weather", "display_name": "Weather Lookup", "description": "Query current weather by city name", "logo": "https://cdn.example.com/weather.png", "url": "https://api.example.com", "show_request": true, "api_schema": "{\"openapi\":\"3.0.0\",\"paths\":{}}" }'

                      
                      curl -X POST 'https://api.${endpoint}/v1/org/tool/create' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
    "org_id": "p-xxxx",
    "name": "weather",
    "display_name": "Weather Lookup",
    "description": "Query current weather by city name",
    "logo": "https://cdn.example.com/weather.png",
    "url": "https://api.example.com",
    "show_request": true,
    "api_schema": "{\"openapi\":\"3.0.0\",\"paths\":{}}"
  }'

Este bloque de código en una ventana flotante

Cabeceras de la solicitud

Campo	Tipo	Descripción
Authorization	Basic ${BASIC_TOKEN}	Basic Token resultante de codificar `DevKey:DevSecret` en Base64.
Content-Type	application/json	Formato del cuerpo de la solicitud.

Parámetros de la solicitud (Body Parameters)

Campo	Tipo	Descripción	Obligatorio
org_id	String	ID de la organización.	true
name	String	Nombre del Tool, hasta 20 caracteres.	true
display_name	String	Nombre de visualización del Tool, hasta 50 caracteres.	false
description	String	Descripción del Tool, hasta 100 caracteres.	true
logo	String	URL del icono del Tool.	true
url	String	URL base del Tool, debe ser una dirección pública `http/https`.	true
show_request	Boolean	Indica si se muestra el contenido de la solicitud durante la invocación.	true
api_schema	String	OpenAPI JSON Schema. Al proporcionarlo se generan actions y, si tiene éxito, `available=true`; si no se proporciona, `available=false`.	false

Respuesta

Ejemplo de respuesta

{ "code": 0, "message": "OK", "data": { "tool_id": "tool-xxxx", "name": "weather", "available": true } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "tool_id": "tool-xxxx",
    "name": "weather",
    "available": true
  }
}

Este bloque de código en una ventana flotante

Respuesta correcta

Campo	Tipo	Descripción
tool_id	String	ID del Tool recién creado.
name	String	Nombre del Tool.
available	Boolean	Indica si el Tool está disponible.

Respuesta fallida

Campo	Tipo	Descripción
code	Integer	Código de error.
message	String	Detalles del error.

Códigos de estado

Código de estado	Descripción
200	Correcto
400	Error de parámetros
401	No autorizado
403	Permisos insuficientes
429	Demasiadas solicitudes
500	Error del servidor