Skip to main content
POST
Ask a research question about a company

Authorizations

Authorization
string
header
required

Account API key passed in the Authorization header

Path Parameters

linkedin_id
string
required

LinkedIn numeric company ID.

Example:

"104924588"

Body

application/json
question
string
required

The question to answer about this company, in plain language.

Required string length: 3 - 2000
Example:

"How many brands does this group manage?"

answer_count
string

How many answers to produce, as an instruction to the model rather than a hard count. Defaults to one.

Example:

"1"

answer_format
string

How the answer should read — 'a single number', 'a short paragraph', 'a bullet list'. Defaults to a detailed answer.

Example:

"a single number"

Response

Accepted

answers
object[] | null
required

Answers, present once the status is COMPLETED.

id
string
required

ID of this asked question. Poll it to collect the answer.

Example:

"b3c6f5e2-1234-4abc-9def-0123456789ab"

question
string
required

The question as asked.

Example:

"How many brands does this group manage?"

status
string
required

One of COMPLETED, PROCESSING, FAILED.

Example:

"PROCESSING"

updated_at
string<date-time>

When this question last produced an answer.