API-Referenz
Chat-Antwort erstellen
/v1/chat/completionsOpenAI-Chat-Completions-kompatibler Text-/Tool-Endpunkt; image_url erfordert ein Modell mit Bildeingabe. Ausgabe als Text/Tools; Funktionen, optionale Felder und Preise hängen vom Modell ab. stream=true liefert SSE, eventuell mit endgültiger Nutzung, mit Abschluss data: [DONE].
Authentifizierung und Berechtigungen
Verwenden Sie Ihren aktuellen GloopAPI-Schlüssel. Verfügbare Modelle, Funktionen und Berechtigungen hängen von seinem Katalog und der Endpunktdokumentation ab.
Authorization: Bearer $GLOOP_API_KEYAuthentifizierungsschemata: BearerAuth
Anfrage
Anfragekörper · application/json
- Typ
- object
- Pflichtfelder
modelmessages
Anfragekörper erforderlich
modelstringErforderlichModell-ID
messagesarrayErforderlichListe der Gesprächsnachrichten
Unterfelder von messages (1)
[]objectOptionalUnterfelder von [] (6)
rolestringErforderlichNachrichtenrolle
- Aufzählung
["system","user","assistant","tool","developer"]
contentunionErforderlichNachrichteninhalt
oneOf-Zweig 1
Typ: string
oneOf-Zweig 2
Typ: array
[]objectOptionalUnterfelder von [] (6)
typestringOptional- Aufzählung
["text","image_url","input_audio","file","video_url"]
textstringOptionalimage_urlunionOptionalUnterstützt URL/Base64-Zeichenfolgen oder {url, detail}-Objekte als Übertragungseingabe, nur bei Modellen mit Bildeingabe. Keine Garantie für visuelle Fähigkeiten aller Modelle.
oneOf-Zweig 1
Bild-URL oder Base64-Daten-URL.
Typ: string
oneOf-Zweig 2
Die Objekteingabe muss mindestens url enthalten. Message.ParseContent normalisiert fehlendes detail zu high; Unterstützung hängt vom gewählten visuellen Modell ab.
Typ: object
In diesem Zweig erforderlich: url
input_audioobjectOptionalfileobjectOptionalvideo_urlstringOptionalDie tatsächlich von Message.ParseContent gelesene Übertragungseingabe ist eine Video-URL als Zeichenfolge, nur für Modelle mit Videoeingabe. Ein {url: ...}-Objekt geht nicht in Inhalts-/Messungsergebnisse dieses Parsers ein und wird nicht als nutzbarer Vertrag veröffentlicht.
namestringOptionalName des Absenders
tool_callsarrayOptionaltool_call_idstringOptionalID des Tool-Aufrufs (für Nachrichten mit Rolle tool)
reasoning_contentstringOptionalReasoning-Inhalt
temperaturenumberOptionalSampling-Temperatur. Unterstützung und Grenzen hängen vom gewählten Modell ab; keine einheitlichen Standardwerte garantiert.
top_pnumberOptionalNucleus-Sampling-Parameter. Unterstützung und Grenzen hängen vom gewählten Modell ab; keine einheitlichen Standardwerte garantiert.
nintegerOptionalZu generierende Anzahl. Unterstützung und Grenzen hängen vom gewählten Modell ab; keine einheitlichen Standardwerte garantiert.
streambooleanOptionalOb die Antwort gestreamt wird
- Standardwert
false
stream_optionsobjectOptionalOptionen für Nutzungsdaten im Chat-Stream; Unterstützung und Rückgabe von Nutzungsdaten hängen vom gewählten Modell ab.
Unterfelder von stream_options (1)
include_usagebooleanOptional
stopunionOptionalStoppsequenzen
oneOf-Zweig 1
Typ: string
max_tokensintegerOptionalMaximale Anzahl generierter Tokens. Unterstützung und Grenzen hängen vom gewählten Modell ab; keine einheitlichen Standardwerte garantiert.
max_completion_tokensintegerOptionalMaximale Anzahl der Completion-Tokens. Unterstützung und Grenzen hängen vom gewählten Modell ab; keine einheitlichen Standardwerte garantiert.
presence_penaltynumberOptionalUnterstützung und Grenzen hängen vom gewählten Modell ab; einheitliche Standardwerte sind nicht garantiert.
frequency_penaltynumberOptionalUnterstützung und Grenzen hängen vom gewählten Modell ab; einheitliche Standardwerte sind nicht garantiert.
logit_biasobjectOptionalUnterfelder von logit_bias (1)
[key]numberOptional
userstringOptionaltoolsarrayOptionalUnterfelder von tools (1)
[]objectOptionalUnterfelder von [] (2)
typestringOptionalfunctionobjectOptionalUnterfelder von function (3)
namestringOptionaldescriptionstringOptionalparametersobjectOptionalParameterdefinition im JSON-Schema-Format
tool_choiceunionOptionaloneOf-Zweig 1
Typ: string
Aufzählung:
["none","auto","required"]response_formatobjectOptionalUnterfelder von response_format (2)
typestringOptional- Aufzählung
["text","json_object","json_schema"]
json_schemaobjectOptionalJSON-Schema-Definition
seedintegerOptionalUnterstützung und Grenzen hängen vom gewählten Modell ab; einheitliche Standardwerte sind nicht garantiert.
reasoning_effortstringOptionalReasoning-Intensität (für unterstützende Modelle). Unterstützung und Grenzen hängen vom gewählten Modell ab; keine einheitlichen Standardwerte garantiert.
modalitiesarrayOptionalUnterfelder von modalities (1)
[]stringOptional- Aufzählung
["text","audio"]
audioobjectOptionalparallel_tool_callsbooleanOptionalOb parallele Werkzeugaufrufe erlaubt sind, hängt vom gewählten Modell ab. Chat akzeptiert einen booleschen Wert; Responses akzeptiert JSON-Werte des kompatiblen Protokolls.
storebooleanOptionalOb Anfragen und Antworten gespeichert werden dürfen, hängt vom gewählten Modell und den unterstützten Dienstfunktionen ab. Dies stellt keine allgemeine API zur Gesprächsspeicherung bereit.
prompt_cache_keystringOptionalZuordnungskennung des Dienst-Prompt-Caches, modellabhängig, ohne Treffer- oder Unterstützungsgarantie. Chat akzeptiert Zeichenfolgen, Responses kompatible Protokoll-JSON-Werte.
prompt_cache_retentionunknownOptionalJSON-Wert zur Aufbewahrung des Dienst-Prompt-Caches, modellabhängig. Keine einheitlichen Aufzählungen, Standardwerte oder Aufbewahrungsgarantien der Plattform.
service_tierunknownOptionalAngeforderte Dienststufe, die Kosten beeinflussen kann. Standardmäßig ignoriert und nur bei Unterstützung wirksam. Zulässige Werte hängen vom gewählten Modell ab.
Antworten und Fehler
HTTP 200
Antwort erfolgreich erstellt
application/json
- Typ
- object
- Zusätzliche Eigenschaften
- false
idstringOptionalobjectstringOptionalcreatedintegerOptionalmodelstringOptionalchoicesarrayOptionalUnterfelder von choices (1)
[]objectOptional- Zusätzliche Eigenschaften
false
Unterfelder von [] (3)
indexintegerOptionalmessageobjectOptional- Zusätzliche Eigenschaften
false
Unterfelder von message (5)
rolestringErforderlich- Aufzählung
["assistant"]
Textinhalt der Antwort.
tool_callsarrayOptional
finish_reasonstringOptional- Aufzählung
["stop","length","tool_calls","content_filter"]
usageobjectOptionalUnterfelder von usage (5)
prompt_tokensintegerOptionalPrompt-Tokenanzahl
completion_tokensintegerOptionalCompletion-Tokenanzahl
total_tokensintegerOptionalGesamte Tokenanzahl
prompt_tokens_detailsobjectOptionalUnterfelder von prompt_tokens_details (4)
cached_tokensintegerOptionaltext_tokensintegerOptionalaudio_tokensintegerOptionalimage_tokensintegerOptional
completion_tokens_detailsobjectOptionalUnterfelder von completion_tokens_details (3)
text_tokensintegerOptionalaudio_tokensintegerOptionalreasoning_tokensintegerOptional
system_fingerprintstringOptional
text/event-stream
- Typ
- string
- Beschreibung
- SSE-Ereignisstrom; Ereignisse, Nutzung und Endmarker richten sich nach dem Endpunkt. Fehler können im Stream auftreten.
{
"type": "string",
"description": "SSE 事件流,协议事件/用量/结束符取当前接口,错误可能在流内。"
}HTTP 400
Ungültige Anfrageparameter
application/json
- Typ
- object
errorobjectOptional
HTTP 401
Key fehlt, ist ungültig, abgelaufen oder widerrufen.
application/json
- Typ
- object
- Pflichtfelder
error
errorobjectErforderlichUnterfelder von error (4)
codestringOptionalmessagestringOptionaltypestringOptionalrequest_idstringOptional
HTTP 403
Unzureichende IP-, Konto-, Modell- oder Tool-Berechtigungen.
application/json
- Typ
- object
- Pflichtfelder
error
errorobjectErforderlichUnterfelder von error (4)
codestringOptionalmessagestringOptionaltypestringOptionalrequest_idstringOptional
HTTP 429
Anfrageratenlimit
application/json
- Typ
- object
errorobjectOptional
HTTP 500
Interner Authentifizierungs- oder Datenspeicherungsfehler.
application/json
- Typ
- object
- Pflichtfelder
error
errorobjectErforderlichUnterfelder von error (4)
codestringOptionalmessagestringOptionaltypestringOptionalrequest_idstringOptional