List the project's run plans

List the project’s run plans. Archived plans are left out unless includeArchived is set. Test suites are not run plans and are listed by the test suites family.

GET /api/v1/run-plans

Python

Python

import requests

url = "https://app.langwatch.ai/api/v1/run-plans"

headers = {"X-Auth-Token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

200

[
  {
    "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

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

includeArchived · string · default: false

Include archived run plans in the list. true, 1, yes for yes; false, 0, no or omitted for no.

Response

200 - application/json

Success

id · string · required

The run plan id.

name · string · required

The run plan name. This is the plan's identity: a run started under this name joins this plan.

slug · string · required

The plan's address in the platform. It is kept when the plan is renamed, so run history never moves.

scope · object · required

What the run plan covers: all (every active scenario), test_suites (the scenarios filed in the named test suites), labels (the scenarios carrying any of the labels), or scenarios (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

scenarioIds · string[] · required

The scenarios the last run of this plan covered.

targets · object[] · required

What the plan runs against, in the order the results show.

Show child attributes

repeatCount · number · required

How many times each scenario and target pairing runs.

simulatorModel · string | null · required

The model that plays the user, or null for the scenario or project default.

judgeModel · string | null · required

The model that judges the run, or null for the scenario or project default.

labels · string[] · required

The labels the plan carries.

archivedAt · string | null · required

When the plan was archived, or null while it is active.

createdAt · string · required

When the plan was created.

updatedAt · string · required

When the plan was last written.

platformUrl · string<uri> · required

Where to open this run plan in the LangWatch platform.