Save an experiment's setup

Replace the experiment’s setup. Send expectedVersion with the version you read and the save is refused with a 409 when someone else wrote first, instead of overwriting their work.

PUT /api/v1/experiments/{slug}/workbench-state

Save an experiment's setup

Python

import requests

url = "https://app.langwatch.ai/api/v1/experiments/{slug}/workbench-state"

payload = { "state": {} }
headers = {
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

200

{
  "version": 0
}

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

slug · string · required

The experiment's slug, or its id

Minimum string length: 1

Body

application/json

state · object · required

The full setup to save

Show child attributes

expectedVersion · integer

The version you read. Sending it refuses the save when someone else already wrote on top of it.

Required range: -9007199254740991 <= x <= 9007199254740991

commitMessage · string

Names this version in the history list

Response

200

application/json

Success

version · integer · required

The version the save produced

Required range: -9007199254740991 <= x <= 9007199254740991