Service API
Base path /service/v1 — API key required (st_live_*), rate-limited. This is the surface external apps (ActiveAura, audio/VST tooling, your own integrations) use to read projects and export knowledge. Keys are scoped to projects + permissions (read, write, export, webhook).
Endpoints
| Method | Path | Scope | Purpose |
|---|---|---|---|
| GET | /service/v1/ping | any | Health/connectivity check |
| GET | /service/v1/projects | read | List accessible projects |
| GET | /service/v1/projects/:id | read | Project metadata |
| GET | /service/v1/projects/:id/sources | read | Sources (paginated) |
| GET | /service/v1/projects/:id/export | export | Export in a requested format |
| POST | /service/v1/projects/:id/webhooks | webhook | Register a delivery endpoint |
Authentication
Send the key as a bearer token:
http
GET /service/v1/projects
Authorization: Bearer st_live_xxxxxxxxCreate and scope keys from Auth → API keys.
Export formats
GET /projects/:id/export returns the project's knowledge in the requested format (UKS, and downstream app formats). For standards bridges (JSON-LD, FHIR, Croissant), see Export.
→ Related: Authentication · Export · Registry API