Base URL
All endpoints are served over HTTPS from:https://api.claap.io/v1/recordings.
Quickstart
1
Create an API key
A workspace admin creates the key in Claap, from Settings > API & Webhooks. The key gives access to the resources of that workspace. Private recordings are only visible if the key has Full access, which only workspace Owners can turn on. See Authentication.
2
Make your first request
Pass the key in the
X-Claap-Key header and check which workspace it belongs to:3
Fetch your recordings
List the recordings, then get a transcript from a recording The transcript response holds a download URL for the transcript JSON, valid for 24 hours.
id:Explore the API
Recordings
Meetings and videos, their metadata, transcripts and AI field values.
Deals
CRM deals with their stages, owners and activity. Updates are written back to your CRM.
Companies
Accounts linked to your recordings, emails and deals.
Contacts
People your team meets and emails.
Folders
Organize recordings into folders.
Workspace & users
Manage users, invites and user groups, and read workspace details.
Admin automations
Recording automations configured by workspace admins.
Webhooks
Get notified when recordings are added or updated.
Key concepts
Responses & errors
Response envelope and error format.
Quotas and limits
Rate limits and how to monitor them.
Recordings visibility
Which recordings an API key can access.
Views
Saved filters and columns, reusable to scope API listings.
AI fields
Custom values extracted by AI from recordings, deals and companies.
Admin automations
How automations are matched and ordered.
Conventions
- Authentication: every request carries an
X-Claap-Keyheader. Keys are scoped to a single workspace. - Responses: JSON payloads wrapped in a
resultobject on success, and anerrorobject with atypeand amessageon failure. - Pagination: paginated list endpoints accept a
limitand returnresult.pagination.nextCursor. Pass it ascursorto fetch the next page, and stop when nonextCursoris returned. Pages may hold fewer thanlimitresults. - Rate limits: 3 requests per second per endpoint and 3,000 requests per day, shared by all the keys of a workspace.
Need help?
Help Center
Guides and use cases for the Claap API.
Contact support
Questions or feedback about the API.
