API reference
Service and account
Check that the service is up, see which modules are production-grade, export the workspace’s data, and read or erase your own account.
Route summaries and field names are written in English, here and in the file.
/api/health
GET /api/health
Health check, for uptime monitors
Authentication
None: public
Answers
200 · 429 · 503/api/v1/system
GET /api/v1/system/modules
Which modules are production-grade, beta or experimental
Authentication
API key
Key scope
usage:readParameters
maturityAnswers
200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_error/api/v1/export
GET /api/v1/export
The workspace's data, for portability (GDPR art. 20)
Authentication
API key
Key scope
journal:readParameters
format · tables · offset · limitAnswers
200 · 401 api_key_missing, api_key_invalid · 403 api_key_role_denied, api_key_scope_denied, ip_not_allowed · 429 · 500 internal_error · 503 service_unavailable/api/v1/me
GET /api/v1/me
Your personal data (GDPR art. 15) — signed in, never an API key
Authentication
Signed-in session (the dashboard)
Parameters
cursorAnswers
200 · 400 validation_failed · 401 session_required, session_expired, mfa_challenge_required · 429 · 500 internal_error · 503 service_unavailableDELETE /api/v1/me
Erase your account (GDPR art. 17) — signed in, never an API key
Authentication
Signed-in session (the dashboard)
Answers
200 · 401 session_required, session_expired, mfa_challenge_required · 409 legal_hold_active · 429 · 500 internal_error · 502 billing_cancel_failed · 503 billing_cancel_failed, service_unavailable