Poll Job on Research AI

Authorizations

x-api-key

string

header

required

Query Parameters

research_token

string

required

Unique token representing the research job to retrieve status for.

Response

200 - application/json

research_token

string

Unique token representing the research job.

response

object | null

The research response if the job has been completed.

Show child attributes

response.answer

string

response.keyFacts

object[]

Show child attributes

response.keyFacts.title

string

response.keyFacts.type

string

response.keyFacts.unit

string

response.keyFacts.value

string

response.sources

object[]

Show child attributes

response.sources.contentId

string

response.sources.contentType

string

response.sources.displayTypeId

integer

response.sources.graphicName

string | null

response.sources.isCharged

boolean

response.sources.locale

string

response.sources.parentId

string | null

response.sources.releasedAt

string

response.sources.source

string

response.sources.statisticType

integer

response.sources.surveyPeriod

string

response.sources.text

string

response.sources.title

string

response.sources.titleShort

string

response.sources.updatedAt

string

response.sources.url

string

status

string

The current status of the research job (e.g., requested, retrive_data, done).