API-Referenz

Chat-Antwort erstellen

POST/v1/chat/completions

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

Authentifizierungsschemata: BearerAuth

Anfrage

Anfragekörper · application/json

Typ
object
Pflichtfelder
modelmessages

Anfragekörper erforderlich

  • modelstringErforderlich

    Modell-ID

  • messagesarrayErforderlich

    Liste der Gesprächsnachrichten

    Unterfelder von messages (1)
    • []objectOptional
      Unterfelder von [] (6)
      • rolestringErforderlich

        Nachrichtenrolle

        Aufzählung
        ["system","user","assistant","tool","developer"]
      • contentunionErforderlich

        Nachrichteninhalt

        oneOf-Zweig 1

        Typ: string

        oneOf-Zweig 2

        Typ: array

        • []objectOptional
          Unterfelder von [] (6)
          • typestringOptional
            Aufzählung
            ["text","image_url","input_audio","file","video_url"]
          • textstringOptional
          • image_urlunionOptional

            Unterstü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

            • urlstringErforderlich

              Bild-URL oder base64

            • detailstringOptional
              Aufzählung
              ["low","high","auto"]
          • input_audioobjectOptional
            Unterfelder von input_audio (2)
            • datastringOptional

              Base64-kodierte Audiodaten

            • formatstringOptional
              Aufzählung
              ["wav","mp3"]
          • fileobjectOptional
            Unterfelder von file (3)
          • video_urlstringOptional

            Die 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.

      • namestringOptional

        Name des Absenders

      • tool_callsarrayOptional
        Unterfelder von tool_calls (1)
        • []objectOptional
          Unterfelder von [] (3)
      • tool_call_idstringOptional

        ID des Tool-Aufrufs (für Nachrichten mit Rolle tool)

      • reasoning_contentstringOptional

        Reasoning-Inhalt

  • 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.

  • nintegerOptional

    Zu generierende Anzahl. Unterstützung und Grenzen hängen vom gewählten Modell ab; keine einheitlichen Standardwerte garantiert.

  • streambooleanOptional

    Ob die Antwort gestreamt wird

    Standardwert
    false
  • stream_optionsobjectOptional

    Optionen 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)
  • stopunionOptional

    Stoppsequenzen

    oneOf-Zweig 1

    Typ: string

    oneOf-Zweig 2

    Typ: array

    • []stringOptional
  • max_tokensintegerOptional

    Maximale Anzahl generierter Tokens. Unterstützung und Grenzen hängen vom gewählten Modell ab; keine einheitlichen Standardwerte garantiert.

  • max_completion_tokensintegerOptional

    Maximale Anzahl der Completion-Tokens. Unterstützung und Grenzen hängen vom gewählten Modell ab; keine einheitlichen Standardwerte garantiert.

  • presence_penaltynumberOptional

    Unterstützung und Grenzen hängen vom gewählten Modell ab; einheitliche Standardwerte sind nicht garantiert.

  • frequency_penaltynumberOptional

    Unterstützung und Grenzen hängen vom gewählten Modell ab; einheitliche Standardwerte sind nicht garantiert.

  • logit_biasobjectOptional
    Unterfelder von logit_bias (1)
  • userstringOptional
  • toolsarrayOptional
    Unterfelder von tools (1)
    • []objectOptional
      Unterfelder von [] (2)
  • tool_choiceunionOptional
    oneOf-Zweig 1

    Typ: string

    Aufzählung: ["none","auto","required"]

    oneOf-Zweig 2

    Typ: object

    • typestringOptional
    • functionobjectOptional
      Unterfelder von function (1)
  • response_formatobjectOptional
    Unterfelder von response_format (2)
    • typestringOptional
      Aufzählung
      ["text","json_object","json_schema"]
    • json_schemaobjectOptional

      JSON-Schema-Definition

  • seedintegerOptional

    Unterstützung und Grenzen hängen vom gewählten Modell ab; einheitliche Standardwerte sind nicht garantiert.

  • reasoning_effortstringOptional

    Reasoning-Intensität (für unterstützende Modelle). Unterstützung und Grenzen hängen vom gewählten Modell ab; keine einheitlichen Standardwerte garantiert.

  • modalitiesarrayOptional
    Unterfelder von modalities (1)
    • []stringOptional
      Aufzählung
      ["text","audio"]
  • audioobjectOptional
    Unterfelder von audio (2)
  • 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_tierunknownOptional

    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.

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 400

Ungültige Anfrageparameter

application/json

Typ
object
  • errorobjectOptional
    Unterfelder von error (4)
    • messagestringOptional

      Fehlermeldung

    • typestringOptional

      Fehlertyp

    • paramstringOptionalErlaubt null

      Zugehörige Parameter

    • codestringOptionalErlaubt null

      Fehlercode

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

Anfrageratenlimit

application/json

Typ
object
  • errorobjectOptional
    Unterfelder von error (4)
    • messagestringOptional

      Fehlermeldung

    • typestringOptional

      Fehlertyp

    • paramstringOptionalErlaubt null

      Zugehörige Parameter

    • codestringOptionalErlaubt null

      Fehlercode

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.