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

# Overview

> The Rings AI REST API

The Rings AI API exposes tenant data — people, companies, opportunities, notes, tasks, meetings, and relationship intelligence — over a REST interface.

## Base URL

```text theme={null}
https://production-api.joinrings.com
```

## Authentication

All requests require an API key in the `x-api-key` header. Keys start with the `pk_` prefix and are scoped to a single tenant.

```bash theme={null}
curl https://production-api.joinrings.com/v1/me \
  -H "x-api-key: pk_your_api_key_here"
```

See the [Quickstart](/quickstart) for a walkthrough.

## Per-user context

Tenant-scoped keys accept an optional `x-rings-user-id` header. User-scoped keys are permanently bound to a single user.

## Rate limiting

Both per-second and monthly limits apply. All responses include `X-RateLimit-*` headers; `429` responses include a `Retry-After` header.

## Request correlation

Every response includes an `X-Request-Id` header. Forward your own request ID by setting the same header on the request.