Create a new scenario

Create a new scenario

POST /api/scenarios

Python

Python

import requests

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

payload = {
    "name": "<string>",
    "situation": "<string>"
}
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>",
  "situation": "<string>",
  "criteria": [
    "<string>"
  ],
  "labels": [
    "<string>"
  ],
  "parameters": [
    {
      "name": "<string>",
      "description": "<string>",
      "defaultValue": "<string>",
      "secret": true
    }
  ],
  "folderId": "<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

situation · string · required

criteria · string[]

labels · string[]

parameters · object[]

The parameters this scenario declares by name, each with an optional description and default. A run supplies values for these names, readable from the scenario's own text as params.NAME. A parameter marked secret carries no default: its value is supplied per run, encrypted, delivered to the target as secrets.NAME, and never readable from the scenario's own text.

Maximum array length: 20

Show child attributes

folderId · string | null

The test suite (folder) to file this scenario in. It must name a non-archived folder of the same project. null unfiles the scenario.

Response

201

application/json

Scenario created

id · string · required

name · string · required

situation · string · required

criteria · string[] · required

labels · string[] · required

parameters · object[] · required

Show child attributes

folderId · string | null · required

The test suite (folder) this scenario is filed in, or null when unfiled.

platformUrl · string<uri> · required