mirror of https://github.com/openai/codex.git synced 2026-09-15 12:08:01 +00:00

Files

Eric Traut 91d54f1667 Restore collaboration mode when resuming threads (#45519 )

## Why

Resuming a thread initialized its collaboration mode to Default, losing the saved Plan mode and its developer instructions. Reconnecting clients also lacked a server-reported mode to reconcile changes made by another client.

## What changed

- Restore the saved collaboration mode from the latest matching `ThreadSettingsApplied` event, falling back to the last legacy `TurnContext`. Apply the effective model and reasoning effort while retaining the saved mode and developer instructions.
- Include `collaborationMode` in `thread/resume` responses and update the generated schemas and bindings.
- Use the restored mode in the TUI, including the first prompt after resume. Prefer the server's mode when restoring disconnected input, while preserving the local selection for older servers that omit it.

## Testing

Add regression coverage for persisted and legacy collaboration modes, model and reasoning-effort overrides, the resumed Plan mode display and first prompt, and reconnect behavior with and without a server-reported mode.

GitOrigin-RevId: ed064516e7fae1c1668152ab448f510cbcacfe06

2026-09-14 21:33:45 +00:00

docs

Start Python SDK turn subscriptions at their attachment point (#44400 )

2026-09-10 03:40:55 +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

Start Python SDK turn subscriptions at their attachment point (#44400 )

2026-09-10 03:40:55 +00:00

src/openai_codex

Restore collaboration mode when resuming threads (#45519 )

2026-09-14 21:33:45 +00:00

tests

Start Python SDK turn subscriptions at their attachment point (#44400 )

2026-09-10 03:40:55 +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.