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)const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>'}};
fetch('https://app.langwatch.ai/api/v1/test-suites/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://app.langwatch.ai/api/v1/test-suites/{id} \
--header 'X-Auth-Token: <api-key>'{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"scenarioIds": [
"<string>"
],
"scenarioCount": 123,
"archivedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"platformUrl": "<string>",
"scenarios": [
{
"id": "<string>",
"name": "<string>"
}
]
}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.
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)const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>'}};
fetch('https://app.langwatch.ai/api/v1/test-suites/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://app.langwatch.ai/api/v1/test-suites/{id} \
--header 'X-Auth-Token: <api-key>'{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"scenarioIds": [
"<string>"
],
"scenarioCount": 123,
"archivedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"platformUrl": "<string>",
"scenarios": [
{
"id": "<string>",
"name": "<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
The test suite id.
1Response
Success
The test suite id.
The test suite name.
The suite's address in the platform. It is kept when the suite is renamed.
The scenarios filed in this suite, in the order it shows them.
How many scenarios are filed in it.
When the suite was archived, or null while it is active.
When the suite was created.
When the suite was last written.
Where to open this test suite in the LangWatch platform.
The active scenarios filed in this suite. An archived scenario is left out.
Show child attributes
Show child attributes
Was this page helpful?