For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Trust CenterStatusSupportGet a demoPlatform
DocumentationEvals API ReferenceIntegrations & OTELPlatform SettingsSelf-HostingGuidesChangelog
DocumentationEvals API ReferenceIntegrations & OTELPlatform SettingsSelf-HostingGuidesChangelog
  • Get Started
    • Introduction
    • Quickstart
    • Authentication
    • Data Models
    • API Conventions
  • Data Models
  • Evals
      • POSTSimulate Conversation
  • Legacy
LogoLogo
Trust CenterStatusSupportGet a demoPlatform
EvalsSimulate

Simulate Conversation

POST
https://api.confident-ai.com/v1/simulate
POST
/v1/simulate
$curl -X POST https://api.confident-ai.com/v1/simulate \
>     -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "conversationalGolden": {
>    "scenario": "A frustrated user asking for a refund.",
>    "userDescription": "A white male who is a customer for over 2 years."
>  }
>}'
200Successful
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}
Simulate the next conversation turn from a conversational golden.
Was this page helpful?
Previous

Batch Create

Next
Built with

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Request

conversationalGoldenobjectRequired
A Conversational Golden that is used to simulate your conversations

Response

successboolean
This is true if the next turn in the conversation was successfully simulated.
dataobject
deprecatedboolean
This is true if this endpoint is deprecated.