Actualizar Tool

Permite actualizar la información básica, la definición de la interfaz y la información de autenticación del Tool de una organización específica.

Mediante esta interfaz, se puede actualizar la información básica, la definición de la interfaz y la información de autenticación del Tool de una organización específica.

Método de solicitud

PUT

URL de la solicitud

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

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 gestión de Tool de la organización.

Solicitud

Ejemplo de solicitud

curl -X PUT 'https://api.${endpoint}/v1/org/tool/update' \ -H 'Authorization: Basic ${BASIC_TOKEN}' \ -H 'Content-Type: application/json' \ -d '{ "org_id": "p-xxxx", "tool_id": "tool-xxxx", "name": "weather", "display_name": "Weather Lookup", "description": "Query current weather", "logo": "https://cdn.example.com/weather.png", "url": "https://api.example.com", "show_request": true, "api_schema": "{\"openapi\":\"3.0.0\",\"paths\":{}}", "auth_provider": "Creator", "auth_type": "Bearer", "auth_key": "token" }'

                      
                      curl -X PUT 'https://api.${endpoint}/v1/org/tool/update' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
    "org_id": "p-xxxx",
    "tool_id": "tool-xxxx",
    "name": "weather",
    "display_name": "Weather Lookup",
    "description": "Query current weather",
    "logo": "https://cdn.example.com/weather.png",
    "url": "https://api.example.com",
    "show_request": true,
    "api_schema": "{\"openapi\":\"3.0.0\",\"paths\":{}}",
    "auth_provider": "Creator",
    "auth_type": "Bearer",
    "auth_key": "token"
  }'

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
tool_id	String	ID del Tool.	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. Si no se indica, no se actualiza la definición de la interfaz.	false
auth_provider	String	Proveedor de autenticación. Si no se indica, no se actualiza la configuración de autenticación.	false
auth_type	String	Tipo de autenticación.	false
auth_key	String	Key o token de autenticación.	false
auth_key_name	String	Nombre de visualización de la key de autenticación.	false
auth_key_tip	String	Sugerencia de la key de autenticación.	false
auth_secret	String	Secret de autenticación.	false
auth_secret_name	String	Nombre de visualización del secret de autenticación.	false
auth_secret_tip	String	Sugerencia del secret de autenticación.	false

Respuesta

Ejemplo de respuesta

{ "code": 0, "message": "OK", "affect_count": 1 }

                      
                      {
  "code": 0,
  "message": "OK",
  "affect_count": 1
}

Este bloque de código en una ventana flotante

Respuesta correcta

Campo	Tipo	Descripción
affect_count	Integer	Número de registros afectados.

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