SIsigmamind
Test Cases

Get Test Case

Changed on

Retrieves the full details of a single simulation test case by testCaseId. Returns the conversation scenario definition, including the user persona, goals, evaluation criteria, and current status.

get/v1/test-cases/{testCaseId}

Request

  • Base URL
    https://api.sigmamind.ai
  • Auth
    API key in header X-API-Key

Path parameters

testCaseIdstring required

Unique identifier of the test case to retrieve. Obtained from the testCaseId field in the Create Test Case or List Test Cases response.

Query parameters

agentIdstring required

Unique identifier of the agent to which the test case belongs.

Response

OK

testCaseIdstring

The unique identifier of the test case.

labelstring

A human-readable name or label for the test case, used to identify it in reports and dashboards.

workspaceIdstring

The unique identifier of the workspace under which this test case was created.

llmModelstring

The LLM model used to generate Agent responses during the simulation.

userPromptstring

The prompt that defined the persona and intent of the simulated user, driving the user-side messages throughout the conversation.

attemptinteger

The number of times this test case was configured to run as independent simulation attempts.

successCriteriastring[]

Ordered goals used to evaluate the agent after each simulation run.

Example response

{
  "testCaseId": "tc_d17T6uReChpyfFeP",
  "label": "Angry Customer - Cancellation Flow",
  "agent": {
    "name": "New AI Agent",
    "agentId": "agent_D5D0p7TUs66TTAEAx",
    "status": "Live"
  },
  "workspaceId": "org_V6eZ2zg8ziDx5pft",
  "llmModel": "gpt-5.6-luna",
  "mockData": [
    {
      "variableName": "customer_name",
      "value": "John Doe"
    },
    {
      "variableName": "account_status",
      "value": "active"
    }
  ],
  "mockToolData": [
    {
      "toolAlias": "get_order",
      "mockToolDataId": "mock_dpKjqjKnY3z6gABF",
      "name": "Success - Empty List",
      "statusCode": 200
    }
  ],
  "userPrompt": "You are an angry customer who wants to cancel your subscription.",
  "attempt": 5,
  "successCriteria": [
    "Agent was able to successfully look up the order.",
    "Agent was able to successfully close the call."
  ]
}

Changes