Interactive XO Cowork API Reference

Explore a curated read-only contract and send requests directly to your own Cowork workspace.

The XO Cowork API controls one trusted workspace. It can inspect files, run agents, change configuration, and manage credentials. This explorer therefore starts with an allowlisted, read-only surface instead of exposing every internal FastAPI route.

Requests are sent to the selected real workspace, not a sandbox. The interactive buttons are off until you explicitly enable them. Never paste an XO API key, model-provider key, gateway token, poll token, or connector token into the workspace authorization control.

Curated read-only APINo request proxyAuth is not saved

Connect your workspace

Requests go directly from this browser to the URL below. Start with GET /, then inspect runtime status before reading workspace data.

Connection and auth guide

Enable “Test Request” for this real workspaceI understand responses may contain local paths, agent names, session titles, messages, and usage data. Only the allowlisted GET operations below are included.

Active target: http://127.0.0.1:5002Live requests: disabled

Loading the API explorer…

Why the explorer is intentionally smaller

The service's generated OpenAPI document varies with the active agent and currently includes internal, legacy, sensitive, and destructive operations. It also omits request-body schemas and examples for several raw-request handlers. The contract above is curated for reliable experimentation: service identity, runtime readiness, workspace discovery, agents, sessions, messages, and usage.

Use the prose guides for behavior that should not have a general-purpose “Try it” button:

Chat API — starts real agents and streams SSE.
Files API — reads and changes workspace files.
Secrets API — handles credential material.
Connectors API — performs OAuth and token flows.
Frontend Integration — production client patterns.