Skip to main content
POST
/
api
/
suites
Python
import requests

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

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

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

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

fetch('https://app.langwatch.ai/api/suites', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
curl --request POST \
--url https://app.langwatch.ai/api/suites \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--data '
{
"name": "<string>",
"scenarioIds": [
"<string>"
],
"targets": [
{
"referenceId": "<string>"
}
]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "scenarioIds": [
    "<string>"
  ],
  "targets": [
    {
      "referenceId": "<string>"
    }
  ],
  "repeatCount": 123,
  "labels": [
    "<string>"
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "platformUrl": "<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.

Body

application/json
name
string
required
Minimum string length: 1
scenarioIds
string[]
required
Minimum array length: 1
targets
object[]
required
Minimum array length: 1
description
string
repeatCount
integer
default:1
Required range: 1 <= x <= 100
labels
string[]

Response

Suite created

id
string
required
name
string
required
slug
string
required
description
string | null
required
scenarioIds
string[]
required
targets
object[]
required
repeatCount
number
required
labels
string[]
required
createdAt
string
required
updatedAt
string
required
platformUrl
string<uri>
required