> ## Documentation Index
> Fetch the complete documentation index at: https://docs.claap.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Everything you need to start building with the Claap API

The Claap API gives you programmatic access to your workspace: meeting recordings and their transcripts, the deals, companies and contacts synced from your CRM, the views and AI fields built on top of them, and the workspace itself (users, invites, teams).

Use it to export conversation data to your warehouse, push AI insights to other tools, or automate workspace administration.

<Tip>
  Want to use Claap data from Claude, ChatGPT or Cursor? The [Claap MCP server](/mcp/setup) connects AI assistants to your workspace without writing any code.
</Tip>

# Base URL

All endpoints are served over HTTPS from:

```
https://api.claap.io
```

Endpoint paths are versioned, for instance `https://api.claap.io/v1/recordings`.

# Quickstart

<Steps>
  <Step title="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](/api-reference/authentication).
  </Step>

  <Step title="Make your first request">
    Pass the key in the `X-Claap-Key` header and check which workspace it belongs to:

    ```bash theme={null}
    curl https://api.claap.io/v1/workspaces/mine \
      -H "X-Claap-Key: cla_xxxxx"
    ```
  </Step>

  <Step title="Fetch your recordings">
    [List the recordings](/api-reference/endpoint/list_recordings), then [get a transcript](/api-reference/endpoint/get_recording_transcript) from a recording `id`:

    ```bash theme={null}
    curl "https://api.claap.io/v1/recordings?limit=10" \
      -H "X-Claap-Key: cla_xxxxx"

    curl https://api.claap.io/v1/recordings/{recordingId}/transcript \
      -H "X-Claap-Key: cla_xxxxx"
    ```

    The transcript response holds a download URL for the transcript JSON, valid for 24 hours.
  </Step>
</Steps>

# Explore the API

<CardGroup cols={2}>
  <Card title="Recordings" icon="video" href="/api-reference/endpoint/list_recordings">
    Meetings and videos, their metadata, transcripts and AI field values.
  </Card>

  <Card title="Deals" icon="handshake" href="/api-reference/endpoint/list_deals">
    CRM deals with their stages, owners and activity. Updates are written back to your CRM.
  </Card>

  <Card title="Companies" icon="building" href="/api-reference/endpoint/list_companies">
    Accounts linked to your recordings, emails and deals.
  </Card>

  <Card title="Contacts" icon="address-book" href="/api-reference/endpoint/list_contacts">
    People your team meets and emails.
  </Card>

  <Card title="Folders" icon="folder" href="/api-reference/endpoint/get_folder">
    Organize recordings into folders.
  </Card>

  <Card title="Workspace & users" icon="users" href="/api-reference/endpoint/list_users">
    Manage users, invites and user groups, and read workspace details.
  </Card>

  <Card title="Admin automations" icon="robot" href="/api-reference/endpoint/list_admin_automations">
    Recording automations configured by workspace admins.
  </Card>

  <Card title="Webhooks" icon="bolt" href="/api-reference/webhooks">
    Get notified when recordings are added or updated.
  </Card>
</CardGroup>

# Key concepts

<CardGroup cols={3}>
  <Card title="Responses & errors" icon="code" href="/api-reference/errors">
    Response envelope and error format.
  </Card>

  <Card title="Quotas and limits" icon="gauge" href="/api-reference/rate_limiting">
    Rate limits and how to monitor them.
  </Card>

  <Card title="Recordings visibility" icon="eye" href="/api-reference/recordings">
    Which recordings an API key can access.
  </Card>

  <Card title="Views" icon="table" href="/api-reference/views">
    Saved filters and columns, reusable to scope API listings.
  </Card>

  <Card title="AI fields" icon="wand-magic-sparkles" href="/api-reference/ai_fields">
    Custom values extracted by AI from recordings, deals and companies.
  </Card>

  <Card title="Admin automations" icon="gears" href="/api-reference/automations">
    How automations are matched and ordered.
  </Card>
</CardGroup>

# Conventions

* **Authentication**: every request carries an `X-Claap-Key` header. Keys are scoped to a single workspace.
* **Responses**: JSON payloads wrapped in a `result` object on success, and an `error` object with a `type` and a `message` on failure.
* **Pagination**: paginated list endpoints accept a `limit` and return `result.pagination.nextCursor`. Pass it as `cursor` to fetch the next page, and stop when no `nextCursor` is returned. Pages may hold fewer than `limit` results.
* **Rate limits**: 3 requests per second per endpoint and 3,000 requests per day, shared by all the keys of a workspace.

# Need help?

<CardGroup cols={2}>
  <Card title="Help Center" icon="book-open" href="https://help.claap.io/en/articles/11833785-using-claap-s-api">
    Guides and use cases for the Claap API.
  </Card>

  <Card title="Contact support" icon="envelope" href="mailto:support@claap.io">
    Questions or feedback about the API.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.