Read one test suite

Read one test suite with the scenarios filed in it, named. An id the project does not hold, and a run plan id, both answer 404 suite_not_found.

GET /api/v1/test-suites/{id}

Read one test suite

Python

import requests

url = "https://app.langwatch.ai/api/v1/test-suites/{id}"

headers = {"X-Auth-Token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "scenarioIds": [
    "<string>"
  ],
  "scenarioCount": 123,
  "archivedAt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "platformUrl": "<string>",
  "scenarios": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ]
}

Authorizations

X-Auth-Token · string · header · required

Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.

Path Parameters

id · string · required

The test suite id.

Minimum string length: 1

Response

200 - application/json

Success

id · string · required

The test suite id.

name · string · required

The test suite name.

slug · string · required

The suite's address in the platform. It is kept when the suite is renamed.

scenarioIds · string[] · required

The scenarios filed in this suite, in the order it shows them.

scenarioCount · number · required

How many scenarios are filed in it.

archivedAt · string | null · required

When the suite was archived, or null while it is active.

createdAt · string · required

When the suite was created.

updatedAt · string · required

When the suite was last written.

platformUrl · string<uri> · required

Where to open this test suite in the LangWatch platform.

scenarios · object[] · required

The active scenarios filed in this suite. An archived scenario is left out.

Show child attributes