Riferimento API
Crea una risposta (OpenAI Responses API)
/v1/responsesInterfaccia 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_KEYSchemi di autenticazione: BearerAuth
Richiesta
Corpo della richiesta · application/json
- Tipo
- object
- Campi obbligatori
modelinput
Corpo della richiesta obbligatorio
modelstringObbligatorioinputunionObbligatorioInput, come stringa o array di messaggi
Ramo oneOf 1
Tipo: string
instructionsstringFacoltativomax_output_tokensintegerFacoltativotemperaturenumberFacoltativoTemperatura di campionamento. Supporto e limiti secondo modello; nessun valore predefinito uniforme garantito.
top_pnumberFacoltativoParametro di campionamento nucleus. Supporto e limiti secondo modello; nessun valore predefinito uniforme garantito.
streambooleanFacoltativotoolsarrayFacoltativoCampi figli di tools (1)
[]objectFacoltativo
tool_choiceunionFacoltativoRamo oneOf 1
Tipo: string
Ramo oneOf 2
Tipo: object
reasoningobjectFacoltativoprevious_response_idstringFacoltativotruncationstringFacoltativo- Enumerazione
["auto","disabled"]
parallel_tool_callsbooleanFacoltativoLe chiamate parallele agli strumenti dipendono dal modello scelto. Chat accetta un booleano; Responses accetta valori JSON del protocollo compatibile.
storebooleanFacoltativoLa 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_keystringFacoltativoIdentificatore della cache dei prompt , secondo modello, senza garanzia di riscontro o supporto. Chat accetta stringhe; Responses valori JSON del protocollo del servizio.
prompt_cache_retentionunknownFacoltativoValore JSON per la conservazione della cache dei prompt , secondo modello. Nessuna enumerazione, valore predefinito o garanzia uniforme della piattaforma.
service_tierstringFacoltativoLivello di servizio richiesto, che può incidere sul costo. Ignorato per impostazione predefinita e applicato solo se supportato. I valori ammessi dipendono dal modello scelto.
textobjectFacoltativoConfigurazione del testo, incluso format per output strutturato; supporto e limiti dipendono dal modello.
Campi figli di text (1)
formatobjectFacoltativoFormato di testo e output strutturato secondo il modello.
Campi figli di format (4)
typestringFacoltativoIdentificatori dei formati di output supportati dal modello.
namestringFacoltativoNome dell'output strutturato.
schemaobjectFacoltativoJSON Schema per output strutturato; deve rispettare i requisiti del modello.
- Proprietà aggiuntive
true
strictbooleanFacoltativoRichiedere output strutturato rigoroso secondo il supporto del modello.
context_managementunknownFacoltativoGestione del contesto secondo il modello; non garantisce riepilogo automatico o memoria persistente.
stream_optionsobjectFacoltativoParametri streaming Responses con stream=true; hanno effetto solo i campi supportati.
Campi figli di stream_options (2)
include_usagebooleanFacoltativoRichiedere utilizzo in streaming; disponibilità secondo il modello.
include_obfuscationbooleanFacoltativoControllo 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
idstringFacoltativoobjectstringFacoltativocreated_atintegerFacoltativostatusstringFacoltativo- Enumerazione
["completed","failed","in_progress","incomplete"]
modelstringFacoltativooutputarrayFacoltativoCampi figli di output (1)
[]objectFacoltativo- Proprietà aggiuntive
false
Campi figli di [] (8)
typestringFacoltativoidstringFacoltativostatusstringFacoltativorolestringFacoltativocontentarrayFacoltativoCampi figli di content (1)
[]objectFacoltativo- Proprietà aggiuntive
false
Campi figli di [] (3)
typestringFacoltativo- Enumerazione
["output_text","refusal"]
textstringFacoltativoannotationsarrayFacoltativoCampi figli di annotations (1)
[]objectFacoltativo
call_idstringFacoltativonamestringFacoltativoargumentsstringFacoltativo
usageobjectFacoltativoCampi figli di usage (5)
prompt_tokensintegerFacoltativoNumero di token del prompt
completion_tokensintegerFacoltativoNumero di token di completamento
total_tokensintegerFacoltativoNumero totale di token
prompt_tokens_detailsobjectFacoltativoCampi figli di prompt_tokens_details (4)
cached_tokensintegerFacoltativotext_tokensintegerFacoltativoaudio_tokensintegerFacoltativoimage_tokensintegerFacoltativo
completion_tokens_detailsobjectFacoltativoCampi figli di completion_tokens_details (3)
text_tokensintegerFacoltativoaudio_tokensintegerFacoltativoreasoning_tokensintegerFacoltativo
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
errorobjectObbligatorioCampi figli di error (4)
codestringFacoltativomessagestringFacoltativotypestringFacoltativorequest_idstringFacoltativo
HTTP 403
Autorizzazioni IP, account, modello o strumento insufficienti.
application/json
- Tipo
- object
- Campi obbligatori
error
errorobjectObbligatorioCampi figli di error (4)
codestringFacoltativomessagestringFacoltativotypestringFacoltativorequest_idstringFacoltativo
HTTP 429
Limite di frequenza delle richieste/della coda.
application/json
- Tipo
- object
- Campi obbligatori
error
errorobjectObbligatorioCampi figli di error (4)
codestringFacoltativomessagestringFacoltativotypestringFacoltativorequest_idstringFacoltativo
HTTP 500
Errore interno di autenticazione o storage dei dati.
application/json
- Tipo
- object
- Campi obbligatori
error
errorobjectObbligatorioCampi figli di error (4)
codestringFacoltativomessagestringFacoltativotypestringFacoltativorequest_idstringFacoltativo