Guidance on JSON Format for Bulk Test Case Import

Support Help
1

Hi Retell Team,

I hope you’re doing well.

I’m currently exploring Retell and evaluating it for long-term use. I’m fairly new to the platform and have been testing different features to better understand the workflow.

I would like to perform bulk testing of my agent using the Test Case Import feature available under the Simulation Testing section. However, I’m unable to find documentation that explains the required JSON file structure/schema for importing test cases.

Could you please help me with:

  • The expected JSON format for bulk test case imports
  • A sample JSON file that I can use as a reference
  • Any required or optional fields supported by the importer
  • Best practices for running bulk simulations and evaluating results

I reviewed the available documentation but couldn’t find details about the JSON schema used for the import feature.

Any guidance or example files would be greatly appreciated. i tried it by myself but i got this error which i mention in the screenshot below.

image
image1917×840 38.4 KB

Thank you for your help. I look forward to learning more about Retell and potentially using it extensively in future projects.

Best regards,

Kayam

2

Hi Kayam,

I looked into this query and spent some time researching and testing it on my end. I believe I was able to find a solution. Please take a look and try it on your side as well.

If you have any questions or need any clarification, please let us know.

Import Multiple Test Cases Using JSON

If you need to test multiple scenarios at once, you can use the Import option and upload a JSON file containing all of your test cases.

The JSON format should look like this:

[
  {
    "name": "Tenant - Maintenance Request",
    "user_prompt": "Tenant reporting broken AC and requesting rent waiver.",
    "metrics": [
      "Agent did NOT agree to rent payment plans or fee waivers.",
      "Agent asked only one question at a time."
    ]
  },
  {
    "name": "Distressed Home Seller",
    "user_prompt": "Homeowner facing foreclosure and seeking immediate sale.",
    "metrics": [
      "Agent showed empathy.",
      "Agent did NOT make a price offer."
    ]
  }
]

As shown in the screenshot below, each test case contains:

  • name – Test case name
  • user_prompt – Scenario/persona to simulate
  • metrics – Success criteria used to evaluate the conversation

JSON Test Case Example =>

image
image1590×507 52.3 KB

Simply save the file with a .json extension and upload it using the Import button in the Simulation → Test Cases section. Retell will automatically create all test cases from the file, allowing you to run bulk testing more efficiently. Please let me know if it helps.

3

Hi Kavish,

Thank you for your help. I tested it on my end, and it worked perfectly. The information you shared was very helpful and resolved my issue.

Really appreciate your support!