Référence API

Créer une conversation

POST/v1/chat/completions

Interface texte/outils compatible OpenAI Chat Completions ; image_url exige un modèle acceptant les images. Sortie texte/outils ; capacités, champs facultatifs et prix dépendent du modèle. stream=true renvoie du SSE, éventuellement avec utilisation finale, terminé par data: [DONE].

Authentification et autorisations

Utilisez votre clé GloopAPI actuelle. Les modèles, capacités et autorisations disponibles dépendent de son catalogue et de la documentation du point de terminaison.

Authorization: Bearer $GLOOP_API_KEY

Schémas d'authentification : BearerAuth

Requête

Corps de requête · application/json

Type
object
Champs obligatoires
modelmessages

Corps de requête obligatoire

  • modelstringObligatoire

    ID du modèle

  • messagesarrayObligatoire

    Liste des messages de conversation

    Sous-champs de messages (1)
    • []objectFacultatif
      Sous-champs de [] (6)
      • rolestringObligatoire

        Rôle du message

        Énumération
        ["system","user","assistant","tool","developer"]
      • contentunionObligatoire

        Contenu du message

        Branche oneOf 1

        Type: string

        Branche oneOf 2

        Type: array

        • []objectFacultatif
          Sous-champs de [] (6)
          • typestringFacultatif
            Énumération
            ["text","image_url","input_audio","file","video_url"]
          • textstringFacultatif
          • image_urlunionFacultatif

            Accepte deux formes wire : chaîne URL/Base64 ou objet {url, detail}. Réservé aux modèles acceptant des images ; aucune garantie que tous les modèles prennent en charge la vision.

            Branche oneOf 1

            URL d'image ou data URL Base64.

            Type: string

            Branche oneOf 2

            L'objet doit au moins fournir url ; Message.ParseContent normalise detail à high par défaut. La prise en charge dépend du modèle visuel choisi.

            Type: object

            Obligatoire dans cette branche : url

            • urlstringObligatoire

              URL d'image ou base64

            • detailstringFacultatif
              Énumération
              ["low","high","auto"]
          • input_audioobjectFacultatif
            Sous-champs de input_audio (2)
            • datastringFacultatif

              Données audio encodées en Base64

            • formatstringFacultatif
              Énumération
              ["wav","mp3"]
          • fileobjectFacultatif
            Sous-champs de file (3)
          • video_urlstringFacultatif

            L'entrée wire réellement lue par Message.ParseContent est une chaîne URL vidéo, réservée aux modèles vidéo. L'objet {url: ...} n'entre pas dans le contenu ou la mesure produits par ce parseur et n'est pas publié comme contrat utilisable.

      • namestringFacultatif

        Nom de l'expéditeur

      • tool_callsarrayFacultatif
        Sous-champs de tool_calls (1)
        • []objectFacultatif
          Sous-champs de [] (3)
      • tool_call_idstringFacultatif

        ID d'appel d'outil (pour les messages de rôle tool)

      • reasoning_contentstringFacultatif

        Contenu du raisonnement

  • temperaturenumberFacultatif

    Température d'échantillonnage. Prise en charge et limites selon modèle ; aucune valeur par défaut uniforme garantie.

  • top_pnumberFacultatif

    Paramètre d'échantillonnage nucleus. Prise en charge et limites selon modèle ; aucune valeur par défaut uniforme garantie.

  • nintegerFacultatif

    Nombre de générations. Prise en charge et limites selon modèle ; aucune valeur par défaut uniforme garantie.

  • streambooleanFacultatif

    Réponse en flux ou non

    Valeur par défaut
    false
  • stream_optionsobjectFacultatif

    Options d'utilisation du flux Chat ; la prise en charge et le retour de l'utilisation dépendent du modèle choisi.

    Sous-champs de stream_options (1)
  • stopunionFacultatif

    Séquences d'arrêt

    Branche oneOf 1

    Type: string

    Branche oneOf 2

    Type: array

    • []stringFacultatif
  • max_tokensintegerFacultatif

    Nombre maximal de tokens générés. Prise en charge et limites selon modèle ; aucune valeur par défaut uniforme garantie.

  • max_completion_tokensintegerFacultatif

    Nombre maximal de tokens de complétion. Prise en charge et limites selon modèle ; aucune valeur par défaut uniforme garantie.

  • presence_penaltynumberFacultatif

    La prise en charge et les limites dépendent du modèle choisi ; aucune valeur par défaut uniforme n'est garantie.

  • frequency_penaltynumberFacultatif

    La prise en charge et les limites dépendent du modèle choisi ; aucune valeur par défaut uniforme n'est garantie.

  • logit_biasobjectFacultatif
    Sous-champs de logit_bias (1)
  • userstringFacultatif
  • toolsarrayFacultatif
    Sous-champs de tools (1)
    • []objectFacultatif
      Sous-champs de [] (2)
      • typestringFacultatif
      • functionobjectFacultatif
        Sous-champs de function (3)
  • tool_choiceunionFacultatif
    Branche oneOf 1

    Type: string

    Énumération: ["none","auto","required"]

    Branche oneOf 2

    Type: object

    • typestringFacultatif
    • functionobjectFacultatif
      Sous-champs de function (1)
      • namestringFacultatif
  • response_formatobjectFacultatif
    Sous-champs de response_format (2)
    • typestringFacultatif
      Énumération
      ["text","json_object","json_schema"]
    • json_schemaobjectFacultatif

      Définition JSON Schema

  • seedintegerFacultatif

    La prise en charge et les limites dépendent du modèle choisi ; aucune valeur par défaut uniforme n'est garantie.

  • reasoning_effortstringFacultatif

    Intensité du raisonnement (modèles compatibles). Prise en charge et limites selon modèle ; aucune valeur par défaut uniforme garantie.

  • modalitiesarrayFacultatif
    Sous-champs de modalities (1)
    • []stringFacultatif
      Énumération
      ["text","audio"]
  • audioobjectFacultatif
    Sous-champs de audio (2)
  • parallel_tool_callsbooleanFacultatif

    Les appels d'outils parallèles dépendent du modèle choisi. Chat accepte un booléen ; Responses accepte les valeurs JSON du protocole compatible.

  • storebooleanFacultatif

    L'autorisation de conserver les requêtes et réponses dépend du modèle choisi et des capacités du service. Ce paramètre ne fournit pas une API générale de stockage des conversations.

  • prompt_cache_keystringFacultatif

    Identifiant d'association du cache de prompts service, selon modèle, sans garantie de prise en charge ou de succès. Chat accepte une chaîne ; Responses une valeur JSON du protocole service.

  • prompt_cache_retentionunknownFacultatif

    Valeur JSON de contrôle de conservation du cache de prompts service, selon modèle. La plateforme ne garantit ni énumération, ni valeur par défaut, ni durée uniforme.

  • service_tierunknownFacultatif

    Niveau de service demandé, pouvant modifier le coût. Ignoré par défaut et appliqué uniquement s'il est pris en charge. Les valeurs acceptées dépendent du modèle choisi.

