Integracja API GPT-5 Codex
Używaj GPT-5 Codex przez Rivya Public API v1 z identyfikatorem modelu gpt-5-codex-chat, obsługiwanymi wejściami, parametrami, regułami Files API, kredytami i przykładami odpowiedzi.
gpt-5-codex-chat
text, file
Niewymagane dla żądania minimalnego
3
Czat
Chat API: bez strumieniowania + strumieniowanie SSE
TOKEN_BASED
20000 znaków
Kontrakt żądania
Żądania chatu wysyłają jedną wiadomość naraz. Historia sesji jest przechowywana przez Rivya; nie wysyłaj surowej tablicy messages.
| Klucz | Typ | Wymagane | Domyślnie | Opis |
|---|---|---|---|---|
| model | string | Tak | gpt-5-codex-chat | Użyj gpt-5-codex-chat jako identyfikatora modelu API. |
| session_id | string | Nie | - | Opcjonalny identyfikator sesji chatu utworzonej przez API. Pomiń go, aby rozpocząć nową sesję. |
| message | string | Tak | - | Następna wiadomość użytkownika. Historia Chat API pochodzi z sesji po stronie serwera, a nie z surowej tablicy messages. |
| attachments | array | Nie | - | Opcjonalne wartości file_id obrazów zwrócone przez Files API. Zewnętrzne adresy URL załączników nie są akceptowane. |
| enable_web_search | boolean | Nie | false | Dotyczy tylko sytuacji, gdy wybrany model chatu obsługuje wyszukiwanie w sieci. |
| reasoning_effort | string | Nie | default | Opcjonalny poziom rozumowania: default, minimal, low, medium, high albo xhigh, gdy jest obsługiwany. |
| client_request_id | string | Nie | - | 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-codex-chat",
"message": "Write a concise launch plan for a new product image campaign"
}Żądanie z plikiem referencyjnym
{
"model": "gpt-5-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_codex_chat_example",
"object": "chat.completion",
"session_id": "chat_session_gpt_5_codex_chat",
"model": "gpt-5-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.