import requests
url = "https://app.langwatch.ai/api/suites"
headers = {"X-Auth-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>'}};
fetch('https://app.langwatch.ai/api/suites', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://app.langwatch.ai/api/suites \
--header 'X-Auth-Token: <api-key>'[
{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"scenarioIds": [
"<string>"
],
"targets": [
{
"type": "prompt",
"referenceId": "<string>",
"runParameters": {}
}
],
"repeatCount": 123,
"labels": [
"<string>"
],
"createdAt": "<string>",
"updatedAt": "<string>",
"platformUrl": "<string>",
"kind": "custom",
"scope": {
"mode": "all"
}
}
]{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}List all non-archived suites
Deprecated: use /api/v1/run-plans and /api/v1/test-suites. List all non-archived suites for the project. By default only run plans are returned; pass kind=folder for test suites.
import requests
url = "https://app.langwatch.ai/api/suites"
headers = {"X-Auth-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>'}};
fetch('https://app.langwatch.ai/api/suites', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://app.langwatch.ai/api/suites \
--header 'X-Auth-Token: <api-key>'[
{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"scenarioIds": [
"<string>"
],
"targets": [
{
"type": "prompt",
"referenceId": "<string>",
"runParameters": {}
}
],
"repeatCount": 123,
"labels": [
"<string>"
],
"createdAt": "<string>",
"updatedAt": "<string>",
"platformUrl": "<string>",
"kind": "custom",
"scope": {
"mode": "all"
}
}
]{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
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
Which kind of suite to list. Defaults to custom, so callers that predate test suites keep seeing exactly the run plans they always did.
custom, folder Response
Success
Show child attributes
Show child attributes
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.
custom, folder 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.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Was this page helpful?