Rivya AI Docs
Modell-API-Seiten

GPT-5.1 Codex API-Integration

Nutze GPT-5.1 Codex über Rivya Public API v1 mit Model-ID gpt-5-1-codex-chat, unterstützten Eingaben, Parametern, Files-API-Regeln, Credits und Response-Beispielen.

Über API verfügbarTexteingabe bereitChat
API-Modell-ID

gpt-5-1-codex-chat

Eingaben

text, file

Files API

Für den Minimalrequest nicht erforderlich

Basis-Credits

3

Fähigkeit

Chat

Bereitschaft

Chat API: nicht-streamend + SSE-streamend

Abrechnung

TOKEN_BASED

Prompt-Limit

20000 Zeichen

Request-Kontrakt

Chat-Requests senden jeweils eine Message. Rivya speichert den Verlauf in der Session; sende kein Raw-Messages-Array.

KeyTypErforderlichStandardBeschreibung
modelstringJagpt-5-1-codex-chatVerwende gpt-5-1-codex-chat als API-Modell-ID.
session_idstringNein-Optionale, von der API erstellte Chat-Session-ID. Weglassen, um eine neue Session zu starten.
messagestringJa-Die nächste Nutzernachricht. Der Chat-API-Verlauf kommt aus der serverseitigen Session, nicht aus einem Raw-Messages-Array.
attachmentsarrayNein-Optionale Bild-file_id-Werte aus der Files API. Externe Attachment-URLs werden nicht akzeptiert.
enable_web_searchbooleanNeinfalseGilt nur, wenn das ausgewählte Chat-Modell Websuche unterstützt.
reasoning_effortstringNeindefaultOptionaler Reasoning Effort: default, minimal, low, medium, high oder xhigh, sofern unterstützt.
client_request_idstringNein-Optionale Client-ID, um Requests in deinem System nachzuverfolgen.

Modellparameter

Dieses Chat-Modell nutzt die gemeinsamen Chat-API-Felder oben. Modellspezifische Unterstützung für Websuche, Bilddatei-Anhänge, Gedanken und Reasoning steht in den Readiness-Daten.

Minimalrequest

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

Request mit Referenzdatei

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

Create-Response

Der Chat-Endpunkt gibt die abgeschlossene Assistant-Message, Token-Nutzung und die finale Credit-Abrechnung für diesen Turn zurück.

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

Häufige Fehler

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

Chat API unterstützt nicht-streamende und SSE-streamende Turns in Public API v1. Bildanhänge müssen file_id-Werte aus der Files API verwenden.