Skip to main content
GET
/
api
/
platform
/
testSuites
/
{suiteId}
Get Test Suite
curl --request GET \
  --url https://api.example.com/api/platform/testSuites/{suiteId}
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "tests": [
    {}
  ]
}

Request

GET /api/platform/testSuites/{suiteId}

Path Parameters

suiteId
string
required
Test suite ID

Query Parameters

expand
boolean
default:"false"
Include full test details

Example Request

curl -X GET "https://api.agentdiff.dev/api/platform/testSuites/suite-123?expand=true" \
  -H "X-API-Key: ad_live_sk_..."

Response

id
string
Suite identifier
name
string
Suite name
description
string
Suite description
tests
array
List of tests (when expand=true)

Example Response (expand=true)

{
  "id": "suite-123",
  "name": "Slack Bench",
  "description": "Core Slack agent capabilities",
  "templateService": "slack",
  "templateName": "slack_bench_default",
  "impersonateUserId": "U01AGENBOT9",
  "tests": [
    {
      "id": "test-001",
      "name": "Post message to channel",
      "prompt": "Post 'Hello World!' to #general",
      "expectedOutput": {
        "assertions": [
          {
            "diff_type": "added",
            "entity": "messages",
            "where": {
              "channel_id": {"eq": "C01GENERAL99"},
              "message_text": {"contains": "Hello"}
            },
            "expected_count": 1
          }
        ]
      }
    },
    {
      "id": "test-002",
      "name": "Add reaction",
      "prompt": "Add a thumbs up reaction to the latest message in #general",
      "expectedOutput": {
        "assertions": [
          {
            "diff_type": "added",
            "entity": "reactions",
            "where": {
              "reaction_name": {"eq": "thumbsup"}
            }
          }
        ]
      }
    }
  ]
}

Example Response (expand=false)

{
  "id": "suite-123",
  "name": "Slack Bench",
  "description": "Core Slack agent capabilities",
  "testCount": 20
}

Test Object

Each test includes:
FieldDescription
idUnique test identifier
nameTest name
promptPrompt to give to the agent
expectedOutputAssertions in JSON DSL

SDK Usage

# Get suite without tests
suite = client.get_test_suite("suite-123")
print(f"{suite.name}: {suite.testCount} tests")

# Get suite with full test details
suite = client.get_test_suite("suite-123", expand=True)
for test in suite.tests:
    print(f"  - {test.name}: {test.prompt}")