Tell whether two people know each other
Body: { "a": …, "b": … }, plus the optional fields below.
Tells whether two people likely know each other, and why: the verdict, the strength of the connection, the evidence for each requested type found, and what was checked.
Checked in order: the body (400 invalid_body), a equal to b (400 same_person), types, max_tokens; with on_miss: RESEARCH only, the research and resolve jobs still running (429 research_busy); then, for every call, the balance (402).
Two different values that name the same person are answered
400 same_persononly once the job has matched them: after a202, that answer comes from/v1/job.
See also /v1/circle, Jobs, Billing, Rate limits.
Authorizations
Body
Names one person of the pair, in the forms /v1/circle’s id takes. Spaces around it are ignored; a blank value is answered 400 invalid_body. A value no person matches is answered 404 person_not_found; one that several people have held, 422 ambiguous_person with candidates.
a equal to b is answered 400 same_person before any job starts. Two different values that name the same person, such as a URL and its public identifier, are answered 400 same_person once the job has matched them.
See also b, /v1/circle.
1 - 512Names the other person of the pair, in the forms /v1/circle’s id takes. The values and refusals are those of a: 404 person_not_found, 422 ambiguous_person, and 400 same_person when it names the same person as a.
See also a, /v1/circle.
1 - 512Restricts the answer to these connection types: CAREER (worked at the same company at the same time), EDUCATION (studied at the same school), INVESTOR (held investor roles at the same companies), LINKEDIN_COMMENTS (one commented on the other’s LinkedIn post). An empty array, or a member that is not a connection type, is answered 400 invalid_types.
A type listed twice counts once. With on_miss: RESEARCH, only the listed types are researched.
See also on_miss.
Default: every type.
1 - 64 elementsCAREER, EDUCATION, INVESTOR, LINKEDIN_COMMENTS 64Sets what happens to a requested type not yet researched for the people asked about. UNKNOWN answers from what is known and reports the type in the answer’s coverage; RESEARCH researches the requested types first, then answers. Any other value is answered 400 invalid_body.
RESEARCH takes longer, and is more often answered 202 with a job to read through /v1/job. A type researched recently is mostly not researched again; on circle and paths, force researches it anyway.
See also max_tokens, force, /v1/job, Jobs, Billing, Rate limits.
UNKNOWN, RESEARCH Sets the tokens reserved for research on top of the call’s price. Taken only with on_miss: RESEARCH: with any other on_miss, even within the range, it is answered 400 invalid_max_tokens; so is a value outside the range, or one with more than 3 decimals.
The range starts above zero: to research nothing, leave out RESEARCH.
See also on_miss, Billing.
Default: 2 with on_miss: RESEARCH.
0.001 <= x <= 600Response
The connection between a and b.
Whether the two people likely know each other. LIKELY_KNOW: a comment between them was found. POSSIBLE: another requested type was found. NO_EVIDENCE_FOUND: every requested type that can be checked was checked, with nothing found. UNKNOWN: none of these; verdict_reason says why.
LIKELY_KNOW, POSSIBLE, NO_EVIDENCE_FOUND, UNKNOWN Why the verdict is what it is: DIRECT_INTERACTION for LIKELY_KNOW, SHARED_HISTORY for POSSIBLE, SEARCHED_NO_RESULT for NO_EVIDENCE_FOUND; for UNKNOWN, UNAVAILABLE when the research of a type failed in this call, otherwise NOT_EXAMINED.
DIRECT_INTERACTION, SHARED_HISTORY, SEARCHED_NO_RESULT, UNAVAILABLE, NOT_EXAMINED