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

# Quickstart

> Make your first Rings API call in under 5 minutes

## 1. Get an API key

Sign in to [Rings](https://joinrings.com) and generate an API key from your workspace settings. Treat this key like a password — never commit it to source control.

## 2. Set the base URL

All requests go to:

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

## 3. Authenticate

Pass your API key in the `x-api-key` header on every request:

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

A successful response returns the authenticated user:

```json theme={null}
{
  "uuid": "....",
  "email": "you@example.com",
  "name": "Your Name"
}
```

## 4. List some persons

```bash theme={null}
curl "https://production-api.joinrings.com/v1/persons?limit=10" \
  -H "x-api-key: $RINGS_API_KEY"
```

## 5. Look up a person by email

```bash theme={null}
curl "https://production-api.joinrings.com/v1/persons/lookup?email=someone@example.com" \
  -H "x-api-key: $RINGS_API_KEY"
```

## Next steps

<CardGroup cols={2}>
  <Card title="Full API Reference" icon="code" href="/api-reference/introduction">
    Every endpoint, request, and response schema.
  </Card>

  <Card title="Connect via MCP" icon="plug" href="/guides/mcp">
    Give Claude, Cursor, and other AI tools access to Rings.
  </Card>
</CardGroup>