API ReferenceAgentsGeneral

Stream Events

Beta

Coming soon! Call the general agent and stream events for real-time chat applications.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

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

Request

This endpoint expects an object.
configobjectRequired
Configurable fields for the agent.
messageslist of objectsRequired

The messages to send to the agent. Each message should be a string (for text inputs) or a list of multimodal content parts.

channelstringOptionalDefaults to api
The channel through which the request is being made.
thread_idstring or nullOptional
Optional thread ID for conversation persistence. If not provided, a new thread will be created.

Response

Successful Response
messageslist of objects

Errors