Appearance
API reference
Anchor Keel API 1.0 · 364 operations, generated from the approved contract (tests/Keel.Api.ContractTests/Snapshots/openapi-v1.approved.json, the same document the API serves at /openapi/v1.json). A running non-production API also serves an interactive Scalar UI at /docs.
Conventions
- Base path
/api/v1; workspace resources live under/api/v1/workspaces/{workspaceId}/…. The tenant comes from the token, never the URL. - JSON in camelCase, enums as strings. Lists return
Page<T>(items, page, pageSize, totalCount, hasNext, page size ≤ 200) or a cursor for audit and inbox feeds. - Actions are
POST …/{id}:verb(for example:scan,:accept,:merge). Long work answers202with a job id; follow it at/api/v1/jobs/{jobId}or its Server-Sent Events stream/api/v1/jobs/{jobId}/events. - Authentication:
Authorization: Bearer <OIDC access token>(audiencekeel-api) orX-Api-Key: keel_live_…. A person who belongs to several tenants selects one withX-Keel-Tenant. Idempotency-Keyis honoured on create commands. Optional JSON bodies must still be sent as{}.- Errors are RFC 9457 Problem Details with a stable
code: see error codes.
Areas
| Area | Operations |
|---|---|
| System | 1 |
| Identity | 23 |
| Sign-in | 10 |
| Onboarding | 5 |
| SSO & SCIM | 9 |
| Profile | 5 |
| Sources | 11 |
| Lineage | 6 |
| Telemetry | 1 |
| Support | 1 |
| Discovery | 13 |
| Review | 10 |
| Modeling | 38 |
| Exports | 11 |
| Imports | 4 |
| Quality | 27 |
| Governance | 47 |
| Jobs | 2 |
| Audit | 6 |
| Notifications | 13 |
| Serving | 11 |
| Assistant | 5 |
| Agents | 8 |
| Migrate | 50 |
| Billing | 8 |
| Tenant | 8 |
| Operations | 26 |
| Status | 4 |
| Public | 1 |