Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.caret.so/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Creating API Keys

1

Access Settings

Go to the Developer Settings section in your Caret workspace.
2

Generate Key

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

Assign Scopes

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

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.

​
Usage

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"

​
Scopes

Define the access level for each key by selecting these permissions:
ScopeDescription
usersRead user info and manage workspace invites.
notesRead and write meeting notes and summaries.
foldersCreate, update, and delete workspace folders.
templatesManage meeting templates and AI configurations.

​
Best Practices

  • One Key Per Service: Use separate keys for different environments.
  • Rotate Regularly: Regenerate keys periodically to minimize leak impact.
  • Environment Variables: Never hardcode keys in your source files.

​
Errors

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