Stream Message | Credal | Documentation

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

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.

copilotIdUUIDRequired

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

messagestringRequired

The message you want to send to your agent.

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.

initialobject

data_chunkobject

end_of_messageobject

final_chunkobject

blockedobject

error_chunkobject

1	import uuid
2
3	from credal import CredalApi
4	from credal.copilots import InputVariable
5
6	client = CredalApi(
7	api_key="YOUR_API_KEY",
8	)
9	response = client.copilots.stream_message(
10	copilot_id=uuid.UUID(
11	"82e4b12a-6990-45d4-8ebd-85c00e030c24",
12	),
13	message="Is Credal SOC 2 compliant?",
14	email="ravin@credal.ai",
15	input_variables=[
16	InputVariable(
17	name="input1",
18	ids=[
19	uuid.UUID(
20	"82e4b12a-6990-45d4-8ebd-85c00e030c24",
21	)
22	],
23	),
24	InputVariable(
25	name="input2",
26	ids=[
27	uuid.UUID(
28	"82e4b12a-6990-45d4-8ebd-85c00e030c25",
29	),
30	uuid.UUID(
31	"82e4b12a-6990-45d4-8ebd-85c00e030c26",
32	),
33	],
34	),
35	],
36	)
37	for chunk in response.data:
38	yield chunk