Create a new suite

Create a new suite (run plan)

POST /api/suites

Python

Python

import requests

url = "https://app.langwatch.ai/api/suites"

payload = {
    "name": "<string>",
    "labels": []
}
headers = {
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

201

{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "kind": "custom",
  "description": "<string>",
  "scenarioIds": [
    "<string>"
  ],
  "scope": {
    "mode": "all"
  },
  "targets": [
    {
      "type": "prompt",
      "referenceId": "<string>"
    }
  ],
  "repeatCount": 123,
  "labels": [
    "<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.

Body

application/json

name · string · required

Minimum string length: 1

kind · enum<string> · default: custom

custom (the default) is a run plan and needs scenarioIds and targets; folder is a test suite that starts empty and gets scenarios by filing them into it.

Available options: custom, folder

description · string

scenarioIds · string[]

scope · object

What the run plan covers: all (every active test case), folders (the cases filed in the named test suites), labels (the cases carrying any of the labels), or cases (the scenarioIds below). A dynamic scope is resolved again at every run, so a test case written later runs without editing the plan.

Option 1

Option 2

Option 3

Option 4

Show child attributes

targets · object[]

Show child attributes

repeatCount · integer · default: 1

Required range: 1 <= x <= 100

labels · string[]

Response

201

application/json

Suite created

id · string · required

name · string · required

slug · string · required

kind · enum<string> · required

custom is a hand-assembled run plan; folder is a test suite that groups scenarios filed into it.

Available options: custom, folder

description · string | null · required

scenarioIds · string[] · required

scope · object · required

What the run plan covers: all (every active test case), folders (the cases filed in the named test suites), labels (the cases carrying any of the labels), or cases (the scenarioIds below). A dynamic scope is resolved again at every run, so a test case written later runs without editing the plan.

Option 1

Option 2

Option 3

Option 4

Show child attributes

targets · object[] · required

Show child attributes

repeatCount · number · required

labels · string[] · required

createdAt · string · required

updatedAt · string · required

platformUrl · string<uri> · required