Start deep research
https://api.vamotalent.ai/v2/deep-research/jobsresearch:deepdeep_researchStarts a deep-research job and answers at once with the job and checkBackSeconds. Nothing is researched while you wait on this call. subject: "developers" researches GitHub handles (logins); subject: "repos" researches owner/name repositories (repos): who builds each one and who stars it. subject: "rank" scores up to 50 GitHub handles (logins) against a question you write, 0 to 100 each with a one-line reason, and returns them best first in ranking. Then read GET /v2/deep-research/jobs/{id} every checkBackSeconds until status is no longer running; that read carries each finished report. Partial success is normal: each subject that did not land says why in failCode and failMessage, and is not billed. A job can need a GitHub account connected by the member you act for (an API key acts as the member who created it). When it does and none is connected, the call answers 409 with reason: GITHUB_CONNECTION_REQUIRED, an instruction to relay to the person and, when there is one, a connectUrl they open to connect it. Send the same request again once they have.
Request body CreateDeepResearchJobRequest application/json
subjectstring requiredResearch developers. The field is a closed vocabulary so more subjects can be added without changing the job contract.
developersloginsarray of string requiredThe GitHub handles to research, up to 25 per job. They are processed in rounds behind the job, not all at once.
min 1 items, max 25 itemsforcebooleanRe-research a subject even when a recent report exists. Costs the same either way, so use this only when you specifically need fresher data.
githubConnectionIdstringIgnored when calling with an API key (that path draws from your GitHub connection pool automatically). Only relevant for a signed-in dashboard member: the id of one of your linked GitHub connections (GET /v1/me/github), required in that case so the job runs on your own GitHub quota.
max 16 chars
subjectstring requiredResearch repositories: who builds each one (recency-weighted contributors), who validates it (recent starrers plus where the repo’s star audience places), and identity facts on both.
reposreposarray of string requiredThe repositories to research as `owner/name` references, up to 25 per job. They are processed in rounds behind the job, not all at once.
min 1 items, max 25 itemsforcebooleanRe-research a subject even when a recent report exists. Costs the same either way, so use this only when you specifically need fresher data.
githubConnectionIdstringIgnored when calling with an API key (that path draws from your GitHub connection pool automatically). Only relevant for a signed-in dashboard member: the id of one of your linked GitHub connections (GET /v1/me/github), required in that case so the job runs on your own GitHub quota.
max 16 chars
subjectstring requiredRank developers against a question: each one is scored 0 to 100 on how well their public work answers it, with a one-line reason, and the job returns them best first.
rankquestionstring requiredWhat you are looking for, in words, up to 4000 characters: the role, the work, the stack. Name a company here if it matters; there is no separate field for one.
max 4000 charsloginsarray of string requiredThe GitHub usernames to score, up to 50 per job. Repeats (in any case) are scored once.
min 1 items, max 50 itemsgithubConnectionIdstringIgnored when calling with an API key (that path draws from your GitHub connection pool automatically). Only relevant for a signed-in dashboard member: the id of one of your linked GitHub connections (GET /v1/me/github), required in that case so the job runs on your own GitHub quota.
max 16 chars
Responses
The job, with every subject pending
jobDeepResearchJob requiredThe job and its per-developer items.
idstring requiredThe job id. Poll it for progress.
namestring | null requiredA short label generated from the developers the job was started with, for showing the job in a list. Null on jobs created before naming existed: fall back to the created time.
subjectstring requiredWhat kind of thing this job researches.
developersreposrankstatusstring requiredWhere the job stands overall. Individual subjects settle independently; read `items` for the detail.
runningsucceededpartialfailedcheckBackSecondsintegerWhile the job is running: how many seconds to wait before reading it again. Absent once the job has finished.
createdAtstring requiredWhen the job was submitted, as an ISO 8601 instant.
finishedAtstring | null requiredWhen the job reached a terminal state, as an ISO 8601 instant. Null while running.
elapsedMsinteger requiredTime so far while running, and total time once finished, in milliseconds. Computed server-side, so it does not depend on your clock.
min 0requestedCountinteger requiredHow many developers you asked for. Not all necessarily land a report: see `deliveredCount`.
min 0deliveredCountinteger requiredHow many developers actually landed a report. A developer whose research failed is not counted here.
min 0itemsarray of DeepResearchItem requiredPer-developer state, including the reason for each one that did not land.
loginstring requiredThe subject reference this item researches: a GitHub handle for the `developers` subject, an `owner/name` for `repos`. The field name predates the second subject; `subjectRef` is the same value under its honest name.
subjectRefstring requiredThe subject reference, same value as `login`: a GitHub handle for `developers`, an `owner/name` for `repos`.
statusstring requiredWhere this one subject stands. Items settle independently: partial success across a job is normal.
pendingrunningdonefailedfailCodestring | null requiredMachine-readable failure reason. Null while the item can still succeed or has succeeded. Branch on this, not on `failMessage`.
not_foundrate_limitedprovider_errortimeoutabandonedengine_errorfailMessagestring | null requiredThe failure explained in words you can show a user, including what to do about it. Null while the item can still succeed.
sourcestring | null requiredWhether the delivered answer was researched fresh or served from a recent previous run. The two are equivalent in content, but a reused answer should not be presented as fresh. Null until an answer lands.
freshcachereportPathstring | null requiredThe API path to read this subject’s report. Null until one exists.
startedAtstring | null requiredWhen this item started, as an ISO 8601 instant. Null while queued.
finishedAtstring | null requiredWhen this item settled, as an ISO 8601 instant. Null until it does.
previewobject | null requiredA one-glance preview of a finished developer report, for showing it in a list. Present only on GET /v1/deep-research/jobs, and only for a `developers` item that is done; null everywhere else.
namestring | null requiredThe developer’s display name. Null when they set none.
avatarUrlstring | null requiredGitHub avatar image URL.
summarystring | null requiredOne sentence about the developer: the first sentence of their LinkedIn headline or GitHub bio. Null when neither exists.
tagsarray of string requiredPlain labels to search and filter a report list on: top languages and city.
locationstring | null requiredThe city they work from. Null when unknown.
crackedboolean requiredWhether their devRank tier counts as cracked (Elite and above).
highlightsarray of string requiredThe report's top signals, as signal names best first (at most three). No percentiles. Empty for a report whose highlights are not stored yet; they fill in on later reads.
signalsarray of string requiredThe signals worth a glance, ready to show: what they mostly build, signature technologies, standing, stars, followers.
fitDeepResearchFit requiredA `rank` job only: this developer’s fit to the question, once they were scored. Null on every other subject, while they wait, and for a developer who could not be scored (see `failCode`).
scoreinteger requiredHow well this developer answers the question, 0 to 100. Absolute, not relative to the list: 80 means the same on every list, so a list of similar people can score close together.
min 0, max 100tierstring required`strong` at 70 and above, `adjacent` from 40 to 69, `off` below 40. Derived from the score.
strongadjacentoffreasonstring requiredOne line on why: a fact Vamo wrote from their public work (a repo and its counts), which the model picked as the best evidence. Never written by a model.
rankinteger requiredTheir place in the ranking, 1 first. Equal scores share a place (1, 2, 2, 4).
requestedBystring | null requiredThe teammate who started the job, by display name. Present only on GET /v1/deep-research/jobs; null for a job started by an API key or by Vamo, and on every other endpoint.
rankingDeepResearchRanking requiredA `rank` job only, once it has finished with at least one developer scored (`succeeded` or `partial`): the question and the scored developers, best first. Null on every other subject, while the job runs, and when nobody could be scored.
questionstring requiredThe question the developers were scored against.
modelstring requiredThe model that scored them.
promptVersionstring requiredThe version of Vamo’s scoring prompt. Scores from different versions are not compared.
peoplearray of DeepResearchRankedPerson requiredEvery developer who was scored, best first: score, then the depth of their work, then the order you sent them in. A developer who could not be scored is not here; their item says why.
loginstring requiredTheir GitHub username, as you sent it.
idstring | null requiredTheir Vamo developer id, the one every other developer endpoint takes (enrich, the contribution garden, deep research). Resolved from the login when they were scored. Null on rankings made before ids were kept.
namestring | null requiredTheir display name. Null when they set none.
titlestring | null requiredTheir current title. Null when unknown.
companystring | null requiredWhere they work now. Null when unknown.
locationstring | null requiredWhere they are. Null when unknown.
avatarUrlstring | null requiredGitHub avatar image URL.
githubUrlstring requiredTheir GitHub profile.
linkedinUrlstring | null requiredTheir LinkedIn profile. Null when unknown.
fitobject requiredscoreinteger requiredHow well this developer answers the question, 0 to 100. Absolute, not relative to the list: 80 means the same on every list, so a list of similar people can score close together.
min 0, max 100tierstring required`strong` at 70 and above, `adjacent` from 40 to 69, `off` below 40. Derived from the score.
strongadjacentoffreasonstring requiredOne line on why: a fact Vamo wrote from their public work (a repo and its counts), which the model picked as the best evidence. Never written by a model.
rankinteger requiredTheir place in the ranking, 1 first. Equal scores share a place (1, 2, 2, 4).
creditsobject | null requiredA `rank` job only: what it was charged, on the model tokens it actually used. Null on other subjects, which are billed per delivered subject.
chargedinteger | null requiredCredits this job was charged, once settled. Null until then.
min 0