API Examples
API examples show common request patterns for listing workspaces, reading artifacts, creating artifacts, reading blobs, searching, and starting bot work.
How To Use This Page
- Replace placeholder workspace and artifact references with values returned by earlier calls.
- Use the group page to find the route, then the OpenAPI reference for exact schema.
- Keep examples small enough to adapt quickly.
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
- Code walkthrough: list workspaces, list artifacts, open one artifact, read events, and run search. It helps developers complete a first integration. Source: public API routes and sample workspace.