Upsert Prompt Sandbox Scenario | Vellum

Upserts a new scenario for a sandbox, keying off of the optionally provided scenario id. If an id is provided and has a match, the scenario will be updated. If no id is provided or no match is found, a new scenario will be appended to the end. Note that a full replacement of the scenario is performed, so any fields not provided will be removed or overwritten with default values.

Path parameters

idstringRequiredformat: "uuid"

A UUID string identifying this sandbox.

Request

This endpoint expects an object.

inputslist of objectsRequired

The inputs for the scenario

labelstringOptionalDefaults to Untitled Scenario

scenario_idstringOptional>=1 character

The id of the scenario to update. If none is provided, an id will be generated and a new scenario will be appended.

Response

inputslist of objects

The inputs for the scenario

idstring

The id of the scenario

labelstring or nullDefaults to Untitled Scenario

1	from vellum import NamedScenarioInputStringVariableValueRequest, Vellum
2
3	client = Vellum(
4	api_key="YOUR_API_KEY",
5	)
6	client.sandboxes.upsert_sandbox_scenario(
7	id="id",
8	label="Scenario 1",
9	inputs=[
10	NamedScenarioInputStringVariableValueRequest(
11	value="Hello, world!",
12	name="var_1",
13	),
14	NamedScenarioInputStringVariableValueRequest(
15	value="Why hello, there!",
16	name="var_2",
17	),
18	],
19	)

1	{
2	"inputs": [
3	{
4	"type": "STRING",
5	"value": "foo",
6	"input_variable_id": "foo"
7	}
8	],
9	"id": "foo",
10	"label": "Untitled Scenario"
11	}

Path parameters

Headers

Request

Response