import requests
url = "https://app.langwatch.ai/api/suites/{id}"
payload = { "labels": ["<string>"] }
headers = {
"X-Auth-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Auth-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({labels: ['<string>']})
};
fetch('https://app.langwatch.ai/api/suites/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request PATCH \
--url https://app.langwatch.ai/api/suites/{id} \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--data '
{
"labels": [
"<string>"
]
}
'{
"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>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Update a suite
Deprecated: use /api/v1/run-plans and /api/v1/test-suites. Update a suite (run plan).
import requests
url = "https://app.langwatch.ai/api/suites/{id}"
payload = { "labels": ["<string>"] }
headers = {
"X-Auth-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Auth-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({labels: ['<string>']})
};
fetch('https://app.langwatch.ai/api/suites/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request PATCH \
--url https://app.langwatch.ai/api/suites/{id} \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--data '
{
"labels": [
"<string>"
]
}
'{
"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>",
"code": "<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.
Path Parameters
Body
1What 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
11Show child attributes
Show child attributes
1 <= x <= 100Response
Suite updated
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?