Copilots

Create Conversation

POST

OPTIONAL. Create a new conversation with the Copilot. The conversation ID can be used in the sendMessage endpoint. The sendMessage endpoint automatically creates new conversations upon first request, but calling this endpoint can simplify certain use cases where it is helpful for the application to have the conversation ID before the first message is sent.

Request

This endpoint expects an object.

agentIdUUIDRequired

Credal-generated agent ID to specify which agent to route the request to. This is required for all new API keys going forward.

userEmailstringRequired

End-user for the conversation.

Response

This endpoint returns an object

conversationIdUUID

Built with

1	curl -X POST https://api.credal.ai/api/v0/copilots/createConversation \
2	-H "Authorization: Bearer <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"agentId": "82e4b12a-6990-45d4-8ebd-85c00e030c24",
6	"userEmail": "ravin@credal.ai"
7	}'

1	{
2	"conversationId": "ac20e6ba-0bae-11ef-b25a-efca73df4c3a"
3	}