API Guides

This section contains public API usage guides and the OpenAPI entry point.

The source of truth for the machine-readable API contract remains the existing OpenAPI document generated by the API server. Future docs-site work should consume that artifact instead of replacing OpenAPI generation.

Start here:

• API Surface: grouped route inventory from the API server.
• Chat Streaming API: Server-Sent Events for embedded chat.
• Account and Workspaces: account discovery, workspace lifecycle, members, and invitations.
• Agents and Teams: agent lifecycle, catalog, policies, memberships, and teams.
• Projects and Context: projects, members, and project/thread context.
• Data and Memory: documents, artifacts, collections, and memory.
• Integrations and Realtime: integration installation/OAuth and websocket surfaces.
• Operations: tasks, workflow runs, recurring work, and scorecards.
• Errors: structured error categories and handling guidance.
• OpenAPI: where to get the generated API schema and Swagger UI.