ResearchRequest

Request object for the research feature.

Properties

Property	Required	Type	Description
query	True	String	Instructions for the research agent.
mode	False	String	The research mode to use, e.g., "lightweight" or "deep".
articleFilters	False	Map	Filters on the articles' metadata fields that restrict the search scope. See this guide for details.
params	False	ResearchParams	Additional parameters for the research agent. All parameters are optional.
previousInteractionId	False	String	ID of the previous interaction in the conversation; value of the interactionId field from an earlier API response.
history	False	List[HistoryInteraction]	History of a previous conversation with the agent. Used to reconstruct context when the original server-side conversation has expired.
returnHistory	False	Boolean	Whether to return the conversation history in the API response.
returnArticles	False	Boolean	Whether to return Article objects in the API response.
returnDuplicates	False	Boolean	Whether to return ArticleDuplicate and ChunkDuplicate objects in the API response, as duplicates of the source articles and text chunks.
returnArticleFields	False	List[String]	Fields to include in the Article objects returned in the articles field, if returnArticles is set to true.
returnParagraphFields	False	List[String]	Fields to include in the Paragraph objects returned in the paragraphs field.