Créer un Tool

Permet de créer un Tool au sein de l'organisation spécifiée et de générer automatiquement des actions via un OpenAPI Schema.

Cette interface permet de créer un Tool au sein de l'organisation spécifiée. Lorsque api_schema est fourni, les actions sont générées simultanément ; sinon, seule la coquille du Tool est créée.

Méthode de requête

POST

URL de la requête

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

Authentification de la requête

Utilise l'authentification Basic avec la DevKey / le DevSecret de niveau compte et requiert que le compte appelant dispose de l'autorisation de création de Tool de l'organisation.

Requête

Exemple de requête

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\":{}}"
  }'

Ce bloc de code dans la fenêtre flottante

En-têtes de la requête

Champ	Type	Description
Authorization	Basic ${BASIC_TOKEN}	Utilisez le Basic Token obtenu en encodant `DevKey:DevSecret` en Base64.
Content-Type	application/json	Format du corps de la requête.

Paramètres de la requête (Body Parameters)

Champ	Type	Description	required
org_id	String	ID de l'organisation.	true
name	String	Nom du Tool, 20 caractères maximum.	true
display_name	String	Nom d'affichage du Tool, 50 caractères maximum.	false
description	String	Description du Tool, 100 caractères maximum.	true
logo	String	URL de l'icône du Tool.	true
url	String	URL de base du Tool, doit être une adresse publique `http/https`.	true
show_request	Boolean	Indique s'il faut afficher le contenu de la requête pendant l'appel.	true
api_schema	String	OpenAPI JSON Schema. Lorsqu'il est fourni, les actions sont générées et `available=true` en cas de succès ; sinon `available=false`.	false

Réponse

Exemple de réponse

{ "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
  }
}

Ce bloc de code dans la fenêtre flottante

Réponse en cas de succès

Champ	Type	Description
tool_id	String	ID du nouveau Tool.
name	String	Nom du Tool.
available	Boolean	Indique si le Tool est disponible.

Réponse en cas d'échec

Champ	Type	Description
code	Integer	Code d'erreur.
message	String	Détails de l'erreur.

Codes d'état

Code d'état	Description
200	Succès
400	Erreur de paramètre
401	Non autorisé
403	Autorisation insuffisante
429	Requêtes trop fréquentes
500	Erreur du serveur