Packages

codex_sdk

0.4.2
0.18.1 0.18.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
32 Versions
6 Dependencies
Dependants
Files
Activity
codex_sdk docs 20251202 gap_analysis 004-file-upload-and-temporary-attachments.md
Raw

docs/20251202/gap_analysis/004-file-upload-and-temporary-attachments.md 

# ADR 004: Implement file upload + temporary attachment helpers



- Status: Proposed

- Date: 2025-12-02



## Context

- The attachments design calls for parity with Python, including `Codex.Files.upload/2` and `Codex.Files.temporary/1` RAII helpers (docs/design/attachments-files.md:3-32).

- The current Elixir implementation only stages local files and attaches them to thread options (lib/codex/files.ex:1-152); no upload or temporary helper exists.



## Problem

- SDK callers cannot push staged files to Codex via the documented upload API, nor can they create scoped temporary attachments that auto-clean. This leaves Python workflows (upload + disposable attachments) unported.



## Decision

- Add an upload pipeline that streams staged files to the CLI/API and returns attachment descriptors compatible with the existing registry.

- Provide a `temporary/1` helper that stages ephemeral files with automatic cleanup semantics.



## Actions

- Build unit/integration tests around upload success/failure and temporary lifecycle.

- Update public docs to describe the new helpers and regeneration steps for Python parity fixtures that cover uploads.