Codex TypeScript SDK

Embeds Codex by spawning the CLI and exchanging structured JSONL events.

Parent repository GitHub

Type: TypeScript SDK
Repository: openai/codex
Readiness: Ready for direct end-user installation and application embedding according to first-party documentation, with authentication required and sandbox, permissions, network policy, and telemetry configuration needing environment-specific review.
Keywords: 6

Location

Repository path

sdk/typescript/README.md

Invocation

new Codex().startThread().run(prompt)

Setup

Installation / activation

Import after installing @openai/codex-sdk on Node.js 18+.

Keywords

TypeScriptNode.jsSDKJSONLstreamingstructured output

Repository context

openai/codex

Apache-2.0 OpenAI coding-agent platform centered on the standalone Codex CLI, with desktop and IDE entry points, Python and TypeScript SDKs, structured and streaming turns, persistent sessions, model-visible tools, and OS-specific sandbox enforcement; it is an alternative or companion to Claude Code rather than a Claude Code extension.

software engineeringcoding agentsdeveloper toolscommand-line interfacesagent SDKssandboxingtool executionobservabilityIDE toolingdesktop applications

Open full repository research