Skip to main content
PUT
/
api
/
scenarios
/
{id}
Python
import requests

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

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

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

print(response.text)
const options = {
  method: 'PUT',
  headers: {'X-Auth-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    situation: '<string>',
    criteria: ['<string>'],
    labels: ['<string>']
  })
};

fetch('https://app.langwatch.ai/api/scenarios/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
curl --request PUT \
  --url https://app.langwatch.ai/api/scenarios/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "name": "<string>",
  "situation": "<string>",
  "criteria": [
    "<string>"
  ],
  "labels": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "situation": "<string>",
  "criteria": [
    "<string>"
  ],
  "labels": [
    "<string>"
  ],
  "platformUrl": "<string>"
}
{
  "error": "<string>",
  "message": "<string>"
}
{
  "error": "<string>",
  "message": "<string>"
}
{
  "error": "<string>",
  "message": "<string>"
}
{
  "error": "<string>",
  "message": "<string>"
}
{
  "error": "<string>",
  "message": "<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
name
string
Minimum string length: 1
situation
string
criteria
string[]
labels
string[]

Response

Scenario updated

id
string
required
name
string
required
situation
string
required
criteria
string[]
required
labels
string[]
required
platformUrl
string<uri>
required