Trigger a suite run

Trigger a suite run. Schedules scenario executions for all active scenarios × targets × repeatCount.

POST /api/suites/{id}/run

Python

Python

import requests

url = "https://app.langwatch.ai/api/suites/{id}/run"

payload = {
    "idempotencyKey": "<string>",
    "parameters": {},
    "note": "<string>"
}
headers = {
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

200

{
  "scheduled": true,
  "batchRunId": "<string>",
  "setId": "<string>",
  "jobCount": 123,
  "skippedArchived": {
    "scenarios": [
      "<string>"
    ],
    "targets": [
      "<string>"
    ]
  },
  "items": [
    {
      "scenarioRunId": "<string>",
      "scenarioId": "<string>",
      "target": {
        "type": "prompt",
        "referenceId": "<string>"
      },
      "name": "<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.

Path Parameters

id · string · required

Body

application/json

idempotencyKey · string

parameters · object

Constant values applied to every scenario in the run, e.g. a fixture id or a tenant. A value supplied here overrides the scenario's own default for that name.

Show child attributes

note · string

One short line describing why this batch was run, e.g. a commit hash or what you changed. It is stored on every run of the batch and shown beside the run in the platform. Up to 200 characters.

Maximum string length: 200

Response

200

application/json

Suite run scheduled

scheduled · boolean · required

batchRunId · string · required

setId · string · required

jobCount · number · required

skippedArchived · object · required

Show child attributes

items · object[] · required

Show child attributes