Back to docs

SDK quickstart

Instrument an agent in a few minutes.

Prerequisites

Compliade account, a registered agent, an API key with ingest scope.

Five lines

Install @compliade/sdk, create the client with gatewayUrl, apiKey, agentId and provenance (modelId + modelVersion).

Call client.log({ action, targetResource }). Missing provenance / occurredAt → 400 provenance_required.

Verify

Open the audit log: the event should appear with outcome allowed (or denied / pending per policy).

Never send cleartext PII — hash identifiers.

Technical MDX documentation (architecture, detailed API) — coming soon.

SDK quickstart · Compliade