Skip to main content
Agents: the full documentation index is at /llms.txt.
The revcenter CLI and MCP server are coming soon. Until they are published, use the API as shown here; everything they do, the API does.
1

Get a key

In Revcenter, open Settings → Usage → API and choose Create key. Name it and pick an expiry (30, 90 or 365 days). Copy the key when it is shown; it is shown once. Only workspace admins can create keys, and only in a workspace with API access and an active plan.
2

Check it

You get {"data": [...]} with your workspace’s projects. A 401 means the key is wrong or expired; see errors.
3

Make a project

4

Launch a search

This uses one shortlist credit and answers 202 with a search_id. Sending the same request with the same Idempotency-Key again returns the same search and uses nothing more; see idempotency keys.
5

Wait for it

Repeat every 10 to 30 seconds until status is no longer queued or running; a typical search takes a few minutes. A finished search has an outcome: Shortlist ready, Poor yield or No results. See async jobs.
6

Read the results

Neither uses credits. Each person comes with their score, how they fit each criterion, and their full profile. Long lists page with limit and offset; see pagination.

Next