Referencia de la API
Sistemas y políticas
Declarar tus sistemas (casos de uso) y leerlos, con las llamadas que salieron de aquello para lo que uno fue aprobado; leer los paquetes regulatorios y la política de datos que aplica el SDK.
Los resúmenes de las rutas y los nombres de los campos están en inglés, aquí y en el archivo.
/api/v1/usecases
GET /api/v1/usecases
The workspace's declared systems (use cases) and their flags
Autenticación
Clave API
Ámbito de la clave
usecases:readRespuestas
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_errorPOST /api/v1/usecases
Declare a system (use case)
Autenticación
Clave API
Ámbito de la clave
usecases:writeCuerpo
name (obligatorio) · description · purpose · legal_basis · data_categories · affected_population · ai_act_classification · automated_decision · provider · data_leaves_euRespuestas
201 · 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 · 503 service_unavailableGET /api/v1/usecases/{id}
One declared system (use case)
Autenticación
Clave API
Ámbito de la clave
usecases:readParámetros
id (obligatorio)Respuestas
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 404 not_found · 429 · 500 internal_error · 503 service_unavailablePATCH /api/v1/usecases/{id}
Always refused — a person reviews a use case, from the dashboard
Autenticación
Clave API
Ámbito de la clave
usecases:writeParámetros
id (obligatorio)Respuestas
GET /api/v1/usecases/{id}/divergences
The sealed calls that ran outside what a use case was approved for
Autenticación
Clave API
Ámbito de la clave
usecases:readParámetros
id (obligatorio)Respuestas
200 · 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/policy
GET /api/v1/policy/packs
The regulatory policy packs, or one pack in full
Autenticación
Clave API
Ámbito de la clave
policy:readMódulo
Disponible donde el despliegue ejecuta
FEATURE_POLICY_PACKS.Parámetros
idRespuestas
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed, plan_required · 404 not_found · 429 · 500 internal_error · 501 feature_disabled/api/v1/governance
GET /api/v1/governance/config
The workspace's data policy, as the SDK applies it in your process
Autenticación
Clave API
Ámbito de la clave
policy:readParámetros
connector · environmentRespuestas
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_error