Start free →

API reference

Systems and policies

Declare your systems (use cases) and read them, with the calls that ran outside what one was approved for; read the regulatory policy packs and the data policy the SDK applies.

All of the API reference

Route summaries and field names are written in English, here and in the file.

/api/v1/usecases

GET /api/v1/usecases

The workspace's declared systems (use cases) and their flags

Authentication
API key
Key scope
usecases:read

POST /api/v1/usecases

Declare a system (use case)

Authentication
API key
Key scope
usecases:write
Body
name (required) · description · purpose · legal_basis · data_categories · affected_population · ai_act_classification · automated_decision · provider · data_leaves_eu

GET /api/v1/usecases/{id}

One declared system (use case)

Authentication
API key
Key scope
usecases:read
Parameters
id (required)

PATCH /api/v1/usecases/{id}

Always refused — a person reviews a use case, from the dashboard

Authentication
API key
Key scope
usecases:write
Parameters
id (required)

GET /api/v1/usecases/{id}/divergences

The sealed calls that ran outside what a use case was approved for

Authentication
API key
Key scope
usecases:read
Parameters
id (required)

/api/v1/policy

GET /api/v1/policy/packs

The regulatory policy packs, or one pack in full

Authentication
API key
Key scope
policy:read
Module
Served where the deployment runs FEATURE_POLICY_PACKS.
Parameters
id

/api/v1/governance

GET /api/v1/governance/config

The workspace's data policy, as the SDK applies it in your process

Authentication
API key
Key scope
policy:read
Parameters
connector · environment