mirror of https://github.com/openai/codex.git synced 2026-09-28 13:13:48 +08:00

Files

T

History

Won Park d7748e1185 Add opt-in structured errors for Guardian circuit-breaker interruptions (#48796 )

## Why

Guardian denial-limit interruptions lack a structured error identifying the cause. Make this opt-in because older clients may not recognize the new error in shared history.

## What changed

- Add `auto_review.circuit_break_action = "strict"` to attach `TooManyDenials` to the interrupted turn. The default leaves the error unset.
- Expose `turn.error.codexErrorInfo = "tooManyDenials"` in app-server notifications and saved history, and update protocol schemas and generated types.
- Preserve the warning, denial limit, and interrupted status without emitting a separate error notification.

## Testing

Add an integration test covering omitted, `default`, and `strict` settings, checking warnings, live turn errors, the absence of separate error notifications, and persisted turn errors after restart.

GitOrigin-RevId: cb5d379e64728d4d7b9daf834c13756e4a70db31

2026-09-27 22:05:19 +00:00

docs

Retire the personality feature flag and document deprecated settings (#45809 )

2026-09-15 23:39:40 +00:00

examples

Embed friendly instructions in bundled GPT-5.4 and GPT-5.5 (#44930 )

2026-09-11 22:29:54 +00:00

notebooks

Embed friendly instructions in bundled GPT-5.4 and GPT-5.5 (#44930 )

2026-09-11 22:29:54 +00:00

scripts

Add explicit app and account targets to MCP resource reads (#47248 )

2026-09-22 10:42:50 +00:00

src/openai_codex

Add opt-in structured errors for Guardian circuit-breaker interruptions (#48796 )

2026-09-27 22:05:19 +00:00

tests

Add explicit app and account targets to MCP resource reads (#47248 )

2026-09-22 10:42:50 +00:00

_runtime_setup.py

Support alpha hotfix release versions (#34463 )

2026-07-21 03:59:38 +00:00

pyproject.toml

Expose Python SDK history selection and per-turn options (#44084 )

2026-09-09 06:40:56 +00:00

README.md

Add untrusted external messages to the Python SDK (#44086 )

2026-09-09 06:54:18 +00:00

release_version.py

Build Python SDK artifacts before publishing the runtime (#44061 )

2026-09-09 05:14:27 +00:00

RELEASING.md

Publish Python packages after stable CLI releases (#44067 )

2026-09-09 05:39:52 +00:00

uv.lock

Expose Python SDK history selection and per-turn options (#44084 )

2026-09-09 06:40:56 +00:00

README.md

OpenAI Codex Python SDK

Build Python applications that start Codex threads, run turns, stream progress, and control workspace access.

Install

Install the SDK:

pip install openai-codex

Quickstart

The SDK reuses your existing Codex authentication when one is already available:

from openai_codex import Codex

with Codex() as codex:
    thread = codex.thread_start()
    result = thread.run("Explain this repository in three bullets.")
    print(result.final_response)

thread.run(...) returns a TurnResult containing the final response, collected items, and token usage.

Authentication

Existing Codex authentication is reused automatically. To start ChatGPT browser login explicitly:

from openai_codex import Codex

with Codex() as codex:
    login = codex.login_chatgpt()
    print(login.auth_url)
    print(login.wait().success)

For device-code login:

with Codex() as codex:
    login = codex.login_chatgpt_device_code()
    print(login.verification_url, login.user_code)
    login.wait()

For API-key login:

with Codex() as codex:
    codex.login_api_key("sk-...")

Built-In Help

Use Python's standard help(openai_codex), help(Codex), or python -m pydoc openai_codex documentation tools.

Documentation

The package is licensed under the repository Apache License 2.0.