Theia API Documentation v1.67.0
    Preparing search index...

    Module @theia/ai-codex


    theia-ext-logo

    ECLIPSE THEIA - OPENAI CODEX INTEGRATION


    The @theia/ai-codex integrates OpenAI's Codex agent into the Theia platform, providing natural language coding assistance through the chat interface.

    • Natural language coding assistance via OpenAI Codex SDK
    • Thread-based conversation management
    • Streaming responses with real-time updates
    • Token usage tracking and cost monitoring
    • Structured output support (JSON Schema, Zod)
    • Integration with Theia's AI chat infrastructure
    • Node.js 18 or higher
    • OpenAI API key (configured via Theia preferences)

    Codex requires an OpenAI API key. You can configure it in several ways (in order of priority):

    1. Codex-specific key (highest priority):

      • Preference: ai-features.codex.apiKey
      • Use this if you want a separate API key for Codex
    2. Shared OpenAI key (fallback):

      • Preference: ai-features.openAiOfficial.openAiApiKey
      • Shared with other OpenAI integrations in Theia
    3. Environment variable (final fallback):

      export OPENAI_API_KEY=your-api-key-here
      

    If you already use OpenAI features in Theia, Codex will automatically use that API key. No additional configuration needed!

    "Theia" is a trademark of the Eclipse Foundation https://www.eclipse.org/theia

    Modules

    browser/codex-chat-agent
    browser/codex-frontend-module
    browser/codex-frontend-service
    browser/codex-tool-call-content
    browser/renderers/collapsible-tool-renderer
    browser/renderers/command-execution-renderer
    browser/renderers/todo-list-renderer
    browser/renderers/web-search-renderer
    common
    common/codex-preferences
    common/codex-service
    node/codex-backend-module
    node/codex-service-impl