Skip to main content

​
API Keys

Every API request must include a valid API key. Keys are created in your clarife dashboard and scoped to specific permissions.

​
Creating a Key

1

Open Settings

Go to Settings > API in your clarife dashboard at my.clarife.app.
2

Click 'Create API key'

Give the key a descriptive name (e.g. “n8n integration” or “CI pipeline”).
3

Select scopes

Choose which permissions the key should have. Follow the principle of least privilege — only grant what the integration actually needs.
4

Copy the key

Your key is displayed once. Copy it and store it securely. It starts with clrf_.
API keys are shown only at creation time. If you lose a key, revoke it and create a new one.

​
Key Format

All clarife API keys follow the format: 
clrf_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The clrf_ prefix makes keys easy to identify in logs and secret scanners.

​
Authenticating Requests

Include the key in the Authorization header as a Bearer token: 
curl https://my.clarife.app/api/v1/documents \
  -H "Authorization: Bearer clrf_your_key_here"

​
Workspace Context

For team workspaces, include the X-Workspace-Id header to specify which workspace the request targets: 
curl https://my.clarife.app/api/v1/documents \
  -H "Authorization: Bearer clrf_your_key_here" \
  -H "X-Workspace-Id: a1b2c3d4-5678-90ab-cdef-1234567890ab"
If you omit X-Workspace-Id, the request defaults to your personal workspace.

​
Scopes

Each API key can be granted one or more scopes. An endpoint returns 403 Forbidden if the key lacks the required scope.
ScopeDescription
documents:readList and read documents and their content
documents:writeCreate, update, and delete documents
projects:readList and read projects and folders
projects:writeCreate, update, and delete projects and folders
shares:readList and read share links and view stats
shares:writeCreate, update, and delete share links
brandings:readList and read branding configurations
media:writeUpload screenshots and media files
workspace:readRead workspace info and member list

​
Key Limits

PlanMax API Keys
Pro5
Business20
Attempting to create a key beyond your plan limit returns a 403 with code KEY_LIMIT_REACHED.

​
Revoking Keys

To revoke a key, go to Settings > API, find the key in the list, and click Revoke. The key stops working immediately. This action cannot be undone.
Rotate keys regularly. If a key may have been exposed, revoke it immediately and create a replacement.

​
Error Responses

StatusCodeMeaning
401UNAUTHORIZEDMissing or invalid API key
403FORBIDDENKey lacks the required scope
403PLAN_REQUIREDAPI access requires a Pro or Business plan
403KEY_LIMIT_REACHEDMaximum number of API keys for your plan