Referência da API

Criar resposta (OpenAI Responses API)

POST/v1/responses

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

Esquemas 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ório
  • inputunionObrigatório

    Entrada como string ou array de mensagens

    Ramificação oneOf 1

    Tipo: string

    Ramificação oneOf 2

    Tipo: array

    • []objectOpcional
  • instructionsstringOpcional
  • max_output_tokensintegerOpcional
  • temperaturenumberOpcional

    Temperatura de amostragem. Suporte e limites conforme modelo; sem padrões uniformes garantidos.

  • top_pnumberOpcional

    Parâmetro de amostragem por núcleo. Suporte e limites conforme modelo; sem padrões uniformes garantidos.

  • streambooleanOpcional
  • toolsarrayOpcional
    Campos filhos de tools (1)
    • []objectOpcional
  • tool_choiceunionOpcional
    Ramificação oneOf 1

    Tipo: string

    Ramificação oneOf 2

    Tipo: object

  • reasoningobjectOpcional
    Campos filhos de reasoning (2)
    • effortstringOpcional
      Enumeração
      ["low","medium","high"]
    • summarystringOpcional
  • previous_response_idstringOpcional
  • truncationstringOpcional
    Enumeração
    ["auto","disabled"]
  • parallel_tool_callsbooleanOpcional

    Chamadas paralelas de ferramentas dependem do modelo escolhido. Chat aceita um booleano; Responses aceita valores JSON do protocolo compatível.

  • storebooleanOpcional

    A 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_keystringOpcional

    Identificador 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_retentionunknownOpcional

    Valor 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_tierstringOpcional

    Ní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.

  • textobjectOpcional

    Configuração de texto, incluindo format para saída estruturada; suporte e limites dependem do modelo.

    Campos filhos de text (1)
    • formatobjectOpcional

      Formato de texto e saída estruturada conforme o modelo.

      Campos filhos de format (4)
      • typestringOpcional

        Identificadores de formatos de saída do modelo escolhido.

      • namestringOpcional

        Nome da saída estruturada.

      • schemaobjectOpcional

        JSON Schema para saída estruturada; deve atender aos requisitos do modelo.

        Propriedades adicionais
        true
      • strictbooleanOpcional

        Exigir saída estruturada estrita conforme o suporte do modelo.

  • context_managementunknownOpcional

    Gestão de contexto conforme o modelo; sem garantia de resumo automático ou memória persistente.

  • stream_optionsobjectOpcional

    Parâmetros de streaming Responses com stream=true; apenas campos suportados têm efeito.

    Campos filhos de stream_options (2)
    • include_usagebooleanOpcional

      Solicitar uso em streaming; disponibilidade conforme o modelo.

    • include_obfuscationbooleanOpcional

      Controle 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

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

HTTP 403

Permissões insuficientes de IP, conta, modelo ou ferramenta.

application/json

Tipo
object
Campos obrigatórios
error

HTTP 429

Limite de solicitações/fila.

application/json

Tipo
object
Campos obrigatórios
error

HTTP 500

Falha interna de autenticação ou armazenamento de dados.

application/json

Tipo
object
Campos obrigatórios
error
Pronto para criar? Abra console para criar uma chave de API, ou explore recursos.