Client SDKPromptsPrompt Sandboxes

Deploy Prompt Sandbox

Beta

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

idstringRequiredformat: "uuid"
A UUID string identifying this sandbox.
prompt_variant_idstringRequired
An ID identifying the Prompt you'd like to deploy.

Headers

X-API-VersionstringOptional

Request

This endpoint expects an object.
prompt_deployment_idstring or nullOptionalformat: "uuid"

The Vellum-generated ID of the Prompt Deployment you’d like to update. Cannot specify both this and prompt_deployment_name. Leave null to create a new Prompt Deployment.

prompt_deployment_namestring or nullOptional>=1 character

The unique name of the Prompt Deployment you’d like to either create or update. Cannot specify both this and prompt_deployment_id. If provided and matches an existing Prompt Deployment, that Prompt Deployment will be updated. Otherwise, a new Prompt Deployment will be created.

labelstring or nullOptional>=1 character
In the event that a new Prompt Deployment is created, this will be the label it's given.
release_tagslist of strings or nullOptional

Optionally provide the release tags that you’d like to be associated with the latest release of the created/updated Prompt Deployment.

release_descriptionstring or nullOptional>=1 characterDefaults to
Optionally provide a description that details what's new in this Release.

Response

idstringformat: "uuid"
createdstringformat: "date-time"
labelstring<=150 characters

A human-readable label for the deployment

namestring<=150 characters
A name that uniquely identifies this deployment within its workspace
last_deployed_onstringformat: "date-time"
input_variableslist of objects
last_deployed_history_item_idstringformat: "uuid"
The ID of the history item associated with this Deployment's LATEST Release Tag
active_model_version_idslist of strings or nullDeprecated
Deprecated. This now always returns an empty array.
statusenum or null
The current status of the deployment * `ACTIVE` - Active * `ARCHIVED` - Archived
Allowed values:
environmentenum or null
Deprecated. The value returned will always be 'PRODUCTION'.
Allowed values:
descriptionstring or null

A human-readable description of the deployment