Stream Message

Beta
POST

This endpoint allows you to send a message to a specific copilot and get the response back as a streamed set of Server-Sent Events.

Request

This endpoint expects an object.
copilotIdUUIDRequired

Credal-generated Copilot ID to specify which agent to route the request to.

messagestringRequired

The message you want to send to your copilot.

emailstringRequired

The user profile you want to use when sending the message.

conversationIdUUIDOptional

Credal-generated conversation ID for sending follow up messages. Conversation ID is returned after initial message. Optional, to be left off for first messages on new conversations.

inputVariableslist of objectsOptionalBeta

Optional input variables to be used in the message. Map the name of the variable to a list of urls.

Response

This endpoint returns a stream of server sent events. These can be in two formats - one is an initial event, followed by multiple data chunks, followed by a final chunk, or the other format is just one blocked event. See the examples for more details.

Initial
OR
Data Chunk
OR
Final Chunk
OR
Blocked