API Errors
API errors should help clients distinguish missing auth, missing permission, invalid input, unavailable resources, and runtime failures.
How To Use This Page
- Check HTTP status before parsing a response body.
- Preserve visible error messages in support reports.
- Retry only when the error indicates temporary failure or async work still in progress.
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
- Table: common status codes, likely cause, and client action. It helps integrators handle failures correctly. Source: public API behavior and examples.