Skip to main content
POST
Start an Assistant query

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization
string

Set to Bearer <token> to pass token for authorization.

Body

application/json
turns
TurnSchema · object[]
required
userInput
string
required
alwaysUseReferences
boolean
default:false
neverUseReferences
boolean
default:false
abstractsOnly
boolean
default:false
fullTextsOnly
boolean
default:false
numReferences
integer
default:25
Required range: 0 <= x <= 1000
rankBy
enum<string>
default:all
Available options:
all,
relevance,
date,
citations,
supporting-citations,
contrasting-citations,
journal-rank
answerLength
enum<string>
default:medium
Available options:
short,
medium,
long
model
string | null
reasoningEffort
enum<string> | null
Available options:
minimal,
low,
medium,
high
citationStyle
enum<string>
default:apa
Available options:
apa,
ieee,
mla,
ama,
chicago,
harvard,
vancouver,
bibtex
yearFrom
string | null
yearTo
string | null
topics
string[]
journals
string[]
citationSections
string[]
publicationTypes
string[]
dashboards
integer[]
referenceChecks
string[]
dois
string[]
useStructuredResponse
boolean
default:false
usePatentMode
boolean
default:false
useMixedPatentMode
boolean
default:false
sessionId
integer | null
searches
string[]
openAccessOnly
boolean
default:false
jsonResponseType
enum<string> | null
Available options:
concise,
boolean
reprocessTurnIdx
integer | null
columnSlug
string | null
anonId
string | null
recaptchaToken
string | null
country
string | null
saveSession
boolean
default:true

Response

Successful Response

id
string | null
info
AssitantPollingInfo · object | null
status
string | null
result
AssistantResponseSchema · object | null
error
string | null
usage
AssistantUsageSchema · object | null