API-Referenz
Antwort erstellen (OpenAI Responses API)
/v1/responsesResponses für Text und Toolaufrufe; optionale Felder und Tooltypen hängen vom Modell ab. stream=true liefert typisierte SSE-Ereignisse; previous_response_id garantiert weder dauerhafte Speicherung noch Wiederherstellung.
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
modelinput
Anfragekörper erforderlich
modelstringErforderlichinputunionErforderlichEingabeinhalt als Zeichenfolge oder Nachrichtenarray
oneOf-Zweig 1
Typ: string
instructionsstringOptionalmax_output_tokensintegerOptionaltemperaturenumberOptionalSampling-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.
streambooleanOptionaltoolsarrayOptionalUnterfelder von tools (1)
[]objectOptional
tool_choiceunionOptionaloneOf-Zweig 1
Typ: string
oneOf-Zweig 2
Typ: object
reasoningobjectOptionalprevious_response_idstringOptionaltruncationstringOptional- Aufzählung
["auto","disabled"]
parallel_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_tierstringOptionalAngeforderte Dienststufe, die Kosten beeinflussen kann. Standardmäßig ignoriert und nur bei Unterstützung wirksam. Zulässige Werte hängen vom gewählten Modell ab.
textobjectOptionalTextausgabe mit format für strukturierte Ausgabe; Unterstützung und Grenzen hängen vom Modell ab.
Unterfelder von text (1)
formatobjectOptionalFormat für Text und strukturierte Ausgabe, modellabhängig.
Unterfelder von format (4)
typestringOptionalKennungen der vom gewählten Modell unterstützten Ausgabeformate.
namestringOptionalName der strukturierten Ausgabe.
schemaobjectOptionalJSON Schema für strukturierte Ausgabe; muss den Modellanforderungen entsprechen.
- Zusätzliche Eigenschaften
true
strictbooleanOptionalStrikte strukturierte Ausgabe anfordern, sofern vom Modell unterstützt.
context_managementunknownOptionalKontextverwaltung, modellabhängig; keine Garantie für automatische Zusammenfassung oder dauerhaftes Gedächtnis.
stream_optionsobjectOptionalResponses-Streamingparameter mit stream=true; nur unterstützte Felder wirken.
Unterfelder von stream_options (2)
include_usagebooleanOptionalStreamingverbrauch anfordern; Verfügbarkeit hängt vom Modell ab.
include_obfuscationbooleanOptionalVerschleierung des Responses-Streams; standardmäßig ignoriert, nur bei Unterstützung wirksam.
Antworten und Fehler
HTTP 200
Antwort erfolgreich erstellt
application/json
- Typ
- object
- Zusätzliche Eigenschaften
- false
idstringOptionalobjectstringOptionalcreated_atintegerOptionalstatusstringOptional- Aufzählung
["completed","failed","in_progress","incomplete"]
modelstringOptionaloutputarrayOptionalUnterfelder von output (1)
[]objectOptional- Zusätzliche Eigenschaften
false
Unterfelder von [] (8)
typestringOptionalidstringOptionalstatusstringOptionalrolestringOptionalcontentarrayOptionalUnterfelder von content (1)
[]objectOptional- Zusätzliche Eigenschaften
false
Unterfelder von [] (3)
typestringOptional- Aufzählung
["output_text","refusal"]
textstringOptionalannotationsarrayOptionalUnterfelder von annotations (1)
[]objectOptional
call_idstringOptionalnamestringOptionalargumentsstringOptional
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
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 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
Anfrage-/Warteschlangenlimit.
application/json
- Typ
- object
- Pflichtfelder
error
errorobjectErforderlichUnterfelder von error (4)
codestringOptionalmessagestringOptionaltypestringOptionalrequest_idstringOptional
HTTP 500
Interner Authentifizierungs- oder Datenspeicherungsfehler.
application/json
- Typ
- object
- Pflichtfelder
error
errorobjectErforderlichUnterfelder von error (4)
codestringOptionalmessagestringOptionaltypestringOptionalrequest_idstringOptional