Skip to main content
GET
Python

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.

Query Parameters

kind
enum<string>
default:custom

Which kind of suite to list. Defaults to custom, so callers that predate test suites keep seeing exactly the run plans they always did.

Available options:
custom,
folder

Response

Success

id
string
required
name
string
required
slug
string
required
description
string | null
required
scenarioIds
string[]
required
targets
object[]
required
repeatCount
number
required
labels
string[]
required
createdAt
string
required
updatedAt
string
required
platformUrl
string<uri>
required
kind
enum<string>

custom is a hand-assembled run plan; folder is a test suite that groups scenarios filed into it. Absent on servers that predate test suites.

Available options:
custom,
folder
scope
object

What the run plan covers: all (every active scenario), folders (the scenarios filed in the named test suites), labels (the scenarios carrying any of the labels), or cases (the scenarioIds below). A dynamic scope is resolved again at every run, so a scenario written later runs without editing the plan.

Last modified on May 19, 2026