API Design
The API is organized around workspace-owned resources and typed route groups.
How To Use This Page
- Prefer workspace-scoped routes for resources that belong to a workspace.
- Use artifact, blob, link, event, and operation routes to keep work connected to the graph.
- Return structured errors that clients can show or retry safely.
Developer Checklist
- Confirm the workspace, artifact, bot, server, or operation reference comes from a prior response or visible product route.
- Check authentication and role requirements before sending a request.
- Use response data to drive the next call instead of reconstructing identifiers from display text.
- Preserve visible error details when debugging.
Media To Add
- Diagram: route group to domain object mapping for workspace, artifact, blob, link, event, bot, and operation APIs. It helps developers choose routes. Source: public API groups.