API reference
Every operation in the Sparq API, generated from the published OpenAPI document.
This reference is generated from the same OpenAPI document the API is built from, so it always matches the contract (version 0.5.0). Operations that are defined but not built yet are marked Not available yet; see API status.
- Base URL:
https://api.sparqhq.ai, orhttp://127.0.0.1:8000for a local stack. - Authentication:
Authorization: Bearer <token>on every/v1operation. See authentication. - Errors: RFC 9457 problem details. See errors.
- Lists: cursor pagination. See pagination.
Runtime API
Called by your application at run time: identity, sessions, runs and features.
Admin API
Paths under /v1/admin: tenancy, compliance,
credentials, models,
observability, knowledge,
tools, changes, access
and safety.
Health
Liveness and readiness probes, with no authentication.
API status
Which operations work today, and which are defined in the contract but not built yet.
Create Grant POST
> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version. Nobody can grant a role with more actions than they hold.