Interroger la liste des modèles de la plateforme

Permet d'interroger la liste des modèles de la plateforme ; en fournissant l'ID de l'organisation, vous pouvez interroger les modèles réellement disponibles pour cette organisation.

Cette interface permet d'interroger la liste des modèles de la plateforme ; en fournissant org_id, elle renvoie les modèles réellement disponibles pour cette organisation, y compris les modèles configurés par l'organisation.

Méthode de requête

GET

URL de la requête

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

Authentification de la requête

Utilise l'authentification Basic avec la DevKey / le DevSecret de niveau compte.

Requête

Exemple de requête

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}'

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.

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

Champ	Type	Description	required
org_id	String	ID de l'organisation. Une fois fourni, l'appartenance à l'organisation est vérifiée et les modèles disponibles pour cette organisation sont renvoyés.	true
agent_type	String	Type d'Agent. Prend en charge `AGENT`, `FLOW_AGENT`, `LOOP_AGENT`, `WORKFLOW` ;	true

Réponse

Exemple de réponse

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

Ce bloc de code dans la fenêtre flottante

Réponse en cas de succès

Champ	Type	Description
model_name	String	Nom d'affichage du modèle.
aiModelVersion	String	Nom de la version du modèle.
modelId	String	ID de la version du modèle, utilisé lorsque d'autres interfaces référencent le modèle.
capabilities	String[]	Liste des capacités du modèle.

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