Skip to main content
POST
Python

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
name
string

The run plan this run joins or creates. Used only when the id names a test suite; derived from the suite name and the targets when absent.

Required string length: 1 - 200
targets
object[]

The prompts, agents or workflows the run goes against. Used only when the id names a test suite, which stores no target of its own.

repeatCount
integer

How many times each scenario and target pairing runs, between 1 and 5. Used only when the id names a test suite.

Required range: 1 <= x <= 5
simulatorModel
string | null

The model that plays the user for every scenario in the run. Used only when the id names a test suite.

judgeModel
string | null

The model that judges every scenario in the run. Used only when the id names a test suite.

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.

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

Suite run scheduled

scheduled
boolean
required
batchRunId
string
required
setId
string
required
jobCount
number
required
skippedArchived
object
required
items
object[]
required
Last modified on May 19, 2026