Skip to content

HTTP API / Overview

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 answers 202 with 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> (audience keel-api) or X-Api-Key: keel_live_…. A person who belongs to several tenants selects one with X-Keel-Tenant.
  • Idempotency-Key is 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 ​

AreaOperations
System1
Identity23
Sign-in10
Onboarding5
SSO & SCIM9
Profile5
Sources11
Lineage6
Telemetry1
Support1
Discovery13
Review10
Modeling38
Exports11
Imports4
Quality27
Governance47
Jobs2
Audit6
Notifications13
Serving11
Assistant5
Agents8
Migrate50
Billing8
Tenant8
Operations26
Status4
Public1

Anchor Keel is a working product name: one platform, a shared core and licensed modules (Keel Semantic, Keel Migrate). Documentation built from the repository — facts are derived from code, ADRs and the decisions log.