Get Test Suite

Get details of a specific test suite

GET /api/platform/testSuites/{suiteId}

Get Test Suite

cURL

curl --request GET \
  --url https://api.example.com/api/platform/testSuites/{suiteId}

import requests

url = "https://api.example.com/api/platform/testSuites/{suiteId}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/api/platform/testSuites/{suiteId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/platform/testSuites/{suiteId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/platform/testSuites/{suiteId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/api/platform/testSuites/{suiteId}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/platform/testSuites/{suiteId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "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:

Field	Description
id	Unique test identifier
name	Test name
prompt	Prompt to give to the agent
expectedOutput	Assertions in JSON DSL

SDK Usage

Python

# 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}")

// Get suite without tests
const suite = await client.getTestSuite('suite-123');
console.log(`${suite.name}: ${suite.testCount} tests`);

// Get suite with full test details
const fullSuite = await client.getTestSuite('suite-123', { expand: true });
fullSuite.tests.forEach(test => {
  console.log(`  - ${test.name}: ${test.prompt}`);
});