mirror of
https://github.com/openai/codex.git
synced 2026-10-21 04:45:00 +00:00
Prepare Python SDK 0.144.4 stable release (#33213)
## What changed - Mark `openai-codex` as stable and align its versioned runtime dependency with Codex CLI `0.144.4`. - Regenerate the Python protocol models and notification registry from that runtime, exposing the latest requests, responses, notifications, and schema fields. - Keep `ReasoningEffort` and `ThreadSource` as enum-style APIs while accepting unknown future wire values, and omit `last_turn_id` from the flat `thread_fork` helper. ## Testing - Cover stable SDK/runtime version matching, forward-compatible enum parsing, and generated client method signatures. GitOrigin-RevId: eaa616bcbfca4258f11274e12e7eefaa551110b7
This commit is contained in:
@@ -1,8 +1,8 @@
|
||||
# OpenAI Codex Python SDK (Beta) - API Reference
|
||||
# OpenAI Codex Python SDK - API Reference
|
||||
|
||||
Public surface of `openai_codex` for Codex workflows.
|
||||
|
||||
This SDK is in beta. Public APIs may change before `1.0`. Turn streams are routed by turn ID so one client can consume multiple active turns concurrently.
|
||||
Turn streams are routed by turn ID so one client can consume multiple active turns concurrently.
|
||||
Thread starts default to `ApprovalMode.auto_review`; turn starts accept an optional `approval_mode` override.
|
||||
|
||||
## Package Entry
|
||||
|
||||
@@ -2,15 +2,13 @@
|
||||
|
||||
## Is the Python SDK stable?
|
||||
|
||||
`openai-codex` is a public beta. Install it with
|
||||
`pip install openai-codex`; public APIs may change before `1.0`. While beta
|
||||
releases are the only published SDK releases, pip selects the latest beta.
|
||||
After a stable release exists, pass `--pre` to opt into newer prereleases.
|
||||
`openai-codex` publishes stable releases. Install the latest one with
|
||||
`pip install openai-codex`.
|
||||
|
||||
## Why does the SDK install a runtime package?
|
||||
|
||||
The SDK and runtime packages are versioned independently. Each SDK release
|
||||
pins and installs one compatible runtime dependency automatically.
|
||||
The SDK version tracks the corresponding Codex CLI release. Each SDK release
|
||||
pins and installs its matching runtime dependency automatically.
|
||||
|
||||
## Thread vs turn
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Getting Started
|
||||
|
||||
This guide gets a published OpenAI Codex Python SDK beta installation running
|
||||
This guide gets a published OpenAI Codex Python SDK installation running
|
||||
with a multi-turn thread.
|
||||
|
||||
## 1. Install
|
||||
@@ -16,10 +16,8 @@ Requirements:
|
||||
- Python `>=3.10`
|
||||
- An existing Codex account session, or one of the login flows below
|
||||
|
||||
The SDK installs its compatible `openai-codex-cli-bin` runtime dependency
|
||||
automatically. While beta releases are the only published SDK releases, this
|
||||
normal install command selects the latest beta. After a stable release exists,
|
||||
use `pip install --pre openai-codex` to opt into a newer prerelease.
|
||||
The SDK installs its matching `openai-codex-cli-bin` runtime dependency
|
||||
automatically. SDK release versions track the corresponding Codex CLI release.
|
||||
|
||||
## 2. Authenticate When Needed
|
||||
|
||||
|
||||
Reference in New Issue
Block a user