Référence API
Créer une conversation
/v1/chat/completionsInterface 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_KEYSchémas d'authentification : BearerAuth
Requête
Corps de requête · application/json
- Type
- object
- Champs obligatoires
modelmessages
Corps de requête obligatoire
modelstringObligatoireID du modèle
messagesarrayObligatoireListe des messages de conversation
Sous-champs de messages (1)
[]objectFacultatifSous-champs de [] (6)
rolestringObligatoireRôle du message
- Énumération
["system","user","assistant","tool","developer"]
contentunionObligatoireContenu du message
Branche oneOf 1
Type: string
Branche oneOf 2
Type: array
[]objectFacultatifSous-champs de [] (6)
typestringFacultatif- Énumération
["text","image_url","input_audio","file","video_url"]
textstringFacultatifimage_urlunionFacultatifAccepte 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
input_audioobjectFacultatiffileobjectFacultatifvideo_urlstringFacultatifL'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.
namestringFacultatifNom de l'expéditeur
tool_callsarrayFacultatiftool_call_idstringFacultatifID d'appel d'outil (pour les messages de rôle tool)
reasoning_contentstringFacultatifContenu du raisonnement
temperaturenumberFacultatifTempérature d'échantillonnage. Prise en charge et limites selon modèle ; aucune valeur par défaut uniforme garantie.
top_pnumberFacultatifParamètre d'échantillonnage nucleus. Prise en charge et limites selon modèle ; aucune valeur par défaut uniforme garantie.
nintegerFacultatifNombre de générations. Prise en charge et limites selon modèle ; aucune valeur par défaut uniforme garantie.
streambooleanFacultatifRéponse en flux ou non
- Valeur par défaut
false
stream_optionsobjectFacultatifOptions 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)
include_usagebooleanFacultatif
stopunionFacultatifSéquences d'arrêt
Branche oneOf 1
Type: string
max_tokensintegerFacultatifNombre maximal de tokens générés. Prise en charge et limites selon modèle ; aucune valeur par défaut uniforme garantie.
max_completion_tokensintegerFacultatifNombre maximal de tokens de complétion. Prise en charge et limites selon modèle ; aucune valeur par défaut uniforme garantie.
presence_penaltynumberFacultatifLa prise en charge et les limites dépendent du modèle choisi ; aucune valeur par défaut uniforme n'est garantie.
frequency_penaltynumberFacultatifLa prise en charge et les limites dépendent du modèle choisi ; aucune valeur par défaut uniforme n'est garantie.
logit_biasobjectFacultatifSous-champs de logit_bias (1)
[key]numberFacultatif
userstringFacultatiftoolsarrayFacultatifSous-champs de tools (1)
[]objectFacultatifSous-champs de [] (2)
typestringFacultatiffunctionobjectFacultatifSous-champs de function (3)
namestringFacultatifdescriptionstringFacultatifparametersobjectFacultatifParamètres définis au format JSON Schema
tool_choiceunionFacultatifBranche oneOf 1
Type: string
Énumération:
["none","auto","required"]response_formatobjectFacultatifSous-champs de response_format (2)
typestringFacultatif- Énumération
["text","json_object","json_schema"]
json_schemaobjectFacultatifDéfinition JSON Schema
seedintegerFacultatifLa prise en charge et les limites dépendent du modèle choisi ; aucune valeur par défaut uniforme n'est garantie.
reasoning_effortstringFacultatifIntensité du raisonnement (modèles compatibles). Prise en charge et limites selon modèle ; aucune valeur par défaut uniforme garantie.
modalitiesarrayFacultatifSous-champs de modalities (1)
[]stringFacultatif- Énumération
["text","audio"]
audioobjectFacultatifparallel_tool_callsbooleanFacultatifLes appels d'outils parallèles dépendent du modèle choisi. Chat accepte un booléen ; Responses accepte les valeurs JSON du protocole compatible.
storebooleanFacultatifL'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_keystringFacultatifIdentifiant 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_retentionunknownFacultatifValeur 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_tierunknownFacultatifNiveau 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
idstringFacultatifobjectstringFacultatifcreatedintegerFacultatifmodelstringFacultatifchoicesarrayFacultatifSous-champs de choices (1)
[]objectFacultatif- Propriétés supplémentaires
false
Sous-champs de [] (3)
indexintegerFacultatifmessageobjectFacultatif- Propriétés supplémentaires
false
Sous-champs de message (5)
rolestringObligatoire- Énumération
["assistant"]
Contenu textuel de la réponse.
tool_callsarrayFacultatif
finish_reasonstringFacultatif- Énumération
["stop","length","tool_calls","content_filter"]
usageobjectFacultatifSous-champs de usage (5)
prompt_tokensintegerFacultatifNombre de tokens du prompt
completion_tokensintegerFacultatifNombre de tokens de complétion
total_tokensintegerFacultatifNombre total de tokens
prompt_tokens_detailsobjectFacultatifSous-champs de prompt_tokens_details (4)
cached_tokensintegerFacultatiftext_tokensintegerFacultatifaudio_tokensintegerFacultatifimage_tokensintegerFacultatif
completion_tokens_detailsobjectFacultatifSous-champs de completion_tokens_details (3)
text_tokensintegerFacultatifaudio_tokensintegerFacultatifreasoning_tokensintegerFacultatif
system_fingerprintstringFacultatif
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
HTTP 401
Key absente, invalide, expirée ou révoquée.
application/json
- Type
- object
- Champs obligatoires
error
errorobjectObligatoireSous-champs de error (4)
codestringFacultatifmessagestringFacultatiftypestringFacultatifrequest_idstringFacultatif
HTTP 403
Autorisations IP, compte, modèle ou outil insuffisantes.
application/json
- Type
- object
- Champs obligatoires
error
errorobjectObligatoireSous-champs de error (4)
codestringFacultatifmessagestringFacultatiftypestringFacultatifrequest_idstringFacultatif
HTTP 429
Limite de fréquence des requêtes
application/json
- Type
- object
errorobjectFacultatif
HTTP 500
Défaillance interne d'authentification ou de stockage des données.
application/json
- Type
- object
- Champs obligatoires
error
errorobjectObligatoireSous-champs de error (4)
codestringFacultatifmessagestringFacultatiftypestringFacultatifrequest_idstringFacultatif