TypeScript SDK
Embed the Codex coding agent in a Node.js application with a typed client.
The TypeScript SDK wraps the codex CLI from @openai/codex. It starts the CLI and exchanges JSONL events over stdin/stdout. It requires Node.js 18+.
Start and continue a thread
Stream events
run() buffers until the turn finishes. Use runStreamed() for progress, tool calls, file changes, and usage:
Resume a thread
Threads persist in ~/.codex/sessions. Save the thread ID and resume it later:
Structured output and images
Pass a JSON Schema for machine-readable output:
Attach local images with structured input entries:
Configuration
Codex accepts env, config, and configOverrides. A thread can set workingDirectory and skipGitRepoCheck. The SDK inherits the Node.js process environment by default; supply env when the child process must receive a restricted environment. See the SDK README for the complete options and item types.
更新于 2026年8月31日