OpenAPI
The OpenAPI reference provides exact route, request, response, and schema details for public integration work.
How To Use This Page
- Use overview pages to choose the right route group.
- Use OpenAPI pages for exact fields and response shapes.
- Check authentication requirements before implementing a client call.
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: OpenAPI route page with method, path, parameters, and response schema labeled. It helps developers navigate the reference. Source: docs API reference page.