POST
/
research
/
person
curl --request POST \
  --url https://api.orchestra.inc/v1/research/person \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "question": "<string>",
  "responseType": "BOOL",
  "responseOptions": [
    "<string>"
  ],
  "context": "<string>",
  "person": {
    "company": {
      "name": "<string>",
      "website": "<string>",
      "location": "<string>",
      "numEmployees": 123,
      "annualRevenue": 123,
      "linkedinUrl": "<string>"
    },
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phone": "<string>",
    "title": "<string>",
    "linkedinUrl": "<string>"
  }
}'
{
  "answerText": "<string>",
  "answerNumber": 123,
  "details": "<string>",
  "sources": [
    "<string>"
  ],
  "confidence": 123,
  "person": {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "linkedinUrl": "<string>",
    "jobTitle": "<string>",
    "country": "<string>",
    "city": "<string>",
    "jobStartDate": "<string>",
    "companyName": "<string>",
    "companyWebsite": "<string>",
    "companyLinkedinUrl": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Body

application/json
​
question
string
required

The question you want to ask

​
responseType
enum<string>
required

The format you expect the response to be in

Available options:
BOOL,
TEXT,
NUMBER,
ENUM
​
responseOptions
string[]

Comma-separated list of possible options for ENUM response type

​
context
string

Additional context that might help answer the question

​
person
object

Person data used for research. At least linkedinUrl or firstName + lastName + company.name is required.

Response

200
application/json
Successful research response
​
answerText
string

Text answer to the question

​
answerNumber
number

Numerical answer when responseType is NUMBER

​
details
string

Additional details about the answer

​
sources
string[]

Sources used to derive the answer

​
confidence
number

Confidence score of the answer (1-10)

​
person
object