mirror of https://github.com/openai/codex.git synced 2026-10-20 17:38:45 +00:00

Files

T

Matt Kaufer 592964c0cb Record local image inputs on completed image-generation items (#54420 )

## What changed

Add optional `inputImages` metadata containing each referenced local image's path and SHA-256 hash of the bytes read before normalization. Compute the hash from the same bytes used to prepare the edit request.

Preserve this metadata through completion events, persisted thread history, resume, and legacy rollout migration. Update app-server schemas and generated TypeScript and Python types; older items continue to deserialize without the field.

## Testing

Add coverage for input ordering, changed contents at the same path, unreadable or invalid references, serialization, persisted history and resume, and legacy migration.

GitOrigin-RevId: 522be8ec1e39c9b2bbe5b9ccb37ea67d17f0e21a

2026-10-15 21:30:56 +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

Store generated image items as attachment references (#54398 )

2026-10-15 19:51:22 +00:00

src/openai_codex

Record local image inputs on completed image-generation items (#54420 )

2026-10-15 21:30:56 +00:00

tests

Store generated image items as attachment references (#54398 )

2026-10-15 19:51:22 +00:00

_runtime_setup.py

Support alpha hotfix release versions (#34463 )

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

BUILD.bazel

Add Bazel targets for on-demand schemas and Python SDK generation (#54096 )

2026-10-14 20:59:31 +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.