API Surface Boundaries
Public API pages describe integration surfaces intended for customers and clients. Private operational routes are not part of the public contract.
How To Use This Page
- Build integrations against public route groups and OpenAPI reference pages.
- Do not depend on routes that are not documented as public integration surfaces.
- Ask for a public route or webhook when a workflow needs stable external access.
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: public app/API/client surfaces separated from private provider and callback handling. It helps developers avoid depending on implementation details. Source: public API groups and webhook docs.