Use GPT-5.1 Codex pela Rivya Public API v1 com o ID de modelo gpt-5-1-codex-chat, entradas compatíveis, parâmetros, regras da Files API, créditos e exemplos de resposta.

Disponível via APIInput de texto prontoChat

ID do modelo da API

gpt-5-1-codex-chat

Entradas

text, file

Files API

Não obrigatório para a requisição mínima

Créditos base

Capacidade

Chat

Prontidão

API de chat: sem streaming + streaming SSE

Cobrança

TOKEN_BASED

Limite de prompt

20000 caracteres

Contrato da requisição

Requisições de Chat enviam uma mensagem por vez. O histórico da sessão é armazenado pela Rivya; não envie um array raw messages.

Chave	Tipo	Obrigatório	Padrão	Descrição
model	string	Sim	gpt-5-1-codex-chat	Use gpt-5-1-codex-chat como ID do modelo da API.
session_id	string	Não	-	ID de sessão de chat criado pela API, opcional. Omita para iniciar uma nova sessão.
message	string	Sim	-	A próxima mensagem do usuário. O histórico da Chat API vem da sessão no servidor, não de um array raw messages.
attachments	array	Não	-	Valores file_id de imagem opcionais retornados pela Files API. URLs externas de anexo não são aceitas.
enable_web_search	boolean	Não	false	Só se aplica quando o modelo de Chat selecionado oferece suporte a busca na web.
reasoning_effort	string	Não	default	Reasoning effort opcional: default, minimal, low, medium, high ou xhigh quando houver suporte.
client_request_id	string	Não	-	ID opcional do cliente para rastrear requisições no seu sistema.

Parâmetros do modelo

Este modelo de Chat usa os campos compartilhados da Chat API acima. O suporte específico do modelo para busca na web, anexos de arquivo de imagem, pensamentos e raciocínio aparece nos dados de prontidão.

Requisição mínima

{
  "model": "gpt-5-1-codex-chat",
  "message": "Write a concise launch plan for a new product image campaign"
}

Requisição com arquivo de referência

{
  "model": "gpt-5-1-codex-chat",
  "message": "Write a concise launch plan for a new product image campaign",
  "attachments": [
    {
      "file_id": "file_uploaded_image_id"
    }
  ]
}

Resposta de criação

O endpoint de Chat retorna a mensagem concluída do assistente, o uso de tokens e o acerto final de créditos deste turno.

{
  "id": "chatcmpl_msg_gpt_5_1_codex_chat_example",
  "object": "chat.completion",
  "session_id": "chat_session_gpt_5_1_codex_chat",
  "model": "gpt-5-1-codex-chat",
  "created_at": "2026-05-11T00:00:00.000Z",
  "message": {
    "id": "assistant_message_id",
    "role": "assistant",
    "content": "A concise launch plan with clear next steps."
  },
  "usage": {
    "input_tokens": 1200,
    "output_tokens": 320,
    "total_tokens": 1520
  },
  "credits": {
    "reserved": 3,
    "final": 3
  }
}

Erros comuns

validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found, chat_model_not_supported, chat_session_conflict, chat_attachment_not_supported

A Chat API oferece suporte a turnos non-streaming e SSE streaming na Public API v1. Anexos de imagem devem usar valores file_id da Files API.

Integração da API de GPT-5.1 Codex