Skip to main content
POST
/
api
/
suites
/
{id}
/
run
Python
import requests

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

payload = { "idempotencyKey": "<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({idempotencyKey: '<string>'})
};

fetch('https://app.langwatch.ai/api/suites/{id}/run', 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/{id}/run \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "idempotencyKey": "<string>"
}
'
{
  "scheduled": true,
  "batchRunId": "<string>",
  "setId": "<string>",
  "jobCount": 123,
  "skippedArchived": {
    "scenarios": [
      "<string>"
    ],
    "targets": [
      "<string>"
    ]
  },
  "items": [
    {
      "scenarioRunId": "<string>",
      "scenarioId": "<string>",
      "target": {
        "referenceId": "<string>"
      },
      "name": "<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
idempotencyKey
string

Response

Suite run scheduled

scheduled
boolean
required
batchRunId
string
required
setId
string
required
jobCount
number
required
skippedArchived
object
required
items
object[]
required