> ## 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.

# Introduction

> Overview of the Caret Public API

The Caret Public API allows you to programmatically interact with your workspace data, including meetings, summaries, and team members. Our API is built on REST principles and returns JSON responses.

## Base URL

All requests should be made to:

```bash theme={null}
https://api.caret.so/v1
```

## Key Features

<CardGroup cols={2}>
  <Card title="Authentication" icon="key">
    Secure requests using API keys managed in your developer settings.
  </Card>

  <Card title="Granular Scopes" icon="shield-check">
    Control access with specific permissions for meetings, folders, and users.
  </Card>

  <Card title="Rate Limiting" icon="gauge">
    Limits designed to support both small teams and large-scale integrations.
  </Card>

  <Card title="Webhooks" icon="webhook">
    Receive real-time notifications for meeting completions and data updates.
  </Card>
</CardGroup>

## Getting Started

<Steps>
  <Step title="Create API Key">
    Go to **Developer Settings** in your dashboard and generate a new key.
  </Step>

  <Step title="Configure Scopes">
    Select the necessary permissions for your integration (e.g., `notes:read`).
  </Step>

  <Step title="Authenticate">
    Send your key in the `Authorization` header as `Bearer <API_KEY>` on every request.
  </Step>
</Steps>

## Rate Limits

To ensure platform stability, we enforce workspace-level limits:

* **100 requests/min** for standard endpoints.
* **20 requests/min** for heavy operations (e.g., bulk exports).

Exceeding these limits returns a `429 Too Many Requests` error.

## Support

* **Reference**: Browse the [API Reference](/api-reference/workspace/get-workspace) for endpoint details.
* **Email**: Reach out at [support@caret.so](mailto:support@caret.so).