SDKs

Embed Codex with the official TypeScript SDK or integrate through its CLI and MCP interfaces.

Table of Contents

Shared model

The official SDK in this repository is the TypeScript package @openai/codex-sdk. It embeds the local Codex CLI rather than calling a hosted HTTP API.

Option	Package or command	Best for
TypeScript SDK	`npm install @openai/codex-sdk`	Node.js applications and services
CLI	`npm install -g @openai/codex`	Humans, scripts, and CI
MCP server	`codex mcp-server`	Another MCP client controlling Codex

Shared model

A thread is persisted conversation state.
A turn is one user request within a thread.
Items are structured results such as agent messages, reasoning summaries, command executions, file changes, MCP calls, web searches, and errors.
A stream is an async sequence of events emitted while a turn runs.

The SDK README currently requires Node.js 18 or later. The package uses ES modules. There are no official Python or Go Codex SDKs in openai/codex; other languages can invoke the CLI or connect to the MCP server with their own wrapper.

更新于 2026年8月31日