mirror of https://github.com/openai/codex.git synced 2026-10-19 17:28:46 +00:00

Files

T

Won Park 45311351c2 Add opt-in retention for turn tool outputs (#52686 )

## What changed

Add an optional `retain` flag to `TurnToolOutput` for `turn/start`. When set to `true`, pass the output to the core with a retention annotation to request retention in the thread's model history. The flag defaults to `false`, preserving existing behavior.

Update the generated JSON schemas, TypeScript types, and Python bindings to expose the flag.

## Testing

Add an integration test verifying that a retained tool output reaches the model and preserves client-authored sender metadata in persisted history, including the receiver message ID.

GitOrigin-RevId: 52893a8fcb308f26e77ba8f0bee9990073b26d54

2026-10-09 20:02:18 +00:00

docs

Normalize formatting in docs, web assets, and sample scripts (#52256 )

2026-10-08 20:11:43 +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

Accept unknown Codex error variants in the app-server protocol (#49806 )

2026-10-01 01:38:04 +00:00

src/openai_codex

Add opt-in retention for turn tool outputs (#52686 )

2026-10-09 20:02:18 +00:00

tests

Normalize formatting in docs, web assets, and sample scripts (#52256 )

2026-10-08 20:11:43 +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.