Caret provides a comprehensive REST API that allows you to integrate meeting transcription, translation, and note-taking capabilities into your applications. This documentation will help you understand how to use the API to build powerful integrations with Caret.

​
Key Features

  • Meeting Notes: Create, retrieve, and manage meeting notes programmatically
  • Transcripts: Access detailed meeting transcripts and translations
  • Real-time Events: Receive real-time notifications through webhooks
  • Workspace Management: Programmatically manage workspace settings and users

​
Base URL

All API requests should be made to the following base URL:

https://api.caret.so/v1

​
Authentication

Caret uses API keys to authenticate requests. You can obtain an API key from your workspace settings.

All API requests must include your API key in the Authorization header:

Authorization: Bearer sk-caret-api-xxxxxxxxxxxxxxxxxxxx

For detailed authentication instructions, see the Authentication page.

​
Rate Limits

To ensure fair usage, Caret implements rate limiting on API requests. The limits vary based on your subscription plan:

PlanRequests per MinuteWebhooks per Minute
Free6020
Pro12040
Enterprise300100

Learn more about rate limits and how to handle them in the Rate Limits documentation.

​
Available Resources

​
Notes

Notes are the core resource of the Caret API. They represent meeting notes with associated metadata, transcripts, and summaries.

  • Get a list of notes
  • Create a new note
  • Retrieve a specific note
  • Update a note
  • Delete a note

For the complete structure of a Note, see the Note Model documentation.

​
Webhooks

Webhooks allow your application to receive real-time notifications about events in Caret.

  • Note created
  • Audio uploaded
  • And more

Learn how to set up and manage webhooks in the Webhooks documentation.

​
Error Handling

The Caret API uses HTTP response codes to indicate the success or failure of requests. For detailed information on error handling, see the Error Handling page.

​
Getting Started

To start using the Caret API:

  1. Create an API key in your workspace settings
  2. Explore the available endpoints and models in this documentation
  3. Set up webhooks to receive real-time events

For detailed examples, check out our Developer Resources section.