Documentation
Connect your own systems, MCP servers and AI agents to Clarirad with the tenant API. Start with a key, then work from the reference.
- Keys belong to your organisation and carry only what you grant them
- Each key works only from the addresses you list
- Keys expire after 90, 120 or 320 days
Esta documentación está disponible solo en inglés por ahora.
Getting Started
- Accepting the termsA tenant accepts the PHI and data-processing terms once, before anyone can issue a key.
- Issuing a keyName it, grant it scopes, list its addresses and choose an expiry of 90, 120 or 320 days.
- IP allowlist and API IP policyEach key lists its own addresses, and a tenant-wide policy can bound them all.
- Scopes and gated fieldsWhat each scope allows, which fields stay hidden without an opt-in scope, and how sites confine a key.
- Rate limits and the daily capA per-minute limit on each key and a daily cap shared across the tenant's keys.
- Idempotency keysSend an Idempotency-Key on a create so a retry cannot make a second record.
- Dry runAdd dry_run=true to check that a write is valid and permitted without changing anything.
- Cursor paginationList endpoints return newest first, one page at a time, with a cursor to the next page.