Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
acodex: typed Python SDK for the Codex CLI
acodex: typed Python SDK for the Codex CLI
v0.105.0 GitHub

Documentation

  • Getting started
    • Installation
    • Quickstart
  • Guides
    • Streaming events
    • Structured output
    • Images
    • Threads and sessions
    • Safety, sandboxing, and approvals
    • Troubleshooting
  • Compatibility
    • Parity and automation
    • Differences from the TypeScript SDK
  • API reference
    • Core API
    • Types
    • Exceptions
Back to top
View this page
Edit this page

Getting started¶

Install acodex and run your first thread. These pages assume you already have a working Python environment and access to the Codex CLI.

When to use this section¶

  • You are installing acodex for the first time.

  • You want a minimal “hello world” to confirm the CLI + SDK work together.

  • Installation
    • When to use this page
    • Prerequisite: Codex CLI
    • Install acodex
    • Optional: Structured-output extra for typed structured output
  • Quickstart
    • When to use this page
    • Sync client
    • Async client
Next
Installation
Previous
Home
Copyright ©
Made with Sphinx and @pradyunsg's Furo
On this page
  • Getting started
    • When to use this section