Respostas multimodais OpenAI

API Responses compatível com OpenAI. Este endpoint usa input no estilo OpenAI e suporta texto, URLs públicas de imagens, entrada de PDF, chamadas de ferramentas, opções de raciocínio e parâmetros de streaming.

POST https://api.apihop.ai/openai/responses

Autenticação

Todas as requisições exigem autenticação com token Bearer.

Authorization: Bearer YOUR_API_KEY

Corpo da requisição

Diferenças de parâmetros entre modelos

• O encaminhamento Responses nativo compatível com OpenAI preserva top_p na requisição ao provedor; validação e comportamento de amostragem dependem do modelo e provedor escolhidos. As verificações de 2026-09-26 aceitaram top_p: 0.9 para gpt-5.5, gpt-5.6-sol e gpt-5.6-terra. Aceitação e encaminhamento não comprovam efeito na amostragem nem garantem suporte a outros valores, modelos ou requisições futuras. Comece com uma requisição mínima.
• O suporte desta página se aplica somente ao endpoint regular /openai/responses. Não implica que o mesmo modelo suporte /openai/responses/compact, WebSocket ou previous_response_id com estado.
• Os cinco modelos GPT listados acima não têm atualmente um canal Compact verificado. Requisições Compact são rejeitadas antes da cobrança quando não há um canal explicitamente ativado. Responses normal e Responses WebSocket continuam disponíveis.

Exemplos de requisição

Os exemplos abaixo fornecem input. Uma continuação pode omitir input se fornecer um previous_response_id válido e o canal escolhido suportar continuação com estado. Um ID de resposta não habilita essa capacidade em um canal sem suporte. Resultados de ferramentas continuam sendo itens de entrada válidos, incluindo function_call_output.

Texto

{
  "model": "gpt-5.4",
  "input": "Hello, introduce yourself in one sentence."
}

Parâmetros no estilo Codex CLI

{
  "model": "gpt-5.5",
  "input": "Reply with READY only.",
  "reasoning": {
    "effort": "xhigh"
  },
  "store": false,
  "text": {
    "verbosity": "low"
  },
  "stream": true
}

Compreensão de imagens

{
  "model": "gpt-5.4",
  "input": [
    {
      "type": "message",
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "What is in this image?"
        },
        {
          "type": "input_image",
          "image_url": "https://example.com/cat.png",
          "detail": "high"
        }
      ]
    }
  ]
}

Entrada de arquivo

Use file_data junto com filename para enviar conteúdo PDF. file_data deve ser uma URL de dados completa.

{
  "model": "gpt-5.4",
  "input": [
    {
      "type": "message",
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Summarize the key points in this PDF."
        },
        {
          "type": "input_file",
          "file_data": "data:application/pdf;base64,JVBERi0xLjQKJc...",
          "filename": "report.pdf"
        }
      ]
    }
  ]
}

Entrada de imagem e arquivo

{
  "model": "gpt-5.4",
  "input": [
    {
      "type": "message",
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Give three conclusions based on the image and attachment."
        },
        {
          "type": "input_image",
          "image_url": "https://example.com/chart.png",
          "detail": "high"
        },
        {
          "type": "input_file",
          "file_data": "data:application/pdf;base64,JVBERi0xLjQKJc...",
          "filename": "notes.pdf"
        }
      ]
    }
  ]
}

Saída em streaming

{
  "model": "gpt-5.4",
  "stream": true,
  "input": [
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Explain this diagram step by step."
        },
        {
          "type": "input_image",
          "image_url": "https://example.com/diagram.png"
        }
      ]
    }
  ]
}

Resposta

Respostas sem streaming seguem o estilo OpenAI Responses. Os campos reais podem variar conforme as capacidades do modelo escolhido.

Exemplo de sucesso

{
  "id": "resp_123",
  "object": "response",
  "created_at": 1766534400,
  "model": "gpt-5.4",
  "output": [
    {
      "type": "message",
      "role": "assistant",
      "content": [
        {
          "text": "The image shows a cat, and the attachment is a document about pet care."
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 128,
    "output_tokens": 42,
    "total_tokens": 170
  }
}

Resposta em streaming

Quando stream=true, o endpoint retorna Server-Sent Events.

event: response.output_text.delta
data: {"type":"response.output_text.delta","delta":"The image"}

event: response.completed
data: {"type":"response.completed","response":{"id":"resp_123"}}

Leia os eventos até response.completed ou até a conexão fechar.

Resposta de erro

Consulte Códigos de erro e solução de problemas para a referência completa, diferenças de protocolo e etapas de diagnóstico.

Erros HTTP gerados pela plataforma usam os campos planos abaixo em vez de um envelope error. Alguns erros do provedor podem manter a estrutura original; erros dentro de um stream SSE já iniciado não seguem este exemplo de resposta HTTP.

{
  "code": 40000,
  "message": "Insufficient credit. Required: 30000, Available: 20000",
  "type": "api_error"
}

Observações

• O endpoint Responses usa input, não messages. Se o cliente envia apenas messages, use /openai/v1/chat/completions.
• Entrada de imagem usa input_image; image_url deve ser uma URL pública http:// ou https://. URLs de dados Base64 não são suportadas para imagens.
• Entrada de arquivo usa input_file. Para PDFs, use file_data e filename; file_data deve ser uma URL data:application/pdf;base64,... completa.
• Entrada/saída de áudio, ferramentas de geração de imagens, busca de arquivos e outras capacidades avançadas dependem do modelo escolhido e dos recursos disponíveis.
• Os campos desta página formam o contrato público atual de requisições Responses; não presuma que campos não listados estejam disponíveis.
• /openai/responses é o caminho público recomendado.
• /v1/responses segue o mesmo contrato público de requisição e resposta.
• /compat/v1/responses segue o mesmo contrato público de requisição e resposta.
• /openai/v1/responses segue o mesmo contrato público de requisição e resposta.