Upsert Prompt Sandbox Scenario

Beta

POST

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

idstringRequired

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

labelstringOptionalDefaults to Untitled Scenario

Built with

1	curl -X POST https://api.vellum.ai/v1/sandboxes/id/scenarios \
2	-H "X_API_KEY: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"inputs": [
6	{
7	"type": "CHAT_HISTORY",
8	"name": "var_1",
9	"value": [
10	{
11	"role": "SYSTEM"
12	}
13	]
14	},
15	{
16	"type": "CHAT_HISTORY",
17	"name": "var_2",
18	"value": [
19	{
20	"role": "SYSTEM"
21	}
22	]
23	}
24	],
25	"label": "Scenario 1"
26	}'

1	{
2	"inputs": [
3	{
4	"type": "CHAT_HISTORY",
5	"input_variable_id": "inputs",
6	"value": [
7	{
8	"role": "SYSTEM"
9	}
10	]
11	}
12	],
13	"id": "id",
14	"label": "label"
15	}