Riferimento API

Crea una risposta (OpenAI Responses API)

POST/v1/responses

Interfaccia Responses per testo e chiamate a strumenti; campi opzionali e tipi di strumenti dipendono dal modello. stream=true restituisce eventi SSE tipizzati; previous_response_id non garantisce archiviazione persistente o recupero.

Autenticazione e autorizzazioni

Usa la chiave GloopAPI corrente. Modelli, funzionalità e autorizzazioni disponibili dipendono dal relativo catalogo e dalla documentazione dell'endpoint.

Authorization: Bearer $GLOOP_API_KEY

Schemi di autenticazione: BearerAuth

Richiesta

Corpo della richiesta · application/json

Tipo
object
Campi obbligatori
modelinput

Corpo della richiesta obbligatorio

  • modelstringObbligatorio
  • inputunionObbligatorio

    Input, come stringa o array di messaggi

    Ramo oneOf 1

    Tipo: string

    Ramo oneOf 2

    Tipo: array

    • []objectFacoltativo
  • instructionsstringFacoltativo
  • max_output_tokensintegerFacoltativo
  • temperaturenumberFacoltativo

    Temperatura di campionamento. Supporto e limiti secondo modello; nessun valore predefinito uniforme garantito.

  • top_pnumberFacoltativo

    Parametro di campionamento nucleus. Supporto e limiti secondo modello; nessun valore predefinito uniforme garantito.

  • streambooleanFacoltativo
  • toolsarrayFacoltativo
    Campi figli di tools (1)
    • []objectFacoltativo
  • tool_choiceunionFacoltativo
    Ramo oneOf 1

    Tipo: string

    Ramo oneOf 2

    Tipo: object

  • reasoningobjectFacoltativo
    Campi figli di reasoning (2)
    • effortstringFacoltativo
      Enumerazione
      ["low","medium","high"]
    • summarystringFacoltativo
  • previous_response_idstringFacoltativo
  • truncationstringFacoltativo
    Enumerazione
    ["auto","disabled"]
  • parallel_tool_callsbooleanFacoltativo

    Le chiamate parallele agli strumenti dipendono dal modello scelto. Chat accetta un booleano; Responses accetta valori JSON del protocollo compatibile.

  • storebooleanFacoltativo

    La possibilità di salvare richieste e risposte dipende dal modello scelto e dalle funzionalità supportate dal servizio. Non offre un'API generale per archiviare conversazioni.

  • prompt_cache_keystringFacoltativo

    Identificatore della cache dei prompt , secondo modello, senza garanzia di riscontro o supporto. Chat accetta stringhe; Responses valori JSON del protocollo del servizio.

  • prompt_cache_retentionunknownFacoltativo

    Valore JSON per la conservazione della cache dei prompt , secondo modello. Nessuna enumerazione, valore predefinito o garanzia uniforme della piattaforma.

  • service_tierstringFacoltativo

    Livello di servizio richiesto, che può incidere sul costo. Ignorato per impostazione predefinita e applicato solo se supportato. I valori ammessi dipendono dal modello scelto.

  • textobjectFacoltativo

    Configurazione del testo, incluso format per output strutturato; supporto e limiti dipendono dal modello.

    Campi figli di text (1)
    • formatobjectFacoltativo

      Formato di testo e output strutturato secondo il modello.

      Campi figli di format (4)
      • typestringFacoltativo

        Identificatori dei formati di output supportati dal modello.

      • namestringFacoltativo

        Nome dell'output strutturato.

      • schemaobjectFacoltativo

        JSON Schema per output strutturato; deve rispettare i requisiti del modello.

        Proprietà aggiuntive
        true
      • strictbooleanFacoltativo

        Richiedere output strutturato rigoroso secondo il supporto del modello.

  • context_managementunknownFacoltativo

    Gestione del contesto secondo il modello; non garantisce riepilogo automatico o memoria persistente.

  • stream_optionsobjectFacoltativo

    Parametri streaming Responses con stream=true; hanno effetto solo i campi supportati.

    Campi figli di stream_options (2)
    • include_usagebooleanFacoltativo

      Richiedere utilizzo in streaming; disponibilità secondo il modello.

    • include_obfuscationbooleanFacoltativo

      Controllo offuscamento del flusso Responses; ignorato per impostazione predefinita, attivo solo se supportato.

Risposte ed errori

HTTP 200

Risposta creata

application/json

Tipo
object
Proprietà aggiuntive
false

text/event-stream

Tipo
string
Descrizione
Flusso SSE; eventi, utilizzo e terminazione dipendono dall'interfaccia. Gli errori possono comparire nel flusso.
{
  "type": "string",
  "description": "SSE 事件流,协议事件/用量/结束符取当前接口,错误可能在流内。"
}

HTTP 401

Key assente, non valida, scaduta o revocata.

application/json

Tipo
object
Campi obbligatori
error

HTTP 403

Autorizzazioni IP, account, modello o strumento insufficienti.

application/json

Tipo
object
Campi obbligatori
error

HTTP 429

Limite di frequenza delle richieste/della coda.

application/json

Tipo
object
Campi obbligatori
error

HTTP 500

Errore interno di autenticazione o storage dei dati.

application/json

Tipo
object
Campi obbligatori
error