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

# Getting Started

The Nexor API is lead-centric. You create and manage leads, assign them to AI agents, track their conversions, and send them messages across channels, all powered by AI agents for calls, messaging, and multi-channel outreach.

## Base URL

| Environment    | URL                                  |
| -------------- | ------------------------------------ |
| **Production** | `https://api.getnexor.ai/api/public` |

Every request authenticates with the `X-API-Key` header. See [Authentication](/docs/en/api/authentication) for how to get and manage your key.

## Quick Start

### 1. Get your API key

Your key lives in the Nexor dashboard under Settings, then Integrations. See [Authentication](/docs/en/api/authentication) for the full steps. Keys are prefixed with `nxr_live_`.

### 2. Create a lead

```bash theme={null}
curl -X POST https://api.getnexor.ai/api/public/leads \
  -H "Content-Type: application/json" \
  -H "X-API-Key: nxr_live_your_api_key" \
  -d '{
    "first_name": "Tony",
    "last_name": "Stark",
    "email": "tony.stark@gmail.com",
    "phone": "+1234567890",
    "workflow_id": "your-workflow-uuid"
  }'
```

The lead will automatically be enrolled in the agent's cadence sequence and start receiving AI-powered outreach.

## What you can do

* **Create and manage leads.** Add leads individually or in bulk, update their information, and store custom metadata.
* **Assign agents.** Enroll leads into automated AI-powered outreach agents with multi-channel cadences.
* **Track conversions.** Record business outcomes like reservations and closed sales with custom field metadata.
* **Send messages.** Send WhatsApp messages (text or template), emails, or trigger AI phone calls to any lead.

## Rate Limits

The public API is rate-limited to **100 requests per minute** per API key. Requests that exceed this limit return a `429 Too Many Requests` response. If you hit the limit, wait until the next minute window to retry.

## OpenAPI Specification

The full OpenAPI specification is available at [`/openapi.json`](/openapi.json) for use with API clients and code generators.