Deploy Prompt Sandbox

Beta
POST

Path parameters

idstringRequired
A UUID string identifying this sandbox.
prompt_variant_idstringRequired
An ID identifying the Prompt you'd like to deploy.

Request

This endpoint expects an object.
prompt_deployment_idstringOptional

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_namestringOptional

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.

labelstringOptional
In the event that a new Prompt Deployment is created, this will be the label it's given.
release_tagslist of stringsOptional
Optionally provide the release tags that you'd like to be associated with the latest release of the created/updated Prompt Deployment.

Response

This endpoint returns an object
idstring
createddatetime
labelstring
A human-readable label for the deployment
namestring
A name that uniquely identifies this deployment within its workspace
last_deployed_ondatetime
input_variableslist of objects
last_deployed_history_item_idstring
The ID of the history item associated with this Deployment's LATEST Release Tag
active_model_version_idslist of stringsDeprecated

Deprecated. The Prompt execution endpoints return a prompt_version_id that could be used instead.

status"ACTIVE" or "ARCHIVED"Optional
Allowed values: ACTIVEARCHIVED

The current status of the deployment

  • ACTIVE - Active
  • ARCHIVED - Archived
environmentenumOptional
Allowed values: DEVELOPMENTSTAGINGPRODUCTION

The environment this deployment is used in

  • DEVELOPMENT - Development
  • STAGING - Staging
  • PRODUCTION - Production
descriptionstringOptional
A human-readable description of the deployment
Built with