Skip to main content
PATCH
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

The test suite id.

Minimum string length: 1

Body

application/json
name
string

The new name. The slug is kept.

Required string length: 1 - 200
fields
object[]

The full list of fields the suite declares. A field an attached evaluator still reads cannot be removed: answers 422 suite_field_in_use.

Maximum array length: 30
evaluators
object[]

The full list of evaluators attached to the suite. An evaluator the project does not hold answers 422 suite_evaluator_not_found; a mapping the run cannot read answers 422 suite_evaluator_mapping_invalid.

Maximum array length: 20

Response

Success

id
string
required

The test suite id.

name
string
required

The test suite name.

slug
string
required

The suite's address in the platform. It is kept when the suite is renamed.

scenarioIds
string[]
required

The scenarios filed in this suite, in the order it shows them.

scenarioCount
number
required

How many scenarios are filed in it.

archivedAt
string | null
required

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

createdAt
string
required

When the suite was created.

updatedAt
string
required

When the suite was last written.

platformUrl
string<uri>
required

Where to open this test suite in the LangWatch platform.

fields
object[]

The fields the test suite declares. Absent on servers that predate fields on this family.

Maximum array length: 30
evaluators
object[]

The evaluators attached to the test suite. Absent on servers that predate evaluators on this family.

Maximum array length: 20
Last modified on August 28, 2026