Referência da API
Criar conversa de chat
/v1/chat/completionsEndpoint compatível de texto/ferramentas OpenAI Chat Completions. image_url só está disponível em modelos com entrada de imagens. Saída de texto/ferramentas; recursos, campos opcionais e preços dependem do modelo. stream=true retorna SSE, pode incluir uso final e termina com data: [DONE].
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
modelmessages
Corpo da solicitação obrigatório
modelstringObrigatórioID do modelo
messagesarrayObrigatórioLista de mensagens da conversa
Campos filhos de messages (1)
[]objectOpcionalCampos filhos de [] (6)
rolestringObrigatórioPapel da mensagem
- Enumeração
["system","user","assistant","tool","developer"]
contentunionObrigatórioConteúdo da mensagem
Ramificação oneOf 1
Tipo: string
Ramificação oneOf 2
Tipo: array
[]objectOpcionalCampos filhos de [] (6)
typestringOpcional- Enumeração
["text","image_url","input_audio","file","video_url"]
textstringOpcionalimage_urlunionOpcionalAceita URL/Base64 como string ou objeto {url, detail} em wire; apenas modelos com imagens. Não garante visão em todos os modelos.
Ramificação oneOf 1
URL da imagem ou URL de dados Base64.
Tipo: string
Ramificação oneOf 2
O objeto deve incluir pelo menos url; Message.ParseContent normaliza detail omitido para high. O suporte depende do modelo visual escolhido.
Tipo: object
Obrigatório nesta ramificação: url
input_audioobjectOpcionalfileobjectOpcionalvideo_urlstringOpcionalA entrada wire real lida por Message.ParseContent é uma string URL de vídeo, apenas para modelos com entrada de vídeo. Um objeto {url: ...} não entra nos resultados de conteúdo/medição desse parser e não é publicado como contrato utilizável.
namestringOpcionalNome do remetente
tool_callsarrayOpcionaltool_call_idstringOpcionalID da chamada de ferramenta (mensagens com papel tool)
reasoning_contentstringOpcionalConteúdo de raciocínio
temperaturenumberOpcionalTemperatura 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.
nintegerOpcionalQuantidade a gerar. Suporte e limites conforme modelo; sem padrões uniformes garantidos.
streambooleanOpcionalSe a resposta é em streaming
- Valor padrão
false
stream_optionsobjectOpcionalOpções de uso no fluxo Chat; o suporte e o retorno de dados de uso dependem do modelo escolhido.
Campos filhos de stream_options (1)
include_usagebooleanOpcional
stopunionOpcionalSequências de parada
Ramificação oneOf 1
Tipo: string
max_tokensintegerOpcionalMáximo de tokens gerados. Suporte e limites conforme modelo; sem padrões uniformes garantidos.
max_completion_tokensintegerOpcionalMáximo de tokens de conclusão. Suporte e limites conforme modelo; sem padrões uniformes garantidos.
presence_penaltynumberOpcionalO suporte e os limites dependem do modelo escolhido; não há garantia de valores padrão uniformes.
frequency_penaltynumberOpcionalO suporte e os limites dependem do modelo escolhido; não há garantia de valores padrão uniformes.
logit_biasobjectOpcionalCampos filhos de logit_bias (1)
[key]numberOpcional
userstringOpcionaltoolsarrayOpcionalCampos filhos de tools (1)
[]objectOpcionalCampos filhos de [] (2)
typestringOpcionalfunctionobjectOpcionalCampos filhos de function (3)
namestringOpcionaldescriptionstringOpcionalparametersobjectOpcionalDefinição de parâmetros em formato JSON Schema
tool_choiceunionOpcionalRamificação oneOf 1
Tipo: string
Enumeração:
["none","auto","required"]response_formatobjectOpcionalCampos filhos de response_format (2)
typestringOpcional- Enumeração
["text","json_object","json_schema"]
json_schemaobjectOpcionalDefinição JSON Schema
seedintegerOpcionalO suporte e os limites dependem do modelo escolhido; não há garantia de valores padrão uniformes.
reasoning_effortstringOpcionalIntensidade de raciocínio (modelos compatíveis). Suporte e limites conforme modelo, sem padrões uniformes garantidos.
modalitiesarrayOpcionalCampos filhos de modalities (1)
[]stringOpcional- Enumeração
["text","audio"]
audioobjectOpcionalparallel_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_tierunknownOpcionalNí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.
Respostas e erros
HTTP 200
Resposta criada com sucesso
application/json
- Tipo
- object
- Propriedades adicionais
- false
idstringOpcionalobjectstringOpcionalcreatedintegerOpcionalmodelstringOpcionalchoicesarrayOpcionalCampos filhos de choices (1)
[]objectOpcional- Propriedades adicionais
false
Campos filhos de [] (3)
indexintegerOpcionalmessageobjectOpcional- Propriedades adicionais
false
Campos filhos de message (5)
rolestringObrigatório- Enumeração
["assistant"]
Conteúdo textual da resposta.
tool_callsarrayOpcional
finish_reasonstringOpcional- Enumeração
["stop","length","tool_calls","content_filter"]
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
system_fingerprintstringOpcional
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 400
Parâmetros de solicitação incorretos
application/json
- Tipo
- object
errorobjectOpcional
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 frequência de solicitações
application/json
- Tipo
- object
errorobjectOpcional
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