# Quick Start

> Go from zero to a full, enriched person profile in three steps — create an API key, call the endpoint, and poll for the result. The whole round trip usually takes under a second.

HTML version: https://api.nyne.ai/documentation/quickstart

## 1. Create an API key

Sign in and open API keys in your dashboard, then click **Create key**. You'll get a key and a secret — copy the secret now, it's shown only once:

```
API Key:     nyne_live_7f3a9c2e8b1d4f6048a5e1c9
API Secret:  nyne_sec_3b9f1a7d5c2e8064f1a9b3d7e0c4
```

**Keep the secret server-side.** Send `X-API-Key` and `X-API-Secret` on every request, and call the API from your backend — never ship the secret to the browser. Rate limits: 100/min, 1,000/hour. See the [Authentication guide](https://api.nyne.ai/documentation/authentication.md) for more.

## 2. Call the endpoint

Submit one or more identifiers — here, an email plus a couple of social sources to pull — to `POST /person/enrichment`:

```bash
curl -X POST https://api.nyne.ai/person/enrichment \
  -H "X-API-Key: nyne_live_7f3a9c2e8b1d4f6048a5e1c9" \
  -H "X-API-Secret: nyne_sec_3b9f1a7d5c2e8064f1a9b3d7e0c4" \
  -H "Content-Type: application/json" \
  -d '{ "email": "jane.doe@acme.com", "newsfeed": ["linkedin", "github"] }'
```

The call returns `202 Accepted` right away with a `request_id` — hold onto it for the next step:

```json
{
  "request_id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4_1717000000_4271",
  "status": "queued"
}
```

## 3. Poll for the result

Poll the same path with the `request_id` until `status` is `completed`:

```bash
curl "https://api.nyne.ai/person/enrichment?request_id=a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4_1717000000_4271" \
  -H "X-API-Key: nyne_live_7f3a9c2e8b1d4f6048a5e1c9" \
  -H "X-API-Secret: nyne_sec_3b9f1a7d5c2e8064f1a9b3d7e0c4"
```

Enrichment typically finishes in well under a second, so your first poll often already returns the completed result. Poll roughly once a second until `status` is `completed` — or pass a `callback_url` on the submit to get the result by webhook and skip polling entirely.

When it's done, you get back a merged, sanitized profile — name and headline, location, business and alternate emails, phones, social profiles with follower counts, and a full work history:

```json
{
  "request_id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4_1717000000_4271",
  "status": "completed",
  "completed": true,
  "result": {
    "displayname": "Jane Doe",
    "firstname": "Jane",
    "lastname": "Doe",
    "headline": "VP of Product at Acme",
    "location": "San Francisco, CA",
    "best_business_email": "jane.doe@acme.com",
    "altemails": ["jane.doe@acme.com", "jane@example.com"],
    "fullphone": [{ "fullphone": "+1-555-123-4567", "phone_type": "mobile" }],
    "social_profiles": {
      "linkedin": { "url": "https://linkedin.com/in/janedoe", "followers": 2847 },
      "twitter": { "url": "https://x.com/janedoe", "followers": 1234 }
    },
    "organizations": [
      { "name": "Acme", "title": "VP of Product", "is_current": true },
      { "name": "StartupXYZ", "title": "Product Manager", "is_current": false }
    ],
    "total_experience_years": 12
  },
  "completed_on": "2026-01-15T10:35:00Z"
}
```

**You only pay for results.** Credits are charged only on a meaningful match. Empty results never burn credits.

## What's next

- [Person Enrichment](https://api.nyne.ai/documentation/person/enrichment.md) — every parameter, response code, and field in the profile you just saw.
- [Person Search](https://api.nyne.ai/documentation/person/search.md) — find people by natural-language query instead of a known identifier.
- [Authentication](https://api.nyne.ai/documentation/authentication.md) — the full guide to keys, secrets, and rate limits.
- [MCP Quick Start](https://api.nyne.ai/documentation/mcp/quickstart.md) — wire Nyne into Claude, ChatGPT, Cursor, and other AI clients.