Skip to main content

ResearchStreamResponse

Represents one atomic part of the streamed response.

Properties

PropertyRequiredTypeDescription
typeTrueStringThe type of content. See table below.
contentTrueObjectThe content object. The object type depends on the value of type.

Response types

TypeExpected countContentDescription
message0-NMessageResponseInformational progress messages. Not part of the final answer.
error0-1MessageResponseReturned when an unexpected error occurs. No further data will follow.
answer-part0-NResearchAnswerPartOne intermediate part of the answer (e.g., a bullet point).
full-response1ResearchResponseThe complete API response. This is always the last streamed item.