Developer API

Lynx Search API

Integrate face search and identity lookup into your applications with our powerful REST API.

Manage API Keys

Create API Key

Create an API key above to get a token starting with lynx_sk_.

Make a search request

bash

# Text Search (Free)
curl -X POST https://lynxsearch.club/api/v1/search/text \
  -H "Authorization: Bearer lynx_sk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"query": "John Smith"}'

# Face Search (3 credits)
curl -X POST https://lynxsearch.club/api/v1/search/face \
  -H "Authorization: Bearer lynx_sk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"image_url": "https://example.com/photo.jpg"}'

Get results

Text search returns results synchronously. Face search returns a search_id for polling.

bash

# Poll face search results
curl https://lynxsearch.club/api/v1/search/{search_id} \
  -H "Authorization: Bearer lynx_sk_your_api_key"

POST/api/v1/search/textFree

Search identity by name, email, phone, or username. Returns results synchronously.

bash

curl -X POST https://lynxsearch.club/api/v1/search/text \
  -H "Authorization: Bearer lynx_sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{"query": "[email protected]"}'

POST/api/v1/search/face3 credits

Search identity by face image. Async processing, returns search_id for polling.

bash

curl -X POST https://lynxsearch.club/api/v1/search/face \
  -H "Authorization: Bearer lynx_sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{"image_url": "https://example.com/face.jpg"}'

GET/api/v1/search/{id}Free

Get search results. Use to poll async face search results.

bash

curl https://lynxsearch.club/api/v1/search/123 \
  -H "Authorization: Bearer lynx_sk_xxx"

GET/api/v1/search/{id}/statusFree

Check search progress status (processing / completed / failed).

bash

curl https://lynxsearch.club/api/v1/search/123/status \
  -H "Authorization: Bearer lynx_sk_xxx"

GET/api/v1/credits/balanceFree

Check current credit balance.

bash

curl https://lynxsearch.club/api/v1/credits/balance \
  -H "Authorization: Bearer lynx_sk_xxx"

GET/api/v1/user/infoFree

Get current user basic information.

bash

curl https://lynxsearch.club/api/v1/user/info \
  -H "Authorization: Bearer lynx_sk_xxx"

Use Lynx Search as a skill in OpenClaw (Lobster Bot).

One-Click Deploy to OpenClaw

Copy the command below and send it to OpenClaw to auto-deploy

Please install the Lynx Search face search skill. Follow these steps:

1. Create the skill directory:
mkdir -p ~/.openclaw/skills/lynx-search

2. Create the SKILL.md file with the following content:

---START---
# Lynx Search - AI Face & Identity Search

## Description
Lynx Search is an AI face search engine that finds anyone's social media profiles using their face photo or text information (name, email, phone, username).

## Configuration
Set the API Key environment variable:
```
export LYNX_API_KEY="YOUR_API_KEY"
```

## Tools

### text_search
Search identity by name, email, phone, or username. Free (0 credits).
- Input: query (string) - The search query
- Output: JSON with search results including social profiles

```bash
curl -X POST https://lynxsearch.club/api/v1/search/text \
  -H "Authorization: Bearer $LYNX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "{{input}}"}'
```

### face_search
Search by face photo URL. Async processing, returns search_id for polling. Costs 3 credits.
- Input: image_url (string) - URL of the face photo
- Output: JSON with search_id to poll for results

```bash
curl -X POST https://lynxsearch.club/api/v1/search/face \
  -H "Authorization: Bearer $LYNX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"image_url": "{{input}}"}'
```

### get_search_result
Get search results (for async face search polling).
- Input: search_id (string) - The search ID

```bash
curl https://lynxsearch.club/api/v1/search/{{input}} \
  -H "Authorization: Bearer $LYNX_API_KEY"
```

### check_balance
Check remaining credits.

```bash
curl https://lynxsearch.club/api/v1/credits/balance \
  -H "Authorization: Bearer $LYNX_API_KEY"
```

## Notes
- Text search returns results synchronously, face search requires polling (check status every 3 seconds)
- Credits are shared with your Lynx web account
---END---

3. Set the environment variable:
export LYNX_API_KEY="YOUR_API_KEY"

Let me know the installation result when done.

Manual Installation Steps

1. Copy the command above and send it to OpenClaw, it will auto-create the skill directory and SKILL.md file

2. Replace "YOUR_API_KEY" in the command with your actual API Key

3. After OpenClaw completes execution, you can use the Lynx Search skill for face and text searches