Sign in

v1

latestOpenAPI 3.0.12026-07-226992320.0 KB
Test Cases

List Test Cases

Returns a paginated list of simulation test cases for the specified agent, sorted by most recently created first. Use page and size to navigate through results.

get/v1/test-cases

Query parameters

agentIdstring required

Unique identifier of the agent whose test cases are to be listed.

pageinteger

Zero-based page number to retrieve. Use 0 for the first page. Must be 0 or greater.

sizeinteger

Number of test cases to return per page. Must be 1 or greater. Defaults to 10.

Response

OK

pageinteger

Current page number (0-based index). Indicates which page of results is being returned.

sizeinteger

Number of items requested per page. Determines the maximum size of the 'data' list.

totalCountinteger

Total number of records available across all pages. Useful for calculating pagination on the client side.

totalPagesinteger

Total number of pages available based on totalCounts and size. Helps clients understand how many pages exist in total.

hasNextboolean

Indicates whether there is a next page available after the current one. Useful for implementing 'Load More' or next navigation.

hasPreviousboolean

Indicates whether there is a previous page before the current one. Useful for enabling backward navigation.

Example response

{
  "data": [
    {
      "testCaseId": "tc_d17T6uReChpyfFeP",
      "label": "Angry Customer - Cancellation Flow",
      "agent": {
        "name": "New AI Agent",
        "agentId": "agent_D5D0p7TUs66TTAEAx",
        "status": "Live"
      },
      "workspaceId": "org_V6eZ2zg8ziDx5pft",
      "llmModel": "gpt-4o-mini",
      "mockData": [
        {
          "variableName": "customer_name",
          "value": "John Doe"
        },
        {
          "variableName": "account_status",
          "value": "active"
        }
      ],
      "userPrompt": "You are an angry customer who wants to cancel your subscription.",
      "attempt": 5,
      "successCriteria": "The agent should acknowledge the cancellation request, present retention alternatives, and confirm the cancellation if the customer insists."
    }
  ],
  "size": 20,
  "totalCount": 125,
  "totalPages": 7,
  "hasNext": true
}