# Discover

> Discover matching people from keywords and location.

- **Endpoint:** `POST https://api.nyne.ai/person/discover`
- **Group:** Person APIs (https://api.nyne.ai/documentation/person.md)
- **Auth:** `X-API-Key` + `X-API-Secret` headers
- **Mode:** Asynchronous - submit returns a `request_id` (normally with `202 Accepted`); poll `GET /person/discover?request_id=<request_id>` with the same auth headers until the endpoint reports a terminal response. Where supported, a `callback_url` can notify you when queued work finishes; follow this endpoint's retrieval notes.
- **HTML version:** https://api.nyne.ai/documentation/person/discover

Keyword-based people discovery - finds and enriches people matching a keyword query, optionally narrowed by location. Returns names, bios, social profiles, photos, and contact data. `keywords` is required (3-500 chars); `max_results` defaults to 50 and is clamped to 1-100. The request is queued and returns a `request_id`; poll the status endpoint or supply a `callback_url`.

## Authentication

All `/person/*` and `/company/*` endpoints authenticate with an API key and secret sent as HTTP headers on every request: `X-API-Key` and `X-API-Secret`. Create keys from your Nyne.ai dashboard and keep the secret server-side. Rate limits: 100 requests/minute, 1,000 requests/hour. Full guide: https://api.nyne.ai/documentation/authentication.md

## Parameters

| Name | Type | Required | Description | Example |
| --- | --- | --- | --- | --- |
| `keywords` | string | **yes** | Search keywords. Required, 3-500 characters. Deduplicates to the same job for identical keyword sets. | "growth marketing fintech" |
| `location` | string | no | Optional location filter. | "New York, NY" |
| `max_results` | integer | no | Max profiles to return. Default 50, clamped to 1-100. | 50 |
| `callback_url` | string | no | If set, the completed result is POSTed here when the job finishes. Must be a valid HTTP(S) URL on an allowed host when a callback allow-list is configured. | "https://hooks.example.com/result" |

## Polling for the result

A newly queued submit normally returns `202 Accepted` with a `request_id`. Poll the same path until `status` is `completed` (results stay available afterwards). Where supported, pass a `callback_url` on the submit to receive a webhook when queued work finishes; keep the documented GET as a recovery and retrieval path:

```bash
curl "https://api.nyne.ai/person/discover?request_id=<request_id>" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"
```

## Credit usage

| Item | Credits | Condition |
| --- | --- | --- |
| Discovery | - | Charged as profiles are discovered |
| Enrichment | - | Additional - only charged when contact details are actually found |
| No results | 0 | Empty results never burn credits |

## Responses

| Code | Meaning |
| --- | --- |
| `200` | Status poll result - returns the current request status and result/error fields when available |
| `202` | Request queued - poll the status endpoint (or wait for the callback) with the returned request_id |
| `400` | Malformed JSON, missing required parameters, or an invalid field |
| `401` | Missing or invalid API credentials |
| `402` | insufficient_credits - not enough credits to complete the request |
| `403` | subscription_required or ip_not_allowed |
| `404` | request_not_found - no matching request is available for this API key |
| `429` | rate_limit_exceeded |
| `503` | service_unavailable - the API is temporarily unavailable |

## Example request

### cURL

```bash
curl -X POST https://api.nyne.ai/person/discover \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "keywords": "growth marketing fintech",
    "location": "New York, NY",
    "max_results": 50
  }'
```

### Python

```python
import requests

resp = requests.post(
    "https://api.nyne.ai/person/discover",
    headers={
        "X-API-Key": "YOUR_API_KEY",
        "X-API-Secret": "YOUR_API_SECRET",
    },
    json={
        "keywords": "growth marketing fintech",
        "location": "New York, NY",
        "max_results": 50,
    },
)
data = resp.json()
print(data)
```

### Node

```javascript
const resp = await fetch("https://api.nyne.ai/person/discover", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "X-API-Secret": "YOUR_API_SECRET",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    keywords: "growth marketing fintech",
    location: "New York, NY",
    max_results: 50,
  }),
});
const data = await resp.json();
console.log(data);
```

### PHP

```php
<?php
$ch = curl_init("https://api.nyne.ai/person/discover");
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "X-API-Key: YOUR_API_KEY",
    "X-API-Secret: YOUR_API_SECRET",
    "Content-Type: application/json",
  ],
  CURLOPT_POSTFIELDS => json_encode([
    "keywords" => "growth marketing fintech",
    "location" => "New York, NY",
    "max_results" => 50,
  ]),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);
```

## Example response

```json
{
  "request_id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4_1717000000_4271",
  "status": "completed",
  "completed": true,
  "result": [
    {
      "displayname": "Jane Doe",
      "bio": "Growth marketing lead in fintech, focused on B2B SaaS.",
      "location": "New York, NY",
      "altemails": [
        "jane.doe@acme.com"
      ],
      "fullphone": [
        "+1-555-123-4567"
      ],
      "social_profiles": {
        "linkedin": {
          "url": "https://linkedin.com/in/janedoe",
          "photo_url": "https://cdn.example.com/photo.jpg"
        }
      },
      "company": "Acme",
      "work_history": [
        {
          "title": "Growth Marketing Lead",
          "company": "Acme",
          "start_date": "2023-04"
        }
      ]
    }
  ],
  "completed_on": "2026-01-15T10:35:00Z"
}
```

---

All documentation pages are available as Markdown by appending `.md` to their URL. Index: https://api.nyne.ai/llms.txt