Réponses et erreurs

HTTP 200

Réponse créée

application/json

Type
object
Propriétés supplémentaires
false

text/event-stream

Type
string
Description
Flux SSE ; événements, utilisation et terminaison suivent l'interface actuelle. Des erreurs peuvent apparaître dans le flux.
{
  "type": "string",
  "description": "SSE 事件流,协议事件/用量/结束符取当前接口,错误可能在流内。"
}

HTTP 400

Paramètres de requête incorrects

application/json

Type
object
  • errorobjectFacultatif
    Sous-champs de error (4)
    • messagestringFacultatif

      Message d'erreur

    • typestringFacultatif

      Type d'erreur

    • paramstringFacultatifAutorise null

      Paramètres associés

    • codestringFacultatifAutorise null

      Code d'erreur

HTTP 401

Key absente, invalide, expirée ou révoquée.

application/json

Type
object
Champs obligatoires
error

HTTP 403

Autorisations IP, compte, modèle ou outil insuffisantes.

application/json

Type
object
Champs obligatoires
error

HTTP 429

Limite de fréquence des requêtes

application/json

Type
object
  • errorobjectFacultatif
    Sous-champs de error (4)
    • messagestringFacultatif

      Message d'erreur

    • typestringFacultatif

      Type d'erreur

    • paramstringFacultatifAutorise null

      Paramètres associés

    • codestringFacultatifAutorise null

      Code d'erreur

HTTP 500

Défaillance interne d'authentification ou de stockage des données.

application/json

Type
object
Champs obligatoires
error