Skip to main content
The HTTP API lives under /api/v1. Most routes are workspace-scoped:
Use a browser session for operator and account-management workflows. Use a scoped gp_live_ bearer key for machine access where the route policy permits it.

Authentication

Session and bearer behavior, route scopes, errors, idempotency, and anti-enumeration.

Pagination and limits

Current collection behavior, query limits, job concurrency, and field caps.

​
Base request

​
Generated operations

The operation pages below this section are rendered from docs/openapi.json. That snapshot is produced by the running application’s OpenAPI route, so it must be refreshed when route contracts change.
The generation script fetches http://127.0.0.1:3000/api/v1/openapi.json by default. It is not an offline source generator. Set OPENAPI_URL when the app runs on another port.

​
Route stability

The generated schema describes request and response structures exposed by the current application. Authorization policy can still narrow what a session or API key may do. Check Authentication before integrating a generated operation.