Tenant API reference
Authorize with a Tenant API key, cr_live_..., and choose your region under Servers. A key works only in the region that issued it.
First request
From an address on the key's allowlist, ask for one patient:
curl "https://api.clarirad.com/api/external/v1/patients?limit=1" \
-H "Authorization: Bearer cr_live_..."For a Chilean key, use https://api-cl.clarirad.com/api/external/v1. A list answers with a page of records, newest first:
{
"data": [ { "id": "...", "mrn": "...", ... } ],
"nextCursor": "eyJjIjoi..."
}limitis 1 to 100, 25 by default. PassnextCursorback ascursorfor the next page;nullmeans the end. Cursor pagination- A failed call answers with an
errorfield. Refusals of the key itself carry a message, such as{ "error": "API key has expired" }; other errors carry an object withmessage,codeand arequestIdto quote to support. - Send an
Idempotency-Keyheader on creates so a retry cannot make a second record. Idempotency keys - Add
?dry_run=trueto a create, an update or a cancel to check it without changing anything. Dry run
Try it out needs an allowed address
Calls go straight from your browser to the API, so they only work from an address on the key's allowlist, inside any API IP policy your tenant has. Attempts from anywhere else are refused and count against your address.
IP allowlist and API IP policyThese are live calls
Try it out works on your real data in the region you pick, and every call is audited against the key. Your key stays in this page and is forgotten when you leave it. Use a dry run to test a write.
Dry runSites confine most of a key's reach
A site-restricted key is confined to its sites for requests, appointments, results and forms. Patients are tenant-wide under every key.
Scopes and gated fieldsUsing it from Claude or OpenAI
The Clarirad MCP server runs on your machine and lets Claude, Cursor or an OpenAI agent use this API with one of your keys. A de-identified key keeps patient names and identifiers out of what the model sees.
Clarirad with Claude and OpenAI
Loading the API reference…