API-Referenz

Antwort erstellen (OpenAI Responses API)

POST/v1/responses

Responses 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_KEY

Authentifizierungsschemata: BearerAuth

Anfrage

Anfragekörper · application/json

Typ
object
Pflichtfelder
modelinput

Anfragekörper erforderlich

  • modelstringErforderlich
  • inputunionErforderlich

    Eingabeinhalt als Zeichenfolge oder Nachrichtenarray

    oneOf-Zweig 1

    Typ: string

    oneOf-Zweig 2

    Typ: array

    • []objectOptional
  • instructionsstringOptional
  • max_output_tokensintegerOptional
  • temperaturenumberOptional

    Sampling-Temperatur. Unterstützung und Grenzen hängen vom gewählten Modell ab; keine einheitlichen Standardwerte garantiert.

  • top_pnumberOptional

    Nucleus-Sampling-Parameter. Unterstützung und Grenzen hängen vom gewählten Modell ab; keine einheitlichen Standardwerte garantiert.

  • streambooleanOptional
  • toolsarrayOptional
    Unterfelder von tools (1)
    • []objectOptional
  • tool_choiceunionOptional
    oneOf-Zweig 1

    Typ: string

    oneOf-Zweig 2

    Typ: object

  • reasoningobjectOptional
    Unterfelder von reasoning (2)
    • effortstringOptional
      Aufzählung
      ["low","medium","high"]
    • summarystringOptional
  • previous_response_idstringOptional
  • truncationstringOptional
    Aufzählung
    ["auto","disabled"]
  • parallel_tool_callsbooleanOptional

    Ob parallele Werkzeugaufrufe erlaubt sind, hängt vom gewählten Modell ab. Chat akzeptiert einen booleschen Wert; Responses akzeptiert JSON-Werte des kompatiblen Protokolls.

  • storebooleanOptional

    Ob 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_keystringOptional

    Zuordnungskennung des Dienst-Prompt-Caches, modellabhängig, ohne Treffer- oder Unterstützungsgarantie. Chat akzeptiert Zeichenfolgen, Responses kompatible Protokoll-JSON-Werte.

  • prompt_cache_retentionunknownOptional

    JSON-Wert zur Aufbewahrung des Dienst-Prompt-Caches, modellabhängig. Keine einheitlichen Aufzählungen, Standardwerte oder Aufbewahrungsgarantien der Plattform.

  • service_tierstringOptional

    Angeforderte Dienststufe, die Kosten beeinflussen kann. Standardmäßig ignoriert und nur bei Unterstützung wirksam. Zulässige Werte hängen vom gewählten Modell ab.

  • textobjectOptional

    Textausgabe mit format für strukturierte Ausgabe; Unterstützung und Grenzen hängen vom Modell ab.

    Unterfelder von text (1)
    • formatobjectOptional

      Format für Text und strukturierte Ausgabe, modellabhängig.

      Unterfelder von format (4)
      • typestringOptional

        Kennungen der vom gewählten Modell unterstützten Ausgabeformate.

      • namestringOptional

        Name der strukturierten Ausgabe.

      • schemaobjectOptional

        JSON Schema für strukturierte Ausgabe; muss den Modellanforderungen entsprechen.

        Zusätzliche Eigenschaften
        true
      • strictbooleanOptional

        Strikte strukturierte Ausgabe anfordern, sofern vom Modell unterstützt.

  • context_managementunknownOptional

    Kontextverwaltung, modellabhängig; keine Garantie für automatische Zusammenfassung oder dauerhaftes Gedächtnis.

  • stream_optionsobjectOptional

    Responses-Streamingparameter mit stream=true; nur unterstützte Felder wirken.

    Unterfelder von stream_options (2)
    • include_usagebooleanOptional

      Streamingverbrauch anfordern; Verfügbarkeit hängt vom Modell ab.

    • include_obfuscationbooleanOptional

      Verschleierung 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

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

HTTP 403

Unzureichende IP-, Konto-, Modell- oder Tool-Berechtigungen.

application/json

Typ
object
Pflichtfelder
error

HTTP 429

Anfrage-/Warteschlangenlimit.

application/json

Typ
object
Pflichtfelder
error

HTTP 500

Interner Authentifizierungs- oder Datenspeicherungsfehler.

application/json

Typ
object
Pflichtfelder
error
Bereit zum Entwickeln? Öffnen Sie Konsole um einen API-Schlüssel zu erstellen, oder durchsuchen Sie Funktionen.