codex/sdk/python
History 2026-09-10 12:45:57 -07:00
..
docs Prepare manual Python SDK 0.154.0 release 2026-09-10 12:45:57 -07:00
examples Add untrusted external messages to the Python SDK (#44086) 2026-09-09 06:54:18 +00:00
notebooks [sdk/python] Stop advertising HTTP image URLs (#29464) 2026-06-22 11:34:14 -07:00
scripts Start Python SDK turn subscriptions at their attachment point (#44400) 2026-09-10 03:40:55 +00:00
src/openai_codex Add app-server APIs for stored thread attachments (#44564) 2026-09-10 15:52:09 +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 Prepare manual Python SDK 0.154.0 release 2026-09-10 12:45:57 -07: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 Prepare manual Python SDK 0.154.0 release 2026-09-10 12:45:57 -07:00

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.