app-server.md +326 −38
21Requests include `method`, `params`, and `id`:21Requests include `method`, `params`, and `id`:
22 22
23```json23```json
2424{ "method": "thread/start", "id": 10, "params": { "model": "gpt-5.1-codex" } }{ "method": "thread/start", "id": 10, "params": { "model": "gpt-5.4" } }
25```25```
26 26
27Responses echo the `id` with either `result` or `error`:27Responses echo the `id` with either `result` or `error`:
99 },99 },
100});100});
101send({ method: "initialized", params: {} });101send({ method: "initialized", params: {} });
102102send({ method: "thread/start", id: 1, params: { model: "gpt-5.1-codex" } });send({ method: "thread/start", id: 1, params: { model: "gpt-5.4" } });
103```103```
104 104
105## Core primitives105## Core primitives
116- **Start (or resume) a thread**: Call `thread/start` for a new conversation, `thread/resume` to continue an existing one, or `thread/fork` to branch history into a new thread id.116- **Start (or resume) a thread**: Call `thread/start` for a new conversation, `thread/resume` to continue an existing one, or `thread/fork` to branch history into a new thread id.
117- **Begin a turn**: Call `turn/start` with the target `threadId` and user input. Optional fields override model, personality, `cwd`, sandbox policy, and more.117- **Begin a turn**: Call `turn/start` with the target `threadId` and user input. Optional fields override model, personality, `cwd`, sandbox policy, and more.
118- **Steer an active turn**: Call `turn/steer` to append user input to the currently in-flight turn without creating a new turn.118- **Steer an active turn**: Call `turn/steer` to append user input to the currently in-flight turn without creating a new turn.
119119- **Stream events**: After `turn/start`, keep reading notifications on stdout: `item/started`, `item/completed`, `item/agentMessage/delta`, tool progress, and other updates.- **Stream events**: After `turn/start`, keep reading notifications on stdout: `thread/archived`, `thread/unarchived`, `item/started`, `item/completed`, `item/agentMessage/delta`, tool progress, and other updates.
120- **Finish the turn**: The server emits `turn/completed` with final status when the model finishes or after a `turn/interrupt` cancellation.120- **Finish the turn**: The server emits `turn/completed` with final status when the model finishes or after a `turn/interrupt` cancellation.
121 121
122## Initialization122## Initialization
123 123
124Clients must send a single `initialize` request per transport connection before invoking any other method on that connection, then acknowledge with an `initialized` notification. Requests sent before initialization receive a `Not initialized` error, and repeated `initialize` calls on the same connection return `Already initialized`.124Clients must send a single `initialize` request per transport connection before invoking any other method on that connection, then acknowledge with an `initialized` notification. Requests sent before initialization receive a `Not initialized` error, and repeated `initialize` calls on the same connection return `Already initialized`.
125 125
126126The server returns the user agent string it will present to upstream services. Set `clientInfo` to identify your integration.The server returns the user agent string it will present to upstream services plus `platformFamily` and `platformOs` values that describe the runtime target. Set `clientInfo` to identify your integration.
127 127
128`initialize.params.capabilities` also supports per-connection notification opt-out via `optOutNotificationMethods`, which is a list of exact method names to suppress for that connection. Matching is exact (no wildcards/prefixes). Unknown method names are accepted and ignored.128`initialize.params.capabilities` also supports per-connection notification opt-out via `optOutNotificationMethods`, which is a list of exact method names to suppress for that connection. Matching is exact (no wildcards/prefixes). Unknown method names are accepted and ignored.
129 129
159 },159 },
160 "capabilities": {160 "capabilities": {
161 "experimentalApi": true,161 "experimentalApi": true,
162162 "optOutNotificationMethods": [ "optOutNotificationMethods": ["thread/started", "item/agentMessage/delta"]
163 "codex/event/session_configured",
164 "item/agentMessage/delta"
165 ]
166 }163 }
167 }164 }
168}165}
201- `thread/start` - create a new thread; emits `thread/started` and automatically subscribes you to turn/item events for that thread.198- `thread/start` - create a new thread; emits `thread/started` and automatically subscribes you to turn/item events for that thread.
202- `thread/resume` - reopen an existing thread by id so later `turn/start` calls append to it.199- `thread/resume` - reopen an existing thread by id so later `turn/start` calls append to it.
203- `thread/fork` - fork a thread into a new thread id by copying stored history; emits `thread/started` for the new thread.200- `thread/fork` - fork a thread into a new thread id by copying stored history; emits `thread/started` for the new thread.
204201- `thread/read` - read a stored thread by id without resuming it; set `includeTurns` to return full turn history.- `thread/read` - read a stored thread by id without resuming it; set `includeTurns` to return full turn history. Returned `thread` objects include runtime `status`.
205202- `thread/list` - page through stored thread logs; supports cursor-based pagination plus `modelProviders`, `sourceKinds`, `archived`, and `cwd` filters.- `thread/list` - page through stored thread logs; supports cursor-based pagination plus `modelProviders`, `sourceKinds`, `archived`, and `cwd` filters. Returned `thread` objects include runtime `status`.
206- `thread/loaded/list` - list the thread ids currently loaded in memory.203- `thread/loaded/list` - list the thread ids currently loaded in memory.
207204- `thread/archive` - move a thread’s log file into the archived directory; returns `{}` on success.- `thread/name/set` - set or update a thread's user-facing name for a loaded thread or a persisted rollout; emits `thread/name/updated`.
208205- `thread/unarchive` - restore an archived thread rollout back into the active sessions directory; returns the restored `thread`.- `thread/archive` - move a thread's log file into the archived directory; returns `{}` on success and emits `thread/archived`.
206- `thread/unsubscribe` - unsubscribe this connection from thread turn/item events. If this was the last subscriber, the server unloads the thread and emits `thread/closed`.
207- `thread/unarchive` - restore an archived thread rollout back into the active sessions directory; returns the restored `thread` and emits `thread/unarchived`.
208- `thread/status/changed` - notification emitted when a loaded thread's runtime `status` changes.
209- `thread/compact/start` - trigger conversation history compaction for a thread; returns `{}` immediately while progress streams via `turn/*` and `item/*` notifications.209- `thread/compact/start` - trigger conversation history compaction for a thread; returns `{}` immediately while progress streams via `turn/*` and `item/*` notifications.
210- `thread/shellCommand` - run a user-initiated shell command against a thread. This runs outside the sandbox with full access and doesn't inherit the thread sandbox policy.
211- `thread/backgroundTerminals/clean` - stop all running background terminals for a thread (experimental; requires `capabilities.experimentalApi`).
210- `thread/rollback` - drop the last N turns from the in-memory context and persist a rollback marker; returns the updated `thread`.212- `thread/rollback` - drop the last N turns from the in-memory context and persist a rollback marker; returns the updated `thread`.
211- `turn/start` - add user input to a thread and begin Codex generation; responds with the initial `turn` and streams events. For `collaborationMode`, `settings.developer_instructions: null` means "use built-in instructions for the selected mode."213- `turn/start` - add user input to a thread and begin Codex generation; responds with the initial `turn` and streams events. For `collaborationMode`, `settings.developer_instructions: null` means "use built-in instructions for the selected mode."
212- `turn/steer` - append user input to the active in-flight turn for a thread; returns the accepted `turnId`.214- `turn/steer` - append user input to the active in-flight turn for a thread; returns the accepted `turnId`.
213- `turn/interrupt` - request cancellation of an in-flight turn; success is `{}` and the turn ends with `status: "interrupted"`.215- `turn/interrupt` - request cancellation of an in-flight turn; success is `{}` and the turn ends with `status: "interrupted"`.
214- `review/start` - kick off the Codex reviewer for a thread; emits `enteredReviewMode` and `exitedReviewMode` items.216- `review/start` - kick off the Codex reviewer for a thread; emits `enteredReviewMode` and `exitedReviewMode` items.
215- `command/exec` - run a single command under the server sandbox without starting a thread/turn.217- `command/exec` - run a single command under the server sandbox without starting a thread/turn.
218- `command/exec/write` - write `stdin` bytes to a running `command/exec` session or close `stdin`.
219- `command/exec/resize` - resize a running PTY-backed `command/exec` session.
220- `command/exec/terminate` - stop a running `command/exec` session.
216- `model/list` - list available models (set `includeHidden: true` to include entries with `hidden: true`) with effort options, optional `upgrade`, and `inputModalities`.221- `model/list` - list available models (set `includeHidden: true` to include entries with `hidden: true`) with effort options, optional `upgrade`, and `inputModalities`.
217- `experimentalFeature/list` - list feature flags with lifecycle stage metadata and cursor pagination.222- `experimentalFeature/list` - list feature flags with lifecycle stage metadata and cursor pagination.
218- `collaborationMode/list` - list collaboration mode presets (experimental, no pagination).223- `collaborationMode/list` - list collaboration mode presets (experimental, no pagination).
219- `skills/list` - list skills for one or more `cwd` values (supports `forceReload` and optional `perCwdExtraUserRoots`).224- `skills/list` - list skills for one or more `cwd` values (supports `forceReload` and optional `perCwdExtraUserRoots`).
225- `plugin/list` - list discovered plugin marketplaces and plugin state, including install/auth policy metadata, marketplace errors, featured plugin ids, and the development-only `forceRemoteSync` option.
226- `plugin/read` - read one plugin by marketplace path and plugin name, including bundled skills, apps, and MCP server names.
227- `plugin/install` - install a plugin from a marketplace path.
228- `plugin/uninstall` - uninstall an installed plugin.
220- `app/list` - list available apps (connectors) with pagination plus accessibility/enabled metadata.229- `app/list` - list available apps (connectors) with pagination plus accessibility/enabled metadata.
221- `skills/config/write` - enable or disable skills by path.230- `skills/config/write` - enable or disable skills by path.
222- `mcpServer/oauth/login` - start an OAuth login for a configured MCP server; returns an authorization URL and emits `mcpServer/oauthLogin/completed` on completion.231- `mcpServer/oauth/login` - start an OAuth login for a configured MCP server; returns an authorization URL and emits `mcpServer/oauthLogin/completed` on completion.
223- `tool/requestUserInput` - prompt the user with 1-3 short questions for a tool call (experimental); questions can set `isOther` for a free-form option.232- `tool/requestUserInput` - prompt the user with 1-3 short questions for a tool call (experimental); questions can set `isOther` for a free-form option.
224- `config/mcpServer/reload` - reload MCP server configuration from disk and queue a refresh for loaded threads.233- `config/mcpServer/reload` - reload MCP server configuration from disk and queue a refresh for loaded threads.
225234- `mcpServerStatus/list` - list MCP servers, tools, resources, and auth status (cursor + limit pagination).- `mcpServerStatus/list` - list MCP servers, tools, resources, and auth status (cursor + limit pagination). Use `detail: "full"` for full data or `detail: "toolsAndAuthOnly"` to omit resources.
226235- `feedback/upload` - submit a feedback report (classification + optional reason/logs + conversation id).- `mcpServer/resource/read` - read a single MCP resource through an initialized MCP server.
236- `windowsSandbox/setupStart` - start Windows sandbox setup for `elevated` or `unelevated` mode; returns quickly and later emits `windowsSandbox/setupCompleted`.
237- `feedback/upload` - submit a feedback report (classification + optional reason/logs + conversation id, plus optional `extraLogFiles` attachments).
227- `config/read` - fetch the effective configuration on disk after resolving configuration layering.238- `config/read` - fetch the effective configuration on disk after resolving configuration layering.
239- `externalAgentConfig/detect` - detect external-agent artifacts that can be migrated with `includeHome` and optional `cwds`; each detected item includes `cwd` (`null` for home).
240- `externalAgentConfig/import` - apply selected external-agent migration items by passing explicit `migrationItems` with `cwd` (`null` for home).
228- `config/value/write` - write a single configuration key/value to the user's `config.toml` on disk.241- `config/value/write` - write a single configuration key/value to the user's `config.toml` on disk.
229- `config/batchWrite` - apply configuration edits atomically to the user's `config.toml` on disk.242- `config/batchWrite` - apply configuration edits atomically to the user's `config.toml` on disk.
230243- `configRequirements/read` - fetch requirements from `requirements.toml` and/or MDM, including allow-lists and residency requirements (or `null` if you haven’t set any up).- `configRequirements/read` - fetch requirements from `requirements.toml` and/or MDM, including allow-lists, pinned `featureRequirements`, and residency/network requirements (or `null` if you haven't set any up).
244- `fs/readFile`, `fs/writeFile`, `fs/createDirectory`, `fs/getMetadata`, `fs/readDirectory`, `fs/remove`, and `fs/copy` - operate on absolute filesystem paths through the app-server v2 filesystem API.
231 245
232## Models246## Models
233 247
239{ "method": "model/list", "id": 6, "params": { "limit": 20, "includeHidden": false } }253{ "method": "model/list", "id": 6, "params": { "limit": 20, "includeHidden": false } }
240{ "id": 6, "result": {254{ "id": 6, "result": {
241 "data": [{255 "data": [{
242256 "id": "gpt-5.2-codex", "id": "gpt-5.4",
243257 "model": "gpt-5.2-codex", "model": "gpt-5.4",
244258 "upgrade": "gpt-5.3-codex", "displayName": "GPT-5.4",
245 "displayName": "GPT-5.2 Codex",
246 "hidden": false,259 "hidden": false,
247 "defaultReasoningEffort": "medium",260 "defaultReasoningEffort": "medium",
248261 "reasoningEffort": [{ "supportedReasoningEfforts": [{
249262 "effort": "low", "reasoningEffort": "low",
250 "description": "Lower latency"263 "description": "Lower latency"
251 }],264 }],
252 "inputModalities": ["text", "image"],265 "inputModalities": ["text", "image"],
259 272
260Each model entry can include:273Each model entry can include:
261 274
262275- `reasoningEffort` - supported effort options for the model.- `supportedReasoningEfforts` - supported effort options for the model.
263- `defaultReasoningEffort` - suggested default effort for clients.276- `defaultReasoningEffort` - suggested default effort for clients.
264- `upgrade` - optional recommended upgrade model id for migration prompts in clients.277- `upgrade` - optional recommended upgrade model id for migration prompts in clients.
278- `upgradeInfo` - optional upgrade metadata for migration prompts in clients.
265- `hidden` - whether the model is hidden from the default picker list.279- `hidden` - whether the model is hidden from the default picker list.
266- `inputModalities` - supported input types for the model (for example `text`, `image`).280- `inputModalities` - supported input types for the model (for example `text`, `image`).
267- `supportsPersonality` - whether the model supports personality-specific instructions such as `/personality`.281- `supportsPersonality` - whether the model supports personality-specific instructions such as `/personality`.
299- `thread/list` supports cursor pagination plus `modelProviders`, `sourceKinds`, `archived`, and `cwd` filtering.313- `thread/list` supports cursor pagination plus `modelProviders`, `sourceKinds`, `archived`, and `cwd` filtering.
300- `thread/loaded/list` returns the thread IDs currently in memory.314- `thread/loaded/list` returns the thread IDs currently in memory.
301- `thread/archive` moves the thread's persisted JSONL log into the archived directory.315- `thread/archive` moves the thread's persisted JSONL log into the archived directory.
316- `thread/unsubscribe` unsubscribes the current connection from a loaded thread and can trigger `thread/closed`.
302- `thread/unarchive` restores an archived thread rollout back into the active sessions directory.317- `thread/unarchive` restores an archived thread rollout back into the active sessions directory.
303- `thread/compact/start` triggers compaction and returns `{}` immediately.318- `thread/compact/start` triggers compaction and returns `{}` immediately.
304- `thread/rollback` drops the last N turns from the in-memory context and records a rollback marker in the thread's persisted JSONL log.319- `thread/rollback` drops the last N turns from the in-memory context and records a rollback marker in the thread's persisted JSONL log.
309 324
310```json325```json
311{ "method": "thread/start", "id": 10, "params": {326{ "method": "thread/start", "id": 10, "params": {
312327 "model": "gpt-5.1-codex", "model": "gpt-5.4",
313 "cwd": "/Users/me/project",328 "cwd": "/Users/me/project",
314 "approvalPolicy": "never",329 "approvalPolicy": "never",
315 "sandbox": "workspaceWrite",330 "sandbox": "workspaceWrite",
316331 "personality": "friendly" "personality": "friendly",
332 "serviceName": "my_app_server_client"
317} }333} }
318{ "id": 10, "result": {334{ "id": 10, "result": {
319 "thread": {335 "thread": {
320 "id": "thr_123",336 "id": "thr_123",
321 "preview": "",337 "preview": "",
338 "ephemeral": false,
322 "modelProvider": "openai",339 "modelProvider": "openai",
323 "createdAt": 1730910000340 "createdAt": 1730910000
324 }341 }
326{ "method": "thread/started", "params": { "thread": { "id": "thr_123" } } }343{ "method": "thread/started", "params": { "thread": { "id": "thr_123" } } }
327```344```
328 345
346`serviceName` is optional. Set it when you want app-server to tag thread-level metrics with your integration's service name.
347
329To continue a stored session, call `thread/resume` with the `thread.id` you recorded earlier. The response shape matches `thread/start`. You can also pass the same configuration overrides supported by `thread/start`, such as `personality`:348To continue a stored session, call `thread/resume` with the `thread.id` you recorded earlier. The response shape matches `thread/start`. You can also pass the same configuration overrides supported by `thread/start`, such as `personality`:
330 349
331```json350```json
333 "threadId": "thr_123",352 "threadId": "thr_123",
334 "personality": "friendly"353 "personality": "friendly"
335} }354} }
336355{ "id": 11, "result": { "thread": { "id": "thr_123" } } }{ "id": 11, "result": { "thread": { "id": "thr_123", "name": "Bug bash notes", "ephemeral": false } } }
337```356```
338 357
339Resuming a thread doesn't update `thread.updatedAt` (or the rollout file's modified time) by itself. The timestamp updates when you start a turn.358Resuming a thread doesn't update `thread.updatedAt` (or the rollout file's modified time) by itself. The timestamp updates when you start a turn.
352{ "method": "thread/started", "params": { "thread": { "id": "thr_456" } } }371{ "method": "thread/started", "params": { "thread": { "id": "thr_456" } } }
353```372```
354 373
374When a user-facing thread title has been set, app-server hydrates `thread.name` on `thread/list`, `thread/read`, `thread/resume`, `thread/unarchive`, and `thread/rollback` responses. `thread/start` and `thread/fork` may omit `name` (or return `null`) until a title is set later.
375
355### Read a stored thread (without resuming)376### Read a stored thread (without resuming)
356 377
357Use `thread/read` when you want stored thread data but don't want to resume the thread or subscribe to its events.378Use `thread/read` when you want stored thread data but don't want to resume the thread or subscribe to its events.
358 379
359- `includeTurns` - when `true`, the response includes the thread's turns; when `false` or omitted, you get the thread summary only.380- `includeTurns` - when `true`, the response includes the thread's turns; when `false` or omitted, you get the thread summary only.
381- Returned `thread` objects include runtime `status` (`notLoaded`, `idle`, `systemError`, or `active` with `activeFlags`).
360 382
361```json383```json
362{ "method": "thread/read", "id": 19, "params": { "threadId": "thr_123", "includeTurns": true } }384{ "method": "thread/read", "id": 19, "params": { "threadId": "thr_123", "includeTurns": true } }
363385{ "id": 19, "result": { "thread": { "id": "thr_123", "turns": [] } } }{ "id": 19, "result": { "thread": { "id": "thr_123", "name": "Bug bash notes", "ephemeral": false, "status": { "type": "notLoaded" }, "turns": [] } } }
364```386```
365 387
366Unlike `thread/resume`, `thread/read` doesn't load the thread into memory or emit `thread/started`.388Unlike `thread/resume`, `thread/read` doesn't load the thread into memory or emit `thread/started`.
400} }422} }
401{ "id": 20, "result": {423{ "id": 20, "result": {
402 "data": [424 "data": [
403425 { "id": "thr_a", "preview": "Create a TUI", "modelProvider": "openai", "createdAt": 1730831111, "updatedAt": 1730831111 }, { "id": "thr_a", "preview": "Create a TUI", "ephemeral": false, "modelProvider": "openai", "createdAt": 1730831111, "updatedAt": 1730831111, "name": "TUI prototype", "status": { "type": "notLoaded" } },
404426 { "id": "thr_b", "preview": "Fix tests", "modelProvider": "openai", "createdAt": 1730750000, "updatedAt": 1730750000 } { "id": "thr_b", "preview": "Fix tests", "ephemeral": true, "modelProvider": "openai", "createdAt": 1730750000, "updatedAt": 1730750000, "status": { "type": "notLoaded" } }
405 ],427 ],
406 "nextCursor": "opaque-token-or-null"428 "nextCursor": "opaque-token-or-null"
407} }429} }
409 431
410When `nextCursor` is `null`, you have reached the final page.432When `nextCursor` is `null`, you have reached the final page.
411 433
434### Track thread status changes
435
436`thread/status/changed` is emitted whenever a loaded thread's runtime status changes. The payload includes `threadId` and the new `status`.
437
438```json
439{
440 "method": "thread/status/changed",
441 "params": {
442 "threadId": "thr_123",
443 "status": { "type": "active", "activeFlags": ["waitingOnApproval"] }
444 }
445}
446```
447
412### List loaded threads448### List loaded threads
413 449
414`thread/loaded/list` returns thread IDs currently loaded in memory.450`thread/loaded/list` returns thread IDs currently loaded in memory.
418{ "id": 21, "result": { "data": ["thr_123", "thr_456"] } }454{ "id": 21, "result": { "data": ["thr_123", "thr_456"] } }
419```455```
420 456
457### Unsubscribe from a loaded thread
458
459`thread/unsubscribe` removes the current connection's subscription to a thread. The response status is one of:
460
461- `unsubscribed` when the connection was subscribed and is now removed.
462- `notSubscribed` when the connection wasn't subscribed to that thread.
463- `notLoaded` when the thread isn't loaded.
464
465If this was the last subscriber, the server unloads the thread and emits a `thread/status/changed` transition to `notLoaded` plus `thread/closed`.
466
467```json
468{ "method": "thread/unsubscribe", "id": 22, "params": { "threadId": "thr_123" } }
469{ "id": 22, "result": { "status": "unsubscribed" } }
470{ "method": "thread/status/changed", "params": {
471 "threadId": "thr_123",
472 "status": { "type": "notLoaded" }
473} }
474{ "method": "thread/closed", "params": { "threadId": "thr_123" } }
475```
476
421### Archive a thread477### Archive a thread
422 478
423Use `thread/archive` to move the persisted thread log (stored as a JSONL file on disk) into the archived sessions directory.479Use `thread/archive` to move the persisted thread log (stored as a JSONL file on disk) into the archived sessions directory.
425```json481```json
426{ "method": "thread/archive", "id": 22, "params": { "threadId": "thr_b" } }482{ "method": "thread/archive", "id": 22, "params": { "threadId": "thr_b" } }
427{ "id": 22, "result": {} }483{ "id": 22, "result": {} }
484{ "method": "thread/archived", "params": { "threadId": "thr_b" } }
428```485```
429 486
430Archived threads won't appear in future calls to `thread/list` unless you pass `archived: true`.487Archived threads won't appear in future calls to `thread/list` unless you pass `archived: true`.
435 492
436```json493```json
437{ "method": "thread/unarchive", "id": 24, "params": { "threadId": "thr_b" } }494{ "method": "thread/unarchive", "id": 24, "params": { "threadId": "thr_b" } }
438495{ "id": 24, "result": { "thread": { "id": "thr_b" } } }{ "id": 24, "result": { "thread": { "id": "thr_b", "name": "Bug bash notes" } } }
496{ "method": "thread/unarchived", "params": { "threadId": "thr_b" } }
439```497```
440 498
441### Trigger thread compaction499### Trigger thread compaction
449{ "id": 25, "result": {} }507{ "id": 25, "result": {} }
450```508```
451 509
510### Run a thread shell command
511
512Use `thread/shellCommand` for user-initiated shell commands that belong to a thread. The request returns immediately with `{}` while progress streams through standard `turn/*` and `item/*` notifications.
513
514This API runs outside the sandbox with full access and doesn't inherit the thread sandbox policy. Clients should expose it only for explicit user-initiated commands.
515
516If the thread already has an active turn, the command runs as an auxiliary action on that turn and its formatted output is injected into the turn's message stream. If the thread is idle, app-server starts a standalone turn for the shell command.
517
518```json
519{ "method": "thread/shellCommand", "id": 26, "params": { "threadId": "thr_b", "command": "git status --short" } }
520{ "id": 26, "result": {} }
521```
522
523### Clean background terminals
524
525Use `thread/backgroundTerminals/clean` to stop all running background terminals associated with a thread. This method is experimental and requires `capabilities.experimentalApi = true`.
526
527```json
528{ "method": "thread/backgroundTerminals/clean", "id": 27, "params": { "threadId": "thr_b" } }
529{ "id": 27, "result": {} }
530```
531
532### Roll back recent turns
533
534Use `thread/rollback` to remove the last `numTurns` entries from the in-memory context and persist a rollback marker in the rollout log. The returned `thread` includes `turns` populated after the rollback.
535
536```json
537{ "method": "thread/rollback", "id": 28, "params": { "threadId": "thr_b", "numTurns": 1 } }
538{ "id": 28, "result": { "thread": { "id": "thr_b", "name": "Bug bash notes", "ephemeral": false } } }
539```
540
452## Turns541## Turns
453 542
454The `input` field accepts a list of items:543The `input` field accepts a list of items:
478}567}
479```568```
480 569
570On macOS, `includePlatformDefaults: true` appends a curated platform-default Seatbelt policy for restricted-read sessions. This improves tool compatibility without broadly allowing all of `/System`.
571
481Examples:572Examples:
482 573
483```json574```json
510 "writableRoots": ["/Users/me/project"],601 "writableRoots": ["/Users/me/project"],
511 "networkAccess": true602 "networkAccess": true
512 },603 },
513604 "model": "gpt-5.1-codex", "model": "gpt-5.4",
514 "effort": "medium",605 "effort": "medium",
515 "summary": "concise",606 "summary": "concise",
516 "personality": "friendly",607 "personality": "friendly",
653- The server rejects empty `command` arrays.744- The server rejects empty `command` arrays.
654- `sandboxPolicy` accepts the same shape used by `turn/start` (for example, `dangerFullAccess`, `readOnly`, `workspaceWrite`, `externalSandbox`).745- `sandboxPolicy` accepts the same shape used by `turn/start` (for example, `dangerFullAccess`, `readOnly`, `workspaceWrite`, `externalSandbox`).
655- When omitted, `timeoutMs` falls back to the server default.746- When omitted, `timeoutMs` falls back to the server default.
747- Set `tty: true` for PTY-backed sessions, and use `processId` when you plan to follow up with `command/exec/write`, `command/exec/resize`, or `command/exec/terminate`.
748- Set `streamStdoutStderr: true` to receive `command/exec/outputDelta` notifications while the command is running.
749
750### Read admin requirements (`configRequirements/read`)
751
752Use `configRequirements/read` to inspect the effective admin requirements loaded from `requirements.toml` and/or MDM.
753
754```json
755{ "method": "configRequirements/read", "id": 52, "params": {} }
756{ "id": 52, "result": {
757 "requirements": {
758 "allowedApprovalPolicies": ["onRequest", "unlessTrusted"],
759 "allowedSandboxModes": ["readOnly", "workspaceWrite"],
760 "featureRequirements": {
761 "personality": true,
762 "unified_exec": false
763 },
764 "network": {
765 "enabled": true,
766 "allowedDomains": ["api.openai.com"],
767 "allowUnixSockets": ["/tmp/example.sock"],
768 "dangerouslyAllowAllUnixSockets": false
769 }
770 }
771} }
772```
773
774`result.requirements` is `null` when no requirements are configured. See the docs on [`requirements.toml`](https://developers.openai.com/codex/config-reference#requirementstoml) for details on supported keys and values.
775
776### Windows sandbox setup (`windowsSandbox/setupStart`)
777
778Custom Windows clients can trigger sandbox setup asynchronously instead of blocking on startup checks.
779
780```json
781{ "method": "windowsSandbox/setupStart", "id": 53, "params": { "mode": "elevated" } }
782{ "id": 53, "result": { "started": true } }
783```
784
785App-server starts setup in the background and later emits a completion notification:
786
787```json
788{
789 "method": "windowsSandbox/setupCompleted",
790 "params": { "mode": "elevated", "success": true, "error": null }
791}
792```
793
794Modes:
795
796- `elevated` - run the elevated Windows sandbox setup path.
797- `unelevated` - run the legacy setup/preflight path.
656 798
657## Events799## Events
658 800
659801Event notifications are the server-initiated stream for thread lifecycles, turn lifecycles, and the items within them. After you start or resume a thread, keep reading the active transport stream for `thread/started`, `turn/*`, and `item/*` notifications.Event notifications are the server-initiated stream for thread lifecycles, turn lifecycles, and the items within them. After you start or resume a thread, keep reading the active transport stream for `thread/started`, `thread/archived`, `thread/unarchived`, `thread/closed`, `thread/status/changed`, `turn/*`, `item/*`, and `serverRequest/resolved` notifications.
660 802
661### Notification opt-out803### Notification opt-out
662 804
664 806
665- Exact-match only: `item/agentMessage/delta` suppresses only that method.807- Exact-match only: `item/agentMessage/delta` suppresses only that method.
666- Unknown method names are ignored.808- Unknown method names are ignored.
667809- Applies to both legacy (`codex/event/*`) and v2 (`thread/*`, `turn/*`, `item/*`, etc.) notifications.- Applies to the current `thread/*`, `turn/*`, `item/*`, and related v2 notifications.
668- Doesn't apply to requests, responses, or errors.810- Doesn't apply to requests, responses, or errors.
669 811
670### Fuzzy file search events (experimental)812### Fuzzy file search events (experimental)
674- `fuzzyFileSearch/sessionUpdated` - `{ sessionId, query, files }` with the current matches for the active query.816- `fuzzyFileSearch/sessionUpdated` - `{ sessionId, query, files }` with the current matches for the active query.
675- `fuzzyFileSearch/sessionCompleted` - `{ sessionId }` once indexing and matching for that query completes.817- `fuzzyFileSearch/sessionCompleted` - `{ sessionId }` once indexing and matching for that query completes.
676 818
819### Windows sandbox setup events
820
821- `windowsSandbox/setupCompleted` - `{ mode, success, error }` emitted after a `windowsSandbox/setupStart` request finishes.
822
677### Turn events823### Turn events
678 824
679- `turn/started` - `{ turn }` with the turn id, empty `items`, and `status: "inProgress"`.825- `turn/started` - `{ turn }` with the turn id, empty `items`, and `status: "inProgress"`.
689`ThreadItem` is the tagged union carried in turn responses and `item/*` notifications. Common item types include:835`ThreadItem` is the tagged union carried in turn responses and `item/*` notifications. Common item types include:
690 836
691- `userMessage` - `{id, content}` where `content` is a list of user inputs (`text`, `image`, or `localImage`).837- `userMessage` - `{id, content}` where `content` is a list of user inputs (`text`, `image`, or `localImage`).
692838- `agentMessage` - `{id, text}` containing the accumulated agent reply.- `agentMessage` - `{id, text, phase?}` containing the accumulated agent reply. When present, `phase` uses Responses API wire values (`commentary`, `final_answer`).
693- `plan` - `{id, text}` containing proposed plan text in plan mode. Treat the final `plan` item from `item/completed` as authoritative.839- `plan` - `{id, text}` containing proposed plan text in plan mode. Treat the final `plan` item from `item/completed` as authoritative.
694- `reasoning` - `{id, summary, content}` where `summary` holds streamed reasoning summaries and `content` holds raw reasoning blocks.840- `reasoning` - `{id, summary, content}` where `summary` holds streamed reasoning summaries and `content` holds raw reasoning blocks.
695- `commandExecution` - `{id, command, cwd, status, commandActions, aggregatedOutput?, exitCode?, durationMs?}`.841- `commandExecution` - `{id, command, cwd, status, commandActions, aggregatedOutput?, exitCode?, durationMs?}`.
696- `fileChange` - `{id, changes, status}` describing proposed edits; `changes` list `{path, kind, diff}`.842- `fileChange` - `{id, changes, status}` describing proposed edits; `changes` list `{path, kind, diff}`.
697- `mcpToolCall` - `{id, server, tool, status, arguments, result?, error?}`.843- `mcpToolCall` - `{id, server, tool, status, arguments, result?, error?}`.
844- `dynamicToolCall` - `{id, tool, arguments, status, contentItems?, success?, durationMs?}` for client-executed dynamic tool invocations.
698- `collabToolCall` - `{id, tool, status, senderThreadId, receiverThreadId?, newThreadId?, prompt?, agentStatus?}`.845- `collabToolCall` - `{id, tool, status, senderThreadId, receiverThreadId?, newThreadId?, prompt?, agentStatus?}`.
699- `webSearch` - `{id, query, action?}` for web search requests issued by the agent.846- `webSearch` - `{id, query, action?}` for web search requests issued by the agent.
700- `imageView` - `{id, path}` emitted when the agent invokes the image viewer tool.847- `imageView` - `{id, path}` emitted when the agent invokes the image viewer tool.
751Order of messages:898Order of messages:
752 899
7531. `item/started` shows the pending `commandExecution` item with `command`, `cwd`, and other fields.9001. `item/started` shows the pending `commandExecution` item with `command`, `cwd`, and other fields.
7549012. `item/commandExecution/requestApproval` includes `itemId`, `threadId`, `turnId`, optional `reason`, optional `command`, optional `cwd`, optional `commandActions`, and optional `proposedExecpolicyAmendment`.2. `item/commandExecution/requestApproval` includes `itemId`, `threadId`, `turnId`, optional `reason`, optional `command`, optional `cwd`, optional `commandActions`, optional `proposedExecpolicyAmendment`, optional `networkApprovalContext`, and optional `availableDecisions`. When `initialize.params.capabilities.experimentalApi = true`, the payload can also include experimental `additionalPermissions` describing requested per-command sandbox access. Any filesystem paths inside `additionalPermissions` are absolute on the wire.
7553. Client responds with one of the command execution approval decisions above.9023. Client responds with one of the command execution approval decisions above.
7569034. `item/completed` returns the final `commandExecution` item with `status: completed | failed | declined`.4. `serverRequest/resolved` confirms that the pending request has been answered or cleared.
9045. `item/completed` returns the final `commandExecution` item with `status: completed | failed | declined`.
905
906When `networkApprovalContext` is present, the prompt is for managed network access (not a general shell-command approval). The current v2 schema exposes the target `host` and `protocol`; clients should render a network-specific prompt and not rely on `command` being a user-meaningful shell command preview.
907
908Codex groups concurrent network approval prompts by destination (`host`, protocol, and port). The app-server may therefore send one prompt that unblocks multiple queued requests to the same destination, while different ports on the same host are treated separately.
757 909
758### File change approvals910### File change approvals
759 911
7621. `item/started` emits a `fileChange` item with proposed `changes` and `status: "inProgress"`.9141. `item/started` emits a `fileChange` item with proposed `changes` and `status: "inProgress"`.
7632. `item/fileChange/requestApproval` includes `itemId`, `threadId`, `turnId`, optional `reason`, and optional `grantRoot`.9152. `item/fileChange/requestApproval` includes `itemId`, `threadId`, `turnId`, optional `reason`, and optional `grantRoot`.
7643. Client responds with one of the file change approval decisions above.9163. Client responds with one of the file change approval decisions above.
7659174. `item/completed` returns the final `fileChange` item with `status: completed | failed | declined`.4. `serverRequest/resolved` confirms that the pending request has been answered or cleared.
9185. `item/completed` returns the final `fileChange` item with `status: completed | failed | declined`.
919
920### `tool/requestUserInput`
921
922When the client responds to `item/tool/requestUserInput`, app-server emits `serverRequest/resolved` with `{ threadId, requestId }`. If the pending request is cleared by turn start, turn completion, or turn interruption before the client answers, the server emits the same notification for that cleanup.
923
924### Dynamic tool calls (experimental)
925
926`dynamicTools` on `thread/start` and the corresponding `item/tool/call` request or response flow are experimental APIs.
927
928When a dynamic tool is invoked during a turn, app-server emits:
929
9301. `item/started` with `item.type = "dynamicToolCall"`, `status = "inProgress"`, plus `tool` and `arguments`.
9312. `item/tool/call` as a server request to the client.
9323. The client response payload with returned content items.
9334. `item/completed` with `item.type = "dynamicToolCall"`, the final `status`, and any returned `contentItems` or `success` value.
766 934
767### MCP tool-call approvals (apps)935### MCP tool-call approvals (apps)
768 936
769937App (connector) tool calls can also require approval. When an app tool call has side effects, the server may elicit approval with `tool/requestUserInput` and options such as **Accept**, **Decline**, and **Cancel**. If the user declines or cancels, the related `mcpToolCall` item completes with an error instead of running the tool.App (connector) tool calls can also require approval. When an app tool call has side effects, the server may elicit approval with `tool/requestUserInput` and options such as **Accept**, **Decline**, and **Cancel**. Destructive tool annotations always trigger approval even when the tool also advertises less-privileged hints. If the user declines or cancels, the related `mcpToolCall` item completes with an error instead of running the tool.
770 938
771## Skills939## Skills
772 940
863 1031
864## Apps (connectors)1032## Apps (connectors)
865 1033
8661034Use `app/list` to fetch available apps. In the CLI/TUI, `/apps` is the user-facing picker; in custom clients, call `app/list` directly. Each entry includes both `isAccessible` (available to the user) and `isEnabled` (enabled in `config.toml`) so clients can distinguish install/access from local enabled state.Use `app/list` to fetch available apps. In the CLI/TUI, `/apps` is the user-facing picker; in custom clients, call `app/list` directly. Each entry includes both `isAccessible` (available to the user) and `isEnabled` (enabled in `config.toml`) so clients can distinguish install/access from local enabled state. App entries can also include optional `branding`, `appMetadata`, and `labels` fields.
867 1035
868```json1036```json
869{ "method": "app/list", "id": 50, "params": {1037{ "method": "app/list", "id": 50, "params": {
879 "name": "Demo App",1047 "name": "Demo App",
880 "description": "Example connector for documentation.",1048 "description": "Example connector for documentation.",
881 "logoUrl": "https://example.com/demo-app.png",1049 "logoUrl": "https://example.com/demo-app.png",
1050 "logoUrlDark": null,
1051 "distributionChannel": null,
1052 "branding": null,
1053 "appMetadata": null,
1054 "labels": null,
882 "installUrl": "https://chatgpt.com/apps/demo-app/demo-app",1055 "installUrl": "https://chatgpt.com/apps/demo-app/demo-app",
883 "isAccessible": true,1056 "isAccessible": true,
884 "isEnabled": true1057 "isEnabled": true
904 "name": "Demo App",1077 "name": "Demo App",
905 "description": "Example connector for documentation.",1078 "description": "Example connector for documentation.",
906 "logoUrl": "https://example.com/demo-app.png",1079 "logoUrl": "https://example.com/demo-app.png",
1080 "logoUrlDark": null,
1081 "distributionChannel": null,
1082 "branding": null,
1083 "appMetadata": null,
1084 "labels": null,
907 "installUrl": "https://chatgpt.com/apps/demo-app/demo-app",1085 "installUrl": "https://chatgpt.com/apps/demo-app/demo-app",
908 "isAccessible": true,1086 "isAccessible": true,
909 "isEnabled": true1087 "isEnabled": true
936}1114}
937```1115```
938 1116
1117### Config RPC examples for app settings
1118
1119Use `config/read`, `config/value/write`, and `config/batchWrite` to inspect or update app controls in `config.toml`.
1120
1121Read the effective app config shape (including `_default` and per-tool overrides):
1122
1123```json
1124{ "method": "config/read", "id": 60, "params": { "includeLayers": false } }
1125{ "id": 60, "result": {
1126 "config": {
1127 "apps": {
1128 "_default": {
1129 "enabled": true,
1130 "destructive_enabled": true,
1131 "open_world_enabled": true
1132 },
1133 "google_drive": {
1134 "enabled": true,
1135 "destructive_enabled": false,
1136 "default_tools_approval_mode": "prompt",
1137 "tools": {
1138 "files/delete": { "enabled": false, "approval_mode": "approve" }
1139 }
1140 }
1141 }
1142 }
1143} }
1144```
1145
1146Update a single app setting:
1147
1148```json
1149{
1150 "method": "config/value/write",
1151 "id": 61,
1152 "params": {
1153 "keyPath": "apps.google_drive.default_tools_approval_mode",
1154 "value": "prompt",
1155 "mergeStrategy": "replace"
1156 }
1157}
1158```
1159
1160Apply multiple app edits atomically:
1161
1162```json
1163{
1164 "method": "config/batchWrite",
1165 "id": 62,
1166 "params": {
1167 "edits": [
1168 {
1169 "keyPath": "apps._default.destructive_enabled",
1170 "value": false,
1171 "mergeStrategy": "upsert"
1172 },
1173 {
1174 "keyPath": "apps.google_drive.tools.files/delete.approval_mode",
1175 "value": "approve",
1176 "mergeStrategy": "upsert"
1177 }
1178 ]
1179 }
1180}
1181```
1182
1183### Detect and import external agent config
1184
1185Use `externalAgentConfig/detect` to discover external-agent artifacts that can be migrated, then pass the selected entries to `externalAgentConfig/import`.
1186
1187Detection example:
1188
1189```json
1190{ "method": "externalAgentConfig/detect", "id": 63, "params": {
1191 "includeHome": true,
1192 "cwds": ["/Users/me/project"]
1193} }
1194{ "id": 63, "result": {
1195 "items": [
1196 {
1197 "itemType": "AGENTS_MD",
1198 "description": "Import /Users/me/project/CLAUDE.md to /Users/me/project/AGENTS.md.",
1199 "cwd": "/Users/me/project"
1200 },
1201 {
1202 "itemType": "SKILLS",
1203 "description": "Copy skill folders from /Users/me/.claude/skills to /Users/me/.agents/skills.",
1204 "cwd": null
1205 }
1206 ]
1207} }
1208```
1209
1210Import example:
1211
1212```json
1213{ "method": "externalAgentConfig/import", "id": 64, "params": {
1214 "migrationItems": [
1215 {
1216 "itemType": "AGENTS_MD",
1217 "description": "Import /Users/me/project/CLAUDE.md to /Users/me/project/AGENTS.md.",
1218 "cwd": "/Users/me/project"
1219 }
1220 ]
1221} }
1222{ "id": 64, "result": {} }
1223```
1224
1225Supported `itemType` values are `AGENTS_MD`, `CONFIG`, `SKILLS`, and `MCP_SERVER_CONFIG`. Detection returns only items that still have work to do. For example, AGENTS migration is skipped when `AGENTS.md` already exists and is non-empty, and skill imports don’t overwrite existing skill directories.
1226
939## Auth endpoints1227## Auth endpoints
940 1228
941The JSON-RPC auth/account surface exposes request/response methods plus server-initiated notifications (no `id`). Use these to determine auth state, start or cancel logins, logout, and inspect ChatGPT rate limits.1229The JSON-RPC auth/account surface exposes request/response methods plus server-initiated notifications (no `id`). Use these to determine auth state, start or cancel logins, logout, and inspect ChatGPT rate limits.