clone/codex
1
0
Fork 0
mirror of https://github.com/openai/codex.git synced 2026-05-15 16:53:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename Python SDK package to openai-codex

Browse Source 
Co-authored-by: Codex <noreply@openai.com>
This commit is contained in:
Ahmed Ibrahim
2026-05-09 11:38:22 +03:00
parent 9306e60848
commit 78c0d5ca3d
63 changed files with 152 additions and 152 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
sdk/python/docs/api-reference.md
View File

@@ -1,13 +1,13 @@
# Codex App Server SDK — API Reference
# OpenAI Codex SDK — API Reference
Public surface of `codex_app_server` for app-server v2.
Public surface of `openai_codex` for app-server v2.
This SDK surface is experimental. Turn streams are routed by turn ID so one client can consume multiple active turns concurrently.
## Package Entry
```python
from codex_app_server import (
from openai_codex import (
Codex,
AsyncCodex,
RunResult,
@@ -23,7 +23,7 @@ from codex_app_server import (
SkillInput,
MentionInput,
)
from codex_app_server.types import (
from openai_codex.types import (
InitializeResponse,
ThreadItem,
ThreadTokenUsage,
@@ -31,9 +31,9 @@ from codex_app_server.types import (
)
```
- Version: `codex_app_server.__version__`
- Version: `openai_codex.__version__`
- Requires Python >= 3.10
- Public app-server value and event types live in `codex_app_server.types`
- Public app-server value and event types live in `openai_codex.types`
## Codex (sync)
@@ -136,7 +136,7 @@ Use `turn(...)` when you need low-level turn control (`stream()`, `steer()`,
- `steer(input: Input) -> TurnSteerResponse`
- `interrupt() -> TurnInterruptResponse`
- `stream() -> Iterator[Notification]`
- `run() -> codex_app_server.types.Turn`
- `run() -> openai_codex.types.Turn`
Behavior notes:
@@ -148,7 +148,7 @@ Behavior notes:
- `steer(input: Input) -> Awaitable[TurnSteerResponse]`
- `interrupt() -> Awaitable[TurnInterruptResponse]`
- `stream() -> AsyncIterator[Notification]`
- `run() -> Awaitable[codex_app_server.types.Turn]`
- `run() -> Awaitable[openai_codex.types.Turn]`
Behavior notes:
@@ -173,7 +173,7 @@ Input = list[InputItem] | InputItem
The SDK wrappers return and accept public app-server models wherever possible:
```python
from codex_app_server.types import (
from openai_codex.types import (
AskForApproval,
ThreadReadResponse,
Turn,
@@ -184,7 +184,7 @@ from codex_app_server.types import (
## Retry + errors
```python
from codex_app_server import (
from openai_codex import (
retry_on_overload,
JsonRpcError,
MethodNotFoundError,
@@ -200,7 +200,7 @@ from codex_app_server import (
## Example
```python
from codex_app_server import Codex
from openai_codex import Codex
with Codex() as codex:
thread = codex.thread_start(model="gpt-5.4", config={"model_reasoning_effort": "high"})