Packages

codex_sdk

0.3.0
0.17.0 0.16.1 0.16.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.1 0.10.0 0.9.0 0.8.0 0.7.2 0.7.1 0.7.0 0.6.0 0.5.0 0.4.5 0.4.4 0.4.3 0.4.2 0.4.1 0.4.0 0.3.0 0.2.5 0.2.4 0.2.3 0.2.2 0.2.1 0.2.0 0.1.0

Idiomatic Elixir SDK for OpenAI's Codex agent. Provides a complete, production-ready interface with streaming support, comprehensive event handling, and robust testing utilities.

HexDocs

Current section

Files

Jump to
Readme
30 Versions
6 Dependencies
Dependants
Files
Activity
codex_sdk docs 20251202 gap_analysis 002-base-url-forwarding.md
Raw

docs/20251202/gap_analysis/002-base-url-forwarding.md 

# ADR 002: Honor base_url when spawning codex exec



- Status: Proposed

- Date: 2025-12-02



## Context

- The upstream SDK sets `OPENAI_BASE_URL` when a custom base URL is provided (codex/sdk/typescript/src/exec.ts:109-128).

- Elixir exposes `base_url` on `Codex.Options` (lib/codex/options.ex:11-54) but `Codex.Exec.build_env/1` only forwards API keys and the originator override (lib/codex/exec.ex:271-281). No environment variable reflects the configured base URL.



## Problem

- Elixir callers cannot target alternative API hosts even though the option exists. This breaks parity with Python/TypeScript behavior and makes the `base_url` field effectively dead code.



## Decision

- Propagate `Codex.Options.base_url` into the child process environment (e.g., `OPENAI_BASE_URL`) mirroring the upstream SDK.

- Add guardrails so custom env overrides still merge cleanly with the derived base URL.



## Actions

- Extend env construction tests to assert base URL propagation and to catch regressions.

- Update public docs to clarify how to point the SDK at non-default Codex endpoints.