Create a test suite

POST

https://apps.sarvam.ai/api/evals/v1/:org_id/:workspace_id/test-suites

POST

/api/evals/v1/:org_id/:workspace_id/test-suites

import requests
url = "https://apps.sarvam.ai/api/evals/v1/org_id/workspace_id/test-suites"
payload = {
    "name": "Front desk — booking flows",
    "description": "Rescheduling, cancellations, and identity checks for the clinic agent.",
    "app_id": "clinic-front-desk",
    "variables": [
        {
            "name": "clinic_name",
            "value": "Sunrise Dental"
        },
        {
            "name": "patient_name",
            "value": "Ravi"
        }
    ],
    "global_guardrails": ["Never gives medical advice; clinical questions are directed to a doctor.", "Confirms the patient's full name and phone number before changing a booking."],
    "test_cases": [
        {
            "name": "Caller reschedules to the weekend",
            "category": "Rescheduling",
            "user_scenario": "The caller has an appointment tomorrow morning but now wants a weekend slot. They are in a hurry, switch to Hindi midway, and ask twice whether a cancellation fee applies.",
            "expected_behaviors": [
                {
                    "name": "Offers concrete slots",
                    "description": "Proposes at least two specific dates and times instead of asking the caller to choose blindly."
                },
                {
                    "name": "Confirms the new booking",
                    "description": "Repeats the final date, time and clinic name back to the caller before ending the call."
                }
            ],
            "variable_overrides": [
                {
                    "name": "patient_name",
                    "value": "Meera"
                }
            ],
            "max_turns": 30
        }
    ]
}
headers = {
    "X-API-Key": "<your-api-key>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "test_suite_id": "01K5T8A2MZQ4VE6XCJ0RDBHW7N"
}

Set app_id to bind the suite to one app; omit it for a suite reusable across apps.

Path parameters

org_idstringRequired

Organization ID

workspace_idstringRequired

Workspace ID

Request

This endpoint expects an object.

namestringRequired1-255 characters

descriptionstring or nullOptional<=20000 characters

app_idstring or nullOptional

Bind the suite to one app. Omit for a workspace-level suite reusable across apps.

variableslist of objectsOptionalDefaults to []

global_guardrailslist of stringsOptionalDefaults to []

Behaviors every test case in the suite is graded against. At most 20, each up to 500 characters.

test_caseslist of objectsOptionalDefaults to []

At most 200. Add more later through the test-case endpoint.

Response

Successful Response

test_suite_idstring

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

Path parameters

Headers

Request

Response

Errors