Referência da API
Criar resposta (OpenAI Responses API)
/v1/responsesInterface Responses para texto e chamadas de ferramentas; campos opcionais e tipos de ferramentas dependem do modelo. stream=true retorna eventos SSE tipados; previous_response_id não garante armazenamento persistente nem recuperação.
Autenticação e permissões
Use sua chave atual do GloopAPI. Modelos, recursos e permissões disponíveis dependem do catálogo da chave e da documentação do endpoint.
Authorization: Bearer $GLOOP_API_KEYEsquemas de autenticação: BearerAuth
Solicitação
Corpo da solicitação · application/json
- Tipo
- object
- Campos obrigatórios
modelinput
Corpo da solicitação obrigatório
modelstringObrigatórioinputunionObrigatórioEntrada como string ou array de mensagens
Ramificação oneOf 1
Tipo: string
instructionsstringOpcionalmax_output_tokensintegerOpcionaltemperaturenumberOpcionalTemperatura de amostragem. Suporte e limites conforme modelo; sem padrões uniformes garantidos.
top_pnumberOpcionalParâmetro de amostragem por núcleo. Suporte e limites conforme modelo; sem padrões uniformes garantidos.
streambooleanOpcionaltoolsarrayOpcionalCampos filhos de tools (1)
[]objectOpcional
tool_choiceunionOpcionalRamificação oneOf 1
Tipo: string
Ramificação oneOf 2
Tipo: object
reasoningobjectOpcionalprevious_response_idstringOpcionaltruncationstringOpcional- Enumeração
["auto","disabled"]
parallel_tool_callsbooleanOpcionalChamadas paralelas de ferramentas dependem do modelo escolhido. Chat aceita um booleano; Responses aceita valores JSON do protocolo compatível.
storebooleanOpcionalA permissão para armazenar solicitações e respostas depende do modelo escolhido e dos recursos do serviço. Isso não oferece uma API geral de armazenamento de conversas.
prompt_cache_keystringOpcionalIdentificador de correlação de cache de prompt do serviço; depende do modelo, sem garantia de acerto ou suporte. Chat aceita strings; Responses, valores JSON do protocolo do serviço.
prompt_cache_retentionunknownOpcionalValor JSON de controle de retenção de cache de prompt do serviço; depende do modelo. Não há enumeração, padrão ou garantia de retenção uniforme da plataforma.
service_tierstringOpcionalNível de serviço solicitado, que pode afetar o custo. Ignorado por padrão e aplicado apenas quando compatível. Os valores aceitos dependem do modelo escolhido.
textobjectOpcionalConfiguração de texto, incluindo format para saída estruturada; suporte e limites dependem do modelo.
Campos filhos de text (1)
formatobjectOpcionalFormato de texto e saída estruturada conforme o modelo.
Campos filhos de format (4)
typestringOpcionalIdentificadores de formatos de saída do modelo escolhido.
namestringOpcionalNome da saída estruturada.
schemaobjectOpcionalJSON Schema para saída estruturada; deve atender aos requisitos do modelo.
- Propriedades adicionais
true
strictbooleanOpcionalExigir saída estruturada estrita conforme o suporte do modelo.
context_managementunknownOpcionalGestão de contexto conforme o modelo; sem garantia de resumo automático ou memória persistente.
stream_optionsobjectOpcionalParâmetros de streaming Responses com stream=true; apenas campos suportados têm efeito.
Campos filhos de stream_options (2)
include_usagebooleanOpcionalSolicitar uso em streaming; disponibilidade conforme o modelo.
include_obfuscationbooleanOpcionalControle de ofuscação do fluxo Responses; ignorado por padrão, efetivo apenas quando suportado.
Respostas e erros
HTTP 200
Resposta criada com sucesso
application/json
- Tipo
- object
- Propriedades adicionais
- false
idstringOpcionalobjectstringOpcionalcreated_atintegerOpcionalstatusstringOpcional- Enumeração
["completed","failed","in_progress","incomplete"]
modelstringOpcionaloutputarrayOpcionalCampos filhos de output (1)
[]objectOpcional- Propriedades adicionais
false
Campos filhos de [] (8)
typestringOpcionalidstringOpcionalstatusstringOpcionalrolestringOpcionalcontentarrayOpcionalCampos filhos de content (1)
[]objectOpcional- Propriedades adicionais
false
Campos filhos de [] (3)
typestringOpcional- Enumeração
["output_text","refusal"]
textstringOpcionalannotationsarrayOpcionalCampos filhos de annotations (1)
[]objectOpcional
call_idstringOpcionalnamestringOpcionalargumentsstringOpcional
usageobjectOpcionalCampos filhos de usage (5)
prompt_tokensintegerOpcionalTokens do prompt
completion_tokensintegerOpcionalTokens de conclusão
total_tokensintegerOpcionalTotal de tokens
prompt_tokens_detailsobjectOpcionalCampos filhos de prompt_tokens_details (4)
cached_tokensintegerOpcionaltext_tokensintegerOpcionalaudio_tokensintegerOpcionalimage_tokensintegerOpcional
completion_tokens_detailsobjectOpcionalCampos filhos de completion_tokens_details (3)
text_tokensintegerOpcionalaudio_tokensintegerOpcionalreasoning_tokensintegerOpcional
text/event-stream
- Tipo
- string
- Descrição
- Fluxo de eventos SSE; eventos, uso e marcadores finais dependem do endpoint. Podem ocorrer erros dentro do fluxo.
{
"type": "string",
"description": "SSE 事件流,协议事件/用量/结束符取当前接口,错误可能在流内。"
}HTTP 401
A chave está ausente, inválida, expirada ou revogada.
application/json
- Tipo
- object
- Campos obrigatórios
error
errorobjectObrigatórioCampos filhos de error (4)
codestringOpcionalmessagestringOpcionaltypestringOpcionalrequest_idstringOpcional
HTTP 403
Permissões insuficientes de IP, conta, modelo ou ferramenta.
application/json
- Tipo
- object
- Campos obrigatórios
error
errorobjectObrigatórioCampos filhos de error (4)
codestringOpcionalmessagestringOpcionaltypestringOpcionalrequest_idstringOpcional
HTTP 429
Limite de solicitações/fila.
application/json
- Tipo
- object
- Campos obrigatórios
error
errorobjectObrigatórioCampos filhos de error (4)
codestringOpcionalmessagestringOpcionaltypestringOpcionalrequest_idstringOpcional
HTTP 500
Falha interna de autenticação ou armazenamento de dados.
application/json
- Tipo
- object
- Campos obrigatórios
error
errorobjectObrigatórioCampos filhos de error (4)
codestringOpcionalmessagestringOpcionaltypestringOpcionalrequest_idstringOpcional