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

# How do I connect Klipy to other tools?

> Get started with the Klipy REST API: authenticate requests, verify your key, understand rate limits, and follow best practices. Reference at api.klipy.ai.

The **Klipy API** is the HTTP interface for [Klipy](https://klipy.ai)—the CRM for owner-sellers running their own pipeline. Use it to read and write **people**, **companies**, and **interactions** from your own systems, the same records you manage in the app.

This page is the high-level **getting started** guide. For every path, parameter, and response shape, use the interactive **[API reference](https://klipy.ai/docs/api/v2/introduction.md)** and OpenAPI-backed endpoint pages.

> [!NOTE]
>
> Searching for **“Klipy API”** may surface unrelated products. This documentation applies only to **Klipy** (`klipy.ai`, `app.klipy.ai`, `api.klipy.ai`).

## Beta status

The Klipy API is in **open beta**. Until general availability:

* There is **no SLA** for uptime or latency during the beta.
* **Specifications and behavior can change**; treat the published OpenAPI spec and this site as the source of truth, not older third-party copies.
* **Test in a non-production workspace** before relying on the API in production workflows.
* Some operations may be **irreversible** at the data level (for example deletes); confirm behavior in the reference before you script destructive paths.

## Authentication

Every request must include a valid **API key**. Workspace **admins** create keys in the app.

**1. Create a key**

Follow **[Issuing API keys](https://klipy.ai/docs/api/v2/issuing-api-keys.md)**—open **[Settings → API](https://app.klipy.ai/settings/api)**, create a key with the **minimum scopes** your integration needs, and copy it once.

**2. Send the key on every request**

Use **one** of:

```http theme={null}
X-Klipy-Api-Key: klipy_api_<your_key_id>
```

```http theme={null}
Authorization: Bearer klipy_api_<your_key_id>
```

Keys use the `klipy_api_` prefix. Store them in a **secret manager** or environment variables—never commit keys to source control or expose them in client-side code.

## Base URL

Production:

```text theme={null}
https://api.klipy.ai/api/v1
```

Use **HTTPS** only.

## Verify your API key

Send a **GET** request to the authenticate endpoint:

```bash theme={null}
curl --request GET \
  --url https://api.klipy.ai/api/v1/authenticate \
  --header 'X-Klipy-Api-Key: klipy_api_<your_key_id>'
```

A successful response confirms the key and returns organization context (see **[Authenticate](https://klipy.ai/docs/api-reference/authentication/authenticate-api-key)**).

## Endpoint reference

The **[API reference](https://klipy.ai/docs/api/v2/introduction.md)** lists all operations with request and response schemas. Common entry points:

* **Validate access** — [Authenticate](https://klipy.ai/docs/api-reference/authentication/authenticate-api-key)
* **People** — query, create, update, and delete person records
* **Companies** — manage company records
* **Interactions** — read and create interaction activity

## Rate limits

Limits apply **per API key** and **per organization**:

| Limit | Value |
| - | -: |
| Per API key | 200 requests per minute |
| Per organization | 1000 requests per minute |

Successful responses include `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset`. When you exceed a limit, the API returns **429 Too Many Requests** with a `Retry-After` header.

Design clients to **back off** (for example exponential backoff) and to treat **429** as a normal transient condition.

## Scopes

Each key is issued with **scopes**. Every endpoint requires an appropriate scope; details appear on each operation in the API reference. If the key is missing, invalid, or not scoped for the operation, you receive **401** or **403** with a structured error body.

See **[Issuing API keys](https://klipy.ai/docs/api/v2/issuing-api-keys.md)** for the scope list and **[API reference introduction](https://klipy.ai/docs/api/v2/introduction.md)** for how scopes map to endpoints.

## Practices for stable integrations

* **Store keys in secrets** — Use a vault or your own secret manager; rotate on a schedule or when someone leaves the team.
* **Separate keys by environment** — Use different keys for development, staging, and production so a test script cannot touch production data.
* **Handle errors explicitly** — Parse **4xx** and **5xx** responses; do not assume every call returns **2xx**.
* **Respect rate limits** — Back off on **429**; avoid tight loops that retry without delay.
* **Monitor usage** — Track response codes and latency so you catch auth or quota issues early.

## Related topics

* **[What Klipy captures](https://klipy.ai/docs/guides/capture.md)** — How email and messaging signals become CRM intelligence in Klipy (product behavior, not the HTTP API).
* **[Issuing API keys](https://klipy.ai/docs/api/v2/issuing-api-keys.md)** — Create, scope, and revoke keys.
* **[API reference introduction](https://klipy.ai/docs/api/v2/introduction.md)** — Envelopes, pagination, and endpoint index.


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