import requests
url = "https://app.langwatch.ai/api/v1/run-plans/{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/run-plans/{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/run-plans/{id} \
--header 'X-Auth-Token: <api-key>'{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"scope": {
"mode": "all"
},
"scenarioIds": [
"<string>"
],
"targets": [
{
"type": "prompt",
"referenceId": "<string>"
}
],
"repeatCount": 123,
"simulatorModel": "<string>",
"judgeModel": "<string>",
"labels": [
"<string>"
],
"archivedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"platformUrl": "<string>"
}Read one run plan
Read one run plan. An id the project does not hold, and a test suite id, both answer 404 suite_not_found.
import requests
url = "https://app.langwatch.ai/api/v1/run-plans/{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/run-plans/{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/run-plans/{id} \
--header 'X-Auth-Token: <api-key>'{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"scope": {
"mode": "all"
},
"scenarioIds": [
"<string>"
],
"targets": [
{
"type": "prompt",
"referenceId": "<string>"
}
],
"repeatCount": 123,
"simulatorModel": "<string>",
"judgeModel": "<string>",
"labels": [
"<string>"
],
"archivedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"platformUrl": "<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 run plan id.
1Response
Success
The run plan id.
The run plan name. This is the plan's identity: a run started under this name joins this plan.
The plan's address in the platform. It is kept when the plan is renamed, so run history never moves.
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 sent with the configuration). 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
The scenarios the last run of this plan covered.
What the plan runs against, in the order the results show.
Show child attributes
Show child attributes
How many times each scenario and target pairing runs.
The model that plays the user, or null for the scenario or project default.
The model that judges the run, or null for the scenario or project default.
The labels the plan carries.
When the plan was archived, or null while it is active.
When the plan was created.
When the plan was last written.
Where to open this run plan in the LangWatch platform.
Was this page helpful?