Read one scenario version

Get one saved version of a scenario, with the name, situation, criteria, labels and parameters as that version saved them.

GET /api/v1/scenarios/{id}/versions/{version}

Python

Python

import requests

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

headers = {"X-Auth-Token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "version": 0,
  "authorLabel": "<string>",
  "authorId": "<string>",
  "changeDescription": "<string>",
  "changedFields": [
    "<string>"
  ],
  "createdAt": "<string>",
  "isSynthesized": true,
  "schemaVersion": 0,
  "snapshot": {
    "name": "<string>",
    "situation": "<string>",
    "criteria": [
      "<string>"
    ],
    "labels": [
      "<string>"
    ],
    "parameters": [
      {
        "name": "<string>",
        "description": "<string>",
        "defaultValue": "<string>",
        "secret": true,
        "type": "string",
        "options": [
          "<string>"
        ],
        "required": true
      }
    ],
    "simulatorModel": "<string>",
    "judgeModel": "<string>",
    "maxTurns": 123,
    "minTurns": 123,
    "fields": {}
  }
}

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

Minimum string length: 1

version · integer · required

Required range: 1 <= x <= 9007199254740991

Response

200

application/json

Success

version · integer · required

The version number, counting from 1.

Required range: -9007199254740991 <= x <= 9007199254740991

authorLabel · string | null · required

Which surface wrote the version: user, api, cli or langy. Null on the synthesized Created entry of a scenario saved before versions were recorded.

authorId · string | null · required

The user who saved the version. Null when the save came from an API key.

changeDescription · string | null · required

changedFields · string[] · required

The fields whose value this save changed.

createdAt · string · required

When the version was written, in ISO 8601.

isSynthesized · boolean · required

True on the Created entry a scenario saved before versions were recorded shows. It has no stored snapshot, so it cannot be read back.

schemaVersion · integer · required

The shape the snapshot was written in.

Required range: -9007199254740991 <= x <= 9007199254740991

snapshot · object · required

The editable content of the case as this version saved it.

Show child attributes