Tool erstellen

Ermöglicht das Erstellen eines Tool innerhalb einer bestimmten Organisation und die automatische Generierung von actions über ein OpenAPI-Schema.

Über diese Schnittstelle können Sie ein Tool innerhalb einer bestimmten Organisation erstellen. Wird api_schema übergeben, werden gleichzeitig actions generiert; ohne Angabe wird nur die Tool-Hülle erstellt.

Anfragemethode

POST

Anfrage-URL

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

Authentifizierung der Anfrage

Basic-Authentifizierung mit DevKey / DevSecret auf Kontoebene; das aufrufende Konto muss über die Berechtigung zum Erstellen von Tool der Organisation verfügen.

Anfrage

Beispielanfrage

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

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Basic ${BASIC_TOKEN}	Basic Token als Base64-Kodierung von `DevKey:DevSecret`.
Content-Type	application/json	Format des Anfrage-Body.

Anfrageparameter (Body Parameters)

Parameter	Typ	Beschreibung	required
org_id	String	Organisations-ID.	true
name	String	Tool-Name, maximal 20 Zeichen.	true
display_name	String	Anzeigename des Tool, maximal 50 Zeichen.	false
description	String	Tool-Beschreibung, maximal 100 Zeichen.	true
logo	String	URL des Tool-Symbols.	true
url	String	Basis-URL des Tool, muss eine öffentliche `http/https`-Adresse sein.	true
show_request	Boolean	Ob der Anfrageinhalt während des Aufrufs angezeigt wird.	true
api_schema	String	OpenAPI-JSON-Schema. Bei Übergabe werden actions generiert und nach Erfolg gilt `available=true`; ohne Angabe `available=false`.	false

Antwort

Beispielantwort

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

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
tool_id	String	ID des neu erstellten Tool.
name	String	Tool-Name.
available	Boolean	Ob das Tool verfügbar ist.

Fehlerantwort

Feld	Typ	Beschreibung
code	Integer	Fehlercode.
message	String	Fehlerdetails.

Statuscodes

Statuscode	Beschreibung
200	Erfolgreich
400	Ungültige Parameter
401	Nicht autorisiert
403	Unzureichende Berechtigungen
429	Zu viele Anfragen
500	Serverfehler