Plattform-Modellliste abrufen

Ermöglicht das Abrufen der Plattform-Modellliste; nach Übergabe einer Organisations-ID können die für die Organisation tatsächlich verfügbaren Modelle abgerufen werden.

Über diese Schnittstelle können Sie die Plattform-Modellliste abrufen; nach Übergabe von org_id werden die für die Organisation tatsächlich verfügbaren Modelle zurückgegeben, einschließlich der von der Organisation selbst konfigurierten Modelle.

Anfragemethode

GET

Anfrage-URL

https://api.${endpoint}/v1/model/list

Authentifizierung der Anfrage

Basic-Authentifizierung mit DevKey / DevSecret auf Kontoebene.

Anfrage

Beispielanfrage

curl -X GET 'https://api.${endpoint}/v1/model/list?org_id=p-xxxx&agent_type=LOOP_AGENT' \ -H 'Authorization: Basic ${BASIC_TOKEN}'

                      
                      curl -X GET 'https://api.${endpoint}/v1/model/list?org_id=p-xxxx&agent_type=LOOP_AGENT' \
  -H 'Authorization: Basic ${BASIC_TOKEN}'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Basic ${BASIC_TOKEN}	Basic Token als Base64-Kodierung von `DevKey:DevSecret`.

Anfrageparameter (Query Parameters)

Parameter	Typ	Beschreibung	required
org_id	String	Organisations-ID. Bei Übergabe wird die Mitgliedschaft in der Organisation geprüft und die für die Organisation verfügbaren Modelle zurückgegeben.	true
agent_type	String	Agent-Typ. Unterstützt `AGENT`, `FLOW_AGENT`, `LOOP_AGENT`, `WORKFLOW`;	true

Antwort

Beispielantwort

{ "code": 0, "message": "OK", "data": { "CHAT": { "OPEN_AI": [ { "model_name": "GPT-4o", "aiModelVersion": "gpt-4o", "modelId": "mv-xxxx", "capabilities": ["pluginSupport", "ImageRecognition", "jsonSchema"] } ] } } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "CHAT": {
      "OPEN_AI": [
        {
          "model_name": "GPT-4o",
          "aiModelVersion": "gpt-4o",
          "modelId": "mv-xxxx",
          "capabilities": ["pluginSupport", "ImageRecognition", "jsonSchema"]
        }
      ]
    }
  }
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
model_name	String	Anzeigename des Modells.
aiModelVersion	String	Versionsname des Modells.
modelId	String	Modellversions-ID, wird verwendet, wenn andere Schnittstellen ein Modell referenzieren.
capabilities	String[]	Liste der Modellfähigkeiten.

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