codex/sdk/python/examples
ianw-oai 240bbfc14a Add max and ultra reasoning efforts to the SDKs (#39662)
## What changed

- Add `max` and `ultra` to the TypeScript `ModelReasoningEffort` type.
- Add matching Python `ReasoningEffort` members and preserve them when SDK artifacts are regenerated.
- Update the Python model-selection examples to rank the new effort levels.

## Testing

- Cover serialization of both new Python enum members while continuing to accept unknown future values.

GitOrigin-RevId: 1412b77bdbb2530f5d38921cdea971dd34458353
History 2026-08-20 08:20:08 +00:00
..
01_quickstart_constructor [8/8] Add Python SDK Ruff formatting (#22021) 2026-05-12 01:10:29 +03:00
02_turn_run [codex] Accept string input for Python turns (#23162) 2026-05-17 09:05:44 -07:00
03_turn_stream_events [codex] Accept string input for Python turns (#23162) 2026-05-17 09:05:44 -07:00
04_models_and_metadata [codex] Return TurnResult from Python turn handles (#23151) 2026-05-17 06:17:22 -07:00
05_existing_thread [codex] Accept string input for Python turns (#23162) 2026-05-17 09:05:44 -07:00
06_thread_lifecycle_and_controls [codex] Accept string input for Python turns (#23162) 2026-05-17 09:05:44 -07:00
07_image_and_text [sdk/python] Stop advertising HTTP image URLs (#29464) 2026-06-22 11:34:14 -07:00
08_local_image_and_text [codex] Return TurnResult from Python turn handles (#23151) 2026-05-17 06:17:22 -07:00
09_async_parity [codex] Accept string input for Python turns (#23162) 2026-05-17 09:05:44 -07:00
10_error_handling_and_retry [codex] Accept string input for Python turns (#23162) 2026-05-17 09:05:44 -07:00
11_cli_mini_app [codex] Accept string input for Python turns (#23162) 2026-05-17 09:05:44 -07:00
12_turn_params_kitchen_sink [codex] Accept string input for Python turns (#23162) 2026-05-17 09:05:44 -07:00
13_model_select_and_turn_params Add max and ultra reasoning efforts to the SDKs (#39662) 2026-08-20 08:20:08 +00:00
14_turn_controls [codex] Accept string input for Python turns (#23162) 2026-05-17 09:05:44 -07:00
15_login_and_account sdk/python: add first-class login support (#23093) 2026-05-16 19:49:28 -07:00
_bootstrap.py [sdk/python] Stop advertising HTTP image URLs (#29464) 2026-06-22 11:34:14 -07:00
README.md Prepare Python SDK 0.144.4 stable release (#33213) 2026-07-15 02:43:31 +00:00

Python SDK Examples

Each example folder contains runnable versions:

  • sync.py (public sync surface: Codex)
  • async.py (public async surface: AsyncCodex)

All examples intentionally use only public SDK exports from openai_codex and openai_codex.types.

Examples use plain strings for text-only turns and typed input objects for multimodal or structured input lists.

Prerequisites

  • Python >=3.10
  • Install the SDK for the same Python interpreter you will use to run examples

Install the published SDK:

python -m pip install openai-codex

The SDK installs its pinned openai-codex-cli-bin runtime dependency. The pinned runtime version comes from the SDK package dependency.

Run From A Checkout

Contributors using these checked-in scripts should install development dependencies from sdk/python:

uv sync --group dev
source .venv/bin/activate

The examples bootstrap local SDK imports from sdk/python/src. If the pinned runtime is not already installed, the bootstrap installs the matching runtime package for the active interpreter and cleans up temporary files afterward.

Run examples

From sdk/python:

python examples/<example-folder>/sync.py
python examples/<example-folder>/async.py

The checked-in examples use the local SDK source tree automatically.

python examples/01_quickstart_constructor/sync.py
python examples/01_quickstart_constructor/async.py

Index

  • 01_quickstart_constructor/
    • first run / sanity check
  • 02_turn_run/
    • inspect full turn output fields
  • 03_turn_stream_events/
    • stream a turn with a small curated event view
  • 04_models_and_metadata/
    • discover visible models for the connected runtime
  • 05_existing_thread/
    • resume a real existing thread (created in-script)
  • 06_thread_lifecycle_and_controls/
    • thread lifecycle + control calls
  • 07_image_and_text/
    • image data URL + text multimodal turn
  • 08_local_image_and_text/
    • local image + text multimodal turn using a generated temporary sample image
  • 09_async_parity/
    • parity-style sync flow (see async parity in other examples)
  • 10_error_handling_and_retry/
    • overload retry pattern + typed error handling structure
  • 11_cli_mini_app/
    • interactive chat loop
  • 12_turn_params_kitchen_sink/
    • structured output with a curated advanced turn(...) configuration
  • 13_model_select_and_turn_params/
    • list models, pick highest model + highest supported reasoning effort, run turns, print message and usage
  • 14_turn_controls/
    • separate steer() and interrupt() demos with concise summaries
  • 15_login_and_account/
    • browser-login handle lifecycle, cancellation, and account inspection