Dokumentacja Rivya AI
Strony API modeli

Integracja API GPT-5.1 Codex

Używaj GPT-5.1 Codex przez Rivya Public API v1 z identyfikatorem modelu gpt-5-1-codex-chat, obsługiwanymi wejściami, parametrami, regułami Files API, kredytami i przykładami odpowiedzi.

Dostępne przez APIWejście tekstowe gotoweCzat
Identyfikator modelu API

gpt-5-1-codex-chat

Wejścia

text, file

Files API

Niewymagane dla żądania minimalnego

Kredyty bazowe

3

Możliwość

Czat

Gotowość

Chat API: bez strumieniowania + strumieniowanie SSE

Rozliczenia

TOKEN_BASED

Limit promptu

20000 znaków

Kontrakt żądania

Żądania chatu wysyłają jedną wiadomość naraz. Historia sesji jest przechowywana przez Rivya; nie wysyłaj surowej tablicy messages.

KluczTypWymaganeDomyślnieOpis
modelstringTakgpt-5-1-codex-chatUżyj gpt-5-1-codex-chat jako identyfikatora modelu API.
session_idstringNie-Opcjonalny identyfikator sesji chatu utworzonej przez API. Pomiń go, aby rozpocząć nową sesję.
messagestringTak-Następna wiadomość użytkownika. Historia Chat API pochodzi z sesji po stronie serwera, a nie z surowej tablicy messages.
attachmentsarrayNie-Opcjonalne wartości file_id obrazów zwrócone przez Files API. Zewnętrzne adresy URL załączników nie są akceptowane.
enable_web_searchbooleanNiefalseDotyczy tylko sytuacji, gdy wybrany model chatu obsługuje wyszukiwanie w sieci.
reasoning_effortstringNiedefaultOpcjonalny poziom rozumowania: default, minimal, low, medium, high albo xhigh, gdy jest obsługiwany.
client_request_idstringNie-Opcjonalny identyfikator po stronie klienta do śledzenia żądań w Twoim systemie.

Parametry modelu

Ten model chatu używa wspólnych pól Chat API powyżej. Specyficzna dla modelu obsługa wyszukiwania w sieci, załączników plików obrazów, myśli i rozumowania jest odzwierciedlona w danych gotowości.

Żądanie minimalne

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

Żądanie z plikiem referencyjnym

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

Odpowiedź tworzenia

Endpoint Chat zwraca ukończoną wiadomość asystenta, użycie tokenów i końcowe rozliczenie kredytów dla tej tury.

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

Typowe błędy

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

Chat API obsługuje tury bez strumieniowania i ze strumieniowaniem SSE w Public API v1. Załączniki obrazów muszą używać wartości file_id z Files API.