API Reference
The API reference contains route-level details for public API groups.
How To Use This Page
- Use this area after choosing a route from an overview or group page.
- Check method, path parameters, authentication, request body, and response schema.
- Return to group pages for workflow context and examples.
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
- Screenshot: API reference navigation with one route expanded. It helps developers learn where exact fields are documented. Source: docs API reference.