API ReferenceChat

Create a chat message for a research object

Creates a new chat message for a research object and starts asynchronous processing. Use the stream or message endpoint to retrieve the response as it becomes available.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequiredformat: "uuid"
Research job identifier.

Request

This endpoint expects an object.
contentstringRequired
Chat message content.
snippetslist of stringsOptional
Optional snippets to attach to the message.
excluded_domainslist of stringsOptional

List of domains to exclude from web search results (e.g., “example.com”). Subdomains are also excluded.

Response

Chat message created.
idstringformat: "uuid"
Chat message identifier.
rolestring
Role of the message sender.
contentstring
Message content.
snippetslist of strings
Snippets attached to the message.
statusenum
Message processing status.
Allowed values:
created_atdatetime
ISO 8601 timestamp when the message was created.
updated_atdatetime
ISO 8601 timestamp when the message was last updated.
account_idstring or nullformat: "uuid"
Account identifier.
ask_idstring or nullformat: "uuid"
Research job identifier.
error_messagestring or null
Error message if processing failed.
resultslist of objects
Research results referenced by citation index in the message content, ordered by citation index.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error