Authentication

Caret uses API keys to authenticate requests. Manage your keys in the Developer Settings page in your app.

Creating API Keys

Access Settings

Go to the Developer Settings section in your Caret workspace.

Generate Key

Click Create New API Key and give it a descriptive name.

Assign Scopes

Select specific permissions. We recommend following the principle of least privilege.

Store Securely

Copy your key immediately. For security, it will not be shown again.

Your API keys carry significant privileges. Never share them in public repositories or client-side code.

Send your API key in the Authorization header using the Bearer scheme: Authorization: Bearer <API_KEY>.

curl -X GET "https://api.caret.so/v1/me" \
 -H "Authorization: Bearer your_api_key_here"

const response = await fetch('https://api.caret.so/v1/me', {
  headers: {
    Authorization: 'Bearer your_api_key_here',
  },
});

Define the access level for each key by selecting these permissions:

Scope	Description
`users`	Read user info and manage workspace invites.
`notes`	Read and write meeting notes and summaries.
`folders`	Create, update, and delete workspace folders.
`templates`	Manage meeting templates and AI configurations.

401 Unauthorized: Key is missing, invalid, or revoked.
403 Forbidden: Key is valid but lacks required permissions for the endpoint.

⌘I