Simulate Conversation

POST

https://api.confident-ai.com/v1/simulate

Simulate the next conversation turn from a conversational golden.

goldenobjectRequired

A Conversational Golden that is used to simulate your conversations

successboolean

This is true if the next turn in the conversation was successfully simulated.

dataobject

deprecatedboolean

This is true if this endpoint is deprecated.

1	curl -X POST https://api.confident-ai.com/v1/simulate \
2	-H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"golden": {
6	"scenario": "A frustrated user asking for a refund.",
7	"userDescription": "A white male who is a customer for over 2 years."
8	}
9	}'

1	{
2	"success": true,
3	"data": {
4	"simulationId": "SIMULATION-ID",
5	"completed": false,
6	"userResponse": "I'd like my refund please.",
7	"turns": [
8	{
9	"role": "assistant",
10	"content": "Hey, how can I help you today?"
11	},
12	{
13	"role": "user",
14	"content": "I'd like my refund please."
15	}
16	]
17	},
18	"deprecated": false
19	}