API reference
Launch a search
Starts a search on criteria (run exactly as sent) or on a jd_text Revcenter reads. A retry with the same Idempotency-Key, project and body returns the same search; the same key on a different request returns 409 idempotency_key_reused. Uses 1 shortlist credit per search; none with database_only: true.
Needs scope searches:write.
POST
/
projects
/
{projectId}
/
searches
Launch a search
curl --request POST \
--url https://api.revcenter.ai/v1/projects/{projectId}/searches \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"criteria": {
"title_variants": [
"<string>"
],
"metro": "<string>",
"allowed_metros": [
"<string>"
],
"remote_ok": true,
"years_experience": {
"min": 123,
"max": 123
},
"current_industries": [
"<string>"
],
"exclude_industries": [
"<string>"
],
"functions": [
"<string>"
],
"employers": [
{
"name": "<string>"
}
],
"schools": [
"<string>"
],
"must_have": [
"<string>"
],
"skills": [
"<string>"
],
"shortlist_min_score": 123
},
"jd_text": "<string>",
"database_only": true,
"target_count": 50
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
criteria: {
title_variants: ['<string>'],
metro: '<string>',
allowed_metros: ['<string>'],
remote_ok: true,
years_experience: {min: 123, max: 123},
current_industries: ['<string>'],
exclude_industries: ['<string>'],
functions: ['<string>'],
employers: [{name: '<string>'}],
schools: ['<string>'],
must_have: ['<string>'],
skills: ['<string>'],
shortlist_min_score: 123
},
jd_text: '<string>',
database_only: true,
target_count: 50
})
};
fetch('https://api.revcenter.ai/v1/projects/{projectId}/searches', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.revcenter.ai/v1/projects/{projectId}/searches"
payload = {
"criteria": {
"title_variants": ["<string>"],
"metro": "<string>",
"allowed_metros": ["<string>"],
"remote_ok": True,
"years_experience": {
"min": 123,
"max": 123
},
"current_industries": ["<string>"],
"exclude_industries": ["<string>"],
"functions": ["<string>"],
"employers": [{ "name": "<string>" }],
"schools": ["<string>"],
"must_have": ["<string>"],
"skills": ["<string>"],
"shortlist_min_score": 123
},
"jd_text": "<string>",
"database_only": True,
"target_count": 50
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"search_id": "<string>",
"reused": true,
"compiled_by": "caller",
"criteria": {
"title_variants": [
"<string>"
],
"metro": "<string>",
"allowed_metros": [
"<string>"
],
"remote_ok": true,
"seniority": "c_suite",
"years_experience": {
"min": 123,
"max": 123,
"enforcement": "hard"
},
"current_industries": [
"<string>"
],
"exclude_industries": [
"<string>"
],
"functions": [
"<string>"
],
"employers": [
{
"name": "<string>",
"temporal": "current",
"flag": "must"
}
],
"schools": [
"<string>"
],
"must_have": [
"<string>"
],
"skills": [
"<string>"
],
"shortlist_min_score": 123
},
"database_only": true
},
"meta": {
"request_id": "<string>"
}
}{
"data": {
"search_id": "<string>",
"reused": true,
"compiled_by": "caller",
"criteria": {
"title_variants": [
"<string>"
],
"metro": "<string>",
"allowed_metros": [
"<string>"
],
"remote_ok": true,
"seniority": "c_suite",
"years_experience": {
"min": 123,
"max": 123,
"enforcement": "hard"
},
"current_industries": [
"<string>"
],
"exclude_industries": [
"<string>"
],
"functions": [
"<string>"
],
"employers": [
{
"name": "<string>",
"temporal": "current",
"flag": "must"
}
],
"schools": [
"<string>"
],
"must_have": [
"<string>"
],
"skills": [
"<string>"
],
"shortlist_min_score": 123
},
"database_only": true
},
"meta": {
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"request_id": "<string>"
}
}Authorizations
An API key from Settings → Usage → API (rvc_live_…).
Headers
8 to 160 printable characters; reuse it to retry safely.
Path Parameters
A project id
Body
application/json
⌘I
Launch a search
curl --request POST \
--url https://api.revcenter.ai/v1/projects/{projectId}/searches \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"criteria": {
"title_variants": [
"<string>"
],
"metro": "<string>",
"allowed_metros": [
"<string>"
],
"remote_ok": true,
"years_experience": {
"min": 123,
"max": 123
},
"current_industries": [
"<string>"
],
"exclude_industries": [
"<string>"
],
"functions": [
"<string>"
],
"employers": [
{
"name": "<string>"
}
],
"schools": [
"<string>"
],
"must_have": [
"<string>"
],
"skills": [
"<string>"
],
"shortlist_min_score": 123
},
"jd_text": "<string>",
"database_only": true,
"target_count": 50
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
criteria: {
title_variants: ['<string>'],
metro: '<string>',
allowed_metros: ['<string>'],
remote_ok: true,
years_experience: {min: 123, max: 123},
current_industries: ['<string>'],
exclude_industries: ['<string>'],
functions: ['<string>'],
employers: [{name: '<string>'}],
schools: ['<string>'],
must_have: ['<string>'],
skills: ['<string>'],
shortlist_min_score: 123
},
jd_text: '<string>',
database_only: true,
target_count: 50
})
};
fetch('https://api.revcenter.ai/v1/projects/{projectId}/searches', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.revcenter.ai/v1/projects/{projectId}/searches"
payload = {
"criteria": {
"title_variants": ["<string>"],
"metro": "<string>",
"allowed_metros": ["<string>"],
"remote_ok": True,
"years_experience": {
"min": 123,
"max": 123
},
"current_industries": ["<string>"],
"exclude_industries": ["<string>"],
"functions": ["<string>"],
"employers": [{ "name": "<string>" }],
"schools": ["<string>"],
"must_have": ["<string>"],
"skills": ["<string>"],
"shortlist_min_score": 123
},
"jd_text": "<string>",
"database_only": True,
"target_count": 50
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"search_id": "<string>",
"reused": true,
"compiled_by": "caller",
"criteria": {
"title_variants": [
"<string>"
],
"metro": "<string>",
"allowed_metros": [
"<string>"
],
"remote_ok": true,
"seniority": "c_suite",
"years_experience": {
"min": 123,
"max": 123,
"enforcement": "hard"
},
"current_industries": [
"<string>"
],
"exclude_industries": [
"<string>"
],
"functions": [
"<string>"
],
"employers": [
{
"name": "<string>",
"temporal": "current",
"flag": "must"
}
],
"schools": [
"<string>"
],
"must_have": [
"<string>"
],
"skills": [
"<string>"
],
"shortlist_min_score": 123
},
"database_only": true
},
"meta": {
"request_id": "<string>"
}
}{
"data": {
"search_id": "<string>",
"reused": true,
"compiled_by": "caller",
"criteria": {
"title_variants": [
"<string>"
],
"metro": "<string>",
"allowed_metros": [
"<string>"
],
"remote_ok": true,
"seniority": "c_suite",
"years_experience": {
"min": 123,
"max": 123,
"enforcement": "hard"
},
"current_industries": [
"<string>"
],
"exclude_industries": [
"<string>"
],
"functions": [
"<string>"
],
"employers": [
{
"name": "<string>",
"temporal": "current",
"flag": "must"
}
],
"schools": [
"<string>"
],
"must_have": [
"<string>"
],
"skills": [
"<string>"
],
"shortlist_min_score": 123
},
"database_only": true
},
"meta": {
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"request_id": "<string>"
}
}