Rivya AI-dokumentation
Modellsidor för API

GPT-5.1 Codex API-integration

Använd GPT-5.1 Codex via Rivyas publika API v1 med modell-ID gpt-5-1-codex-chat, stödda inmatningar, parametrar, Files API-regler, krediter och svarsexempel.

Tillgänglig via APITextinmatning klarChatt
API-modell-ID

gpt-5-1-codex-chat

Inmatningar

text, file

Files API

Krävs inte för minimal begäran

Baskrediter

3

Förmåga

Chatt

Beredskap

Chat API: icke-streaming + SSE-streaming

Fakturering

TOKEN_BASED

Promptgräns

20000 tecken

Kontrakt för begäran

Chattbegäranden skickar ett meddelande åt gången. Sessionshistorik lagras av Rivya; skicka inte en rå messages-array.

NyckelTypObligatorisktStandardBeskrivning
modelstringJagpt-5-1-codex-chatAnvänd API-modell-ID:t gpt-5-1-codex-chat.
session_idstringNej-Valfritt API-skapat chattsessions-ID. Utelämna det för att starta en ny session.
messagestringJa-Nästa användarmeddelande. Chat API-historik kommer från serversidans session, inte från en rå messages-array.
attachmentsarrayNej-Valfria image file_id-värden som returneras av Files API. Externa bilage-URL:er accepteras inte.
enable_web_searchbooleanNejfalseGäller endast när den valda chattmodellen stöder webbsökning.
reasoning_effortstringNejdefaultValfri resoneringsinsats: default, minimal, low, medium, high eller xhigh när det stöds.
client_request_idstringNej-Valfritt klient-ID för att spåra begäranden i ditt system.

Modellparametrar

Den här chattmodellen använder de delade Chat API-fälten ovan. Modellspecifikt stöd för webbsökning, bildbilagor via filer, tankar och resonemang återspeglas i beredskapsdata.

Minimal begäran

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

Begäran med referensfil

{
  "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"
    }
  ]
}

Skapa-svar

Chat-endpointen returnerar ett färdigt assistentmeddelande, tokenanvändning och den slutliga kreditavräkningen för den här omgången.

{
  "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
  }
}

Vanliga fel

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

Chat API stöder icke-streamade och SSE-streamade omgångar i Public API v1. Bildbilagor måste använda file_id-värden från Files API.