Endpoints // Search
Agentic Search
NewDescribe the people you want in plain language and get full profiles back, with the filters we read from your prompt.
Introduction
The Agentic Search endpoint takes one sentence, such as VP Sales at software companies with 51 to 200 employees in Paris, reads it into People search filters, runs that search and returns the matching full profiles. You do not build the filters yourself: the response tells you which ones were applied, in data.interpretation.
Every result is a complete profile, the same shape People search returns, with the same cursor pagination. Results are drawn from our cache-based search index. This endpoint never triggers a live fetch.
Use it when the request comes from a person typing what they want, or when you prefer not to map criteria to filter names. To control every filter yourself, use People search.
Authorization
| Name | Type | Required | Description |
|---|---|---|---|
apikey | string | Yes | Your API key from the developer dashboard. Pass it via Authorization: Bearer YOUR_API_KEY header. |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
prompt | string | Yes | Plain-language description of the people to find, in any language. At least 3 characters and at most 1000 tokens |
cursor | string | No | Opaque cursor returned as metadata.nextCursor; request the next page with the same prompt |
perPage | number | No | Profiles per page (1 to 100, default 25) |
Prompt length: the 1000 token limit is about 4000 characters of English text. It is counted conservatively: four plain ASCII characters count as one token, and every other character (an accented letter, a non-Latin script) counts as one token on its own. A longer prompt returns HTTP
422witherror.codeINVALID_PROMPTand costs 0 credits.
No filters: the filters come from the prompt, so the request takes no search filter. Any other field, such as
locationorcurrentSeniority, returns HTTP422witherror.codePROMPT_FILTERS_NOT_SUPPORTEDand the offending fields inerror.details.fields, and costs 0 credits. A filter is refused rather than ignored, because an ignored filter would return results you did not ask for. Describe it in the prompt instead, or send explicit filters to People search.
What a prompt can express
A prompt is read into these People search filters:
| What you describe | Filters it becomes |
|---|---|
| A current or past job title, to include or exclude | currentPositionTitle, positionTitle and their exclude... counterparts |
| A current or past company, to include or exclude | currentCompanyName, companyName and their exclude... counterparts |
| An industry | currentCompanyIndustry, companyIndustry, excludeCompanyIndustry, from the industry list |
| A company size | currentCompanyEmployeeCountRange |
| A place | location (country, region, city or area) |
| A career length or an audience size | totalExperienceMonths, followersCount |
| A person's name or headline keywords | firstName, lastName, headline |
| A skill or a technology the person masters | skills |
| A spoken language, to include or exclude | languages, excludeLanguages, from the language names |
| Words to find anywhere in the profile | keywords |
| A recent job change | changedJobsWithinDays (30, 60, 90 or 120 days) |
| Open to work, currently employed, Premium, verified | isOpenToWork, isCurrentlyEmployed, isPremium, isVerified |
| How recent the data must be | maxDataAgeDate |
Job titles and company names are matched as written, with the same token-based matching as People search, so write a title the way it appears on profiles. A seniority word such as VP or Director is matched inside the job title: the position taxonomy filters (currentFunction, currentSubFunction, currentSeniority and experience) are not read from a prompt yet. To filter on them, use People search.
Anything the prompt asks for that no filter covers, such as schools or contract types, is left out of the search and reported in data.interpretation.warnings, so you can see what the results do not take into account.
Pagination and credits
Agentic Search uses cursor pagination, like People search. Each response returns up to perPage profiles (1 to 100, default 25) and a metadata.nextCursor value. To get the following page, send the same prompt again with that value as cursor; nextCursor is null on the last page. The cursor is opaque: send it back unchanged, without parsing or altering it. There is no page parameter, and perPage may change from one page to the next.
The cursor does not expire, and a long pause between two pages is fine: the next page picks up where the previous one stopped. If profiles were refreshed in the meantime, one of them can occasionally repeat or be skipped at the page boundary. What a cursor needs is the same filters. A prompt keeps the filters it was first read into for 24 hours in your workspace, so resending it unchanged, from any of your API keys, always runs the same search. Spaces and line breaks do not count as a change. If you edit the prompt, or come back after 24 hours, the prompt is read again, and a cursor sent with filters other than the ones that produced it returns HTTP 400 and costs 0 credits: start again from the first page, without cursor.
perPage above 100 returns HTTP 422 with error.code PAGINATION_LIMIT_EXCEEDED, and a perPage that is not a whole number returns HTTP 422 with error.code INVALID_PAGINATION.
Agentic Search costs 1 credit per page for the search itself, plus 1 credit per profile delivered. The search credit is charged on every page, including when no profile matches. Compliance-blocked profiles are removed before the response and are not billed. A page that returns 25 profiles costs 26 credits, and a page that returns no profile costs 1 credit. A request refused before the search runs, for any of the reasons listed under Errors, costs 0 credits. Lower perPage to control how many credits a single request can spend.
Tip:
data.interpretation.filtersis a valid People search body. Send it to the free People search count endpoint to know how many people match in total, or to People search to adjust a filter by hand.
Errors
Every error below answers before the search runs, and costs 0 credits. When the prompt was read, error.details.interpretation carries the filters and warnings it produced, so you can see why it could not run.
| HTTP | error.code | What happened | What to do |
|---|---|---|---|
422 | INVALID_PROMPT | prompt is missing, is not a string, is shorter than 3 characters or longer than 1000 tokens | Send a prompt within the limits |
422 | PROMPT_FILTERS_NOT_SUPPORTED | The body carries a field other than prompt, cursor and perPage. error.details.fields lists them | Describe those criteria in the prompt, or use People search |
422 | NO_FILTERS_INTERPRETED | No filter could be read from the prompt, and a search without filters would scan the whole database. error.details.interpretation.warnings says what was not understood | Name a job title, a company, a place or an industry |
422 | PROMPT_FILTERS_REJECTED | The filters read from the prompt cannot run together, for example the same title both included and excluded. error.details.errors lists each problem with its field, as in Search filter validation | Rephrase the prompt, or use People search |
422 | INVALID_PAGINATION, PAGINATION_LIMIT_EXCEEDED | perPage is not a whole number, or is above 100 | Send a perPage from 1 to 100 |
400 | REQUEST_ERROR | The cursor does not belong to the filters the prompt was read into (Invalid or expired cursor) | Start again from the first page, without cursor |
502 | PROMPT_INTERPRETATION_FAILED | The prompt could not be read this time | Retry, or rephrase the prompt |
504 | PROMPT_INTERPRETATION_TIMEOUT | Reading the prompt took too long | Retry with backoff |
503 | PROMPT_SEARCH_UNAVAILABLE | Agentic Search is temporarily unavailable | Retry later, or use People search with explicit filters |
Response structure
Note: This endpoint uses a nested envelope. The top-level V2
datafield wraps an inner search payload that contains the actual results array (data.data), the pagination info (data.metadata) and the filters read from the prompt (data.interpretation). See the example response for the exact shape.
| Field | Type | Description |
|---|---|---|
success | boolean | true if the request was processed successfully |
error | null | Always null on success |
data.dataobject[]Full profiles returned for this page, wrapped under data.data in the envelope. Empty array if no match. Each item is the same full profile shape as the Profile endpoint; the table below lists its main fields.
Show child attributesHide child attributes
| Field | Type | Description |
|---|---|---|
id | string | Reverse Contact person id (prs_...) |
publicId | string | Social public identifier (the /in/xxx slug) |
memberId | string | null | Upstream member identifier when available |
linkedinUrl | string | Full Social profile URL |
firstName | string | null | First name |
lastName | string | null | Last name |
headline | string | null | Profile headline |
summary | string | null | Profile summary |
isOpenToWork | boolean | Whether the profile is flagged open to work |
hasPremium | boolean | Whether the profile has Social Premium |
hasVerificationBadge | boolean | Whether the profile has a verification badge |
photoUrl | string | null | Profile photo URL |
creationDate | string | null | When the profile was created (ISO 8601) |
followersCount | number | null | Follower count |
connectionsCount | number | null | Connection count |
currentPosition | object | null | Current job position (how it is chosen) |
experience | array | Professional experiences, same shape as currentPosition |
education | array | Education history |
skills | string | Skills listed on the profile |
languages | array | Spoken languages |
certifications | array | Professional certifications |
recommendations | array | Received recommendations |
locationobjectGeographic location (null if unknown)
Show child attributesHide child attributes
| Field | Type | Description |
|---|---|---|
city | string | null | City |
state | string | null | State or region |
country | string | null | Country name |
countryCode | string | null | ISO country code (e.g. "US") |
rawLocation | string | null | Raw location string as displayed on the profile |
currentPositionobjectCurrent job position (null if no current position)
Show child attributesHide child attributes
| Field | Type | Description |
|---|---|---|
title | string | null | Job title |
description | string | null | Position description |
contractType | string | null | Contract type |
companyName | string | null | Company name |
companyLinkedinId | string | null | Company Social identifier |
companyUrl | string | null | Company Social URL |
companyLocation | string | null | Company location |
companyLogoUrl | string | null | Company logo URL |
startEndDate | object | null | Period boundaries (DateRange) |
data.metadataobjectPagination metadata wrapped under data.metadata in the envelope.
Show child attributesHide child attributes
| Field | Type | Description |
|---|---|---|
perPage | number | Profiles requested per page |
count | number | Profiles returned in this page. Use People search count with data.interpretation.filters for the total matching set |
nextCursor | string | null | Opaque cursor for the next page, null on the last page. Send it with the same prompt |
data.interpretationobjectWhat the prompt was read into, the same on every page of a prompt.
Show child attributesHide child attributes
| Field | Type | Description |
|---|---|---|
filters | object | The People search filters applied, keyed like the People search request body |
warnings | string | What the prompt asked for that the search does not apply, such as a school. Empty when everything was applied |
quotasobjectCredits and rate limit usage after this request
Show child attributesHide child attributes
| Field | Type | Description |
|---|---|---|
creditsConsumed | number | Credits consumed by this request: 1 for the search plus 1 per profile delivered |
workspaceobjectWorkspace-level limits
Show child attributesHide child attributes
| Field | Type | Description |
|---|---|---|
id | string | Your workspace identifier |
hasUnlimitedCredits | boolean | Whether workspace credits are unlimited |
allowDailyOvercost | boolean | Whether the workspace may exceed its daily cap |
creditsobjectCredit balance
Show child attributesHide child attributes
| Field | Type | Description |
|---|---|---|
total | number | Total credits in your plan |
used | number | Credits consumed so far |
left | number | Remaining credits |
dailyLimitobjectDaily request limit (null if not configured)
Show child attributesHide child attributes
| Field | Type | Description |
|---|---|---|
limit | number | Maximum requests per day |
used | number | Requests made today |
left | number | Remaining requests today |
nextReset | string | When the daily window resets (ISO 8601) |
minuteRateLimitobjectPer-minute rate limit
Show child attributesHide child attributes
| Field | Type | Description |
|---|---|---|
limit | number | Maximum requests per minute |
used | number | Requests made in the current minute |
left | number | Remaining requests in the current minute |
nextReset | string | When the minute window resets (ISO 8601) |
keyobjectAPI key-level limits (null when request is from dashboard)
Show child attributesHide child attributes
| Field | Type | Description |
|---|---|---|
id | string | API key identifier |
dailyLimitobjectDaily limit for this key (null if not configured)
Show child attributesHide child attributes
| Field | Type | Description |
|---|---|---|
limit | number | Maximum requests per day |
used | number | Requests made today |
left | number | Remaining requests today |
nextReset | string | When the daily window resets (ISO 8601) |
minuteRateLimitobjectMinute rate limit for this key
Show child attributesHide child attributes
| Field | Type | Description |
|---|---|---|
limit | number | Maximum requests per minute |
used | number | Requests made in the current minute |
left | number | Remaining requests in the current minute |
nextReset | string | When the minute window resets (ISO 8601) |
metadataobjectRequest tracking information (not to be confused with data.metadata which is pagination)
Show child attributesHide child attributes
| Field | Type | Description |
|---|---|---|
requestId | string | Unique identifier for this request |
executionTimeMs | number | Total execution time in milliseconds |
Code examples
Code Examples
curl -X POST https://api.reversecontact.com/v2/search/people/prompt \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"prompt": "VP Sales at software companies with 51 to 200 employees in Paris who speak German and studied at HEC",
"perPage": 25
}'const prompt = "VP Sales at software companies with 51 to 200 employees in Paris who speak German and studied at HEC";
const promptPage = async (cursor) => {
const response = await fetch("https://api.reversecontact.com/v2/search/people/prompt", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_API_KEY",
"Content-Type": "application/json"
},
// The same prompt travels with every page, the cursor only from the second one.
body: JSON.stringify({ prompt, perPage: 25, cursor })
});
return response.json();
};
const firstPage = await promptPage();
const { filters, warnings } = firstPage.data.interpretation;
console.log("Filters applied:", filters, "Not applied:", warnings);
const profiles = firstPage.data.data;
const { nextCursor } = firstPage.data.metadata;
if (nextCursor) {
const secondPage = await promptPage(nextCursor);
profiles.push(...secondPage.data.data);
}import requests
response = requests.post(
"https://api.reversecontact.com/v2/search/people/prompt",
headers={
"Authorization": "Bearer YOUR_API_KEY",
"Content-Type": "application/json"
},
json={
"prompt": "VP Sales at software companies with 51 to 200 employees in Paris who speak German and studied at HEC",
"perPage": 25
}
)
payload = response.json()
interpretation = payload["data"]["interpretation"]
profiles = payload["data"]["data"]
print(f"Filters applied: {interpretation['filters']}")
print(f"Got {len(profiles)} profiles, next cursor: {payload['data']['metadata']['nextCursor']}")Example response
Example Response
{
"success": true,
"data": {
"data": [
{
"id": "prs_01h2x3y4z5a6b7c8d9e0f1g2h3",
"publicId": "claire-martin",
"memberId": "ACoAAB67890",
"linkedinUrl": "https://www.social.com/in/claire-martin",
"firstName": "Claire",
"lastName": "Martin",
"headline": "VP Sales at Northwind | B2B SaaS",
"summary": "Sales leader building revenue teams for European software companies.",
"pronoun": null,
"isOpenToWork": false,
"hasPremium": true,
"hasVerificationBadge": false,
"isInRemembrance": false,
"photoUrl": "https://media.licdn.com/dms/image/v2/D4E03AQ.../profile-photo.jpg",
"backgroundUrl": null,
"creationDate": "2011-05-02T00:00:00.000Z",
"followersCount": 3120,
"connectionsCount": 500,
"location": {
"city": "Paris",
"state": "Île-de-France",
"country": "France",
"countryCode": "FR",
"rawLocation": "Paris, Île-de-France, France"
},
"currentPosition": {
"title": "VP Sales",
"description": "Leading a sales team of 18 across France and the DACH region.",
"contractType": "Full-time",
"companyName": "Northwind",
"companyLinkedinId": "23456789",
"companyUrl": "https://www.social.com/company/northwind",
"companyLocation": "Paris, France",
"companyLogoUrl": "https://media.licdn.com/dms/image/v2/C4E0BAQ.../logo.jpg",
"startEndDate": {
"start": "2022-03-01T00:00:00.000Z",
"end": null
}
},
"experience": [
{
"title": "VP Sales",
"description": "Leading a sales team of 18 across France and the DACH region.",
"contractType": "Full-time",
"companyName": "Northwind",
"companyLinkedinId": "23456789",
"companyUrl": "https://www.social.com/company/northwind",
"companyLocation": "Paris, France",
"companyLogoUrl": "https://media.licdn.com/dms/image/v2/C4E0BAQ.../logo.jpg",
"startEndDate": {
"start": "2022-03-01T00:00:00.000Z",
"end": null
}
}
],
"education": [],
"skills": ["SaaS Sales", "Team Leadership", "Negotiation"],
"languages": [
{ "language": "French", "proficiency": "Native or bilingual" },
{ "language": "German", "proficiency": "Professional working proficiency" }
],
"certifications": [],
"recommendations": [],
"testScores": []
}
],
"metadata": {
"perPage": 25,
"count": 1,
"nextCursor": "cur_01j9x9s6p4b0d8f6h2c4e0g8"
},
"interpretation": {
"filters": {
"currentPositionTitle": "VP Sales",
"currentCompanyIndustry": "Software Development",
"currentCompanyEmployeeCountRange": { "min": 51, "max": 200 },
"location": { "countryCode": "FR", "city": "Paris" },
"languages": "German"
},
"warnings": ["Not available as filters yet: school."]
}
},
"error": null,
"metadata": {
"requestId": "req_p1r2o3m4p5t6",
"executionTimeMs": 5210
},
"quotas": {
"creditsConsumed": 2,
"workspace": {
"id": "ws_abc123",
"credits": {
"total": 10000,
"used": 4523,
"left": 5477
},
"dailyLimit": null,
"minuteRateLimit": {
"limit": 60,
"used": 5,
"left": 55,
"nextReset": "2026-09-29T14:16:00.000Z"
},
"hasUnlimitedCredits": false,
"allowDailyOvercost": false
},
"key": {
"id": "key_abc123",
"dailyLimit": null,
"minuteRateLimit": {
"limit": 60,
"used": 5,
"left": 55,
"nextReset": "2026-09-29T14:16:00.000Z"
}
}
}
}