openai-codex 0.1.0b1

Python SDK for Codex

OpenAI Codex Python SDK (Beta)

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

[!NOTE] openai-codex is in beta. Public APIs may change before 1.0.

Install

Install the SDK:

pip install openai-codex

For reproducible environments, install this release exactly:

pip install openai-codex==0.1.0b1

The SDK requires Python >=3.10 and installs its compatible Codex runtime dependency automatically. While beta releases are the only published SDK releases, the normal install command selects the latest beta. After a stable release exists, use pip install --pre openai-codex to explicitly select a newer prerelease.

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

• Getting started
• API reference
• FAQ
• Examples

The package is licensed under the repository Apache License 2.0.