mirror of https://github.com/openai/codex.git synced 2026-11-14 21:40:39 +00:00

Files

T

Brent Traut 32cec881b7 Add thread ID inclusion filters to thread/list (#61446 )

## Why

Clients reconciling saved thread IDs need to retrieve matching summaries within the current list filters, including threads beyond the first page of history.

## What changed

- Add `includedThreadIds` with up to 100 entries, applied before pagination alongside existing filters. Exclusions take precedence, and results retain the requested list sort.
- Treat omitted or null inclusions as unrestricted and an empty array as matching nothing. Reject invalid IDs and oversized arrays without truncating them.
- Use indexed metadata and primary-key lookups for local inclusion queries, without scanning rollouts for repairs. IDs absent from the index do not match.
- Update protocol schemas, generated bindings, and documentation, including guidance to verify server support before treating missing saved IDs as removals.

## Testing

Add coverage for saved IDs across project moves and archiving, pagination, exclusions, validation limits, and combinations with search, account, and relationship filters. Add a SQLite query-plan test for primary-key lookups across scopes.

GitOrigin-RevId: 90b02a12aee5716f872a9d5d6168d23cf86c6333

2026-11-14 02:23:37 +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

Version answer display instructions and restrict unsupported payloads (#60904 )

2026-11-11 23:35:05 +00:00

src/openai_codex

Add thread ID inclusion filters to thread/list (#61446 )

2026-11-14 02:23:37 +00:00

tests

Version answer display instructions and restrict unsupported payloads (#60904 )

2026-11-11 23:35:05 +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

Bump the Python SDK build backend to uv_build 0.13 (#59512 )

2026-11-04 23:05:12 +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

Upgrade Python SDK model generation to datamodel-code-generator 0.64.0 (#56272 )

2026-10-22 21:40:58 +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.