Deploy Workflow Sandbox
Path parameters
id
A UUID string identifying this workflow sandbox.
workflow_id
An ID identifying the Workflow you'd like to deploy.
Headers
X-API-KEY
Request
This endpoint expects an object.
workflow_deployment_id
The Vellum-generated ID of the Workflow Deployment you’d like to update. Cannot specify both this and workflow_deployment_name. Leave null to create a new Workflow Deployment.
workflow_deployment_name
The unique name of the Workflow Deployment you’d like to either create or update. Cannot specify both this and workflow_deployment_id. If provided and matches an existing Workflow Deployment, that Workflow Deployment will be updated. Otherwise, a new Prompt Deployment will be created.
label
In the event that a new Workflow Deployment is created, this will be the label it's given.
release_description
Optionally provide a description that details what's new in this Release.
Response
id
name
A name that uniquely identifies this workflow deployment within its workspace
label
A human-readable label for the workflow deployment
created
last_deployed_on
last_deployed_history_item_id
The ID of the history item associated with this Workflow Deployment's LATEST Release Tag
input_variables
The input variables this Workflow Deployment expects to receive values for when it is executed.
output_variables
The output variables this Workflow Deployment produces values for when it's executed.
status
The current status of the workflow deployment
ACTIVE
- ActiveARCHIVED
- Archived
Allowed values:
environment
The environment this workflow deployment is used in
DEVELOPMENT
- DevelopmentSTAGING
- StagingPRODUCTION
- Production
Allowed values:
description
A human-readable description of the workflow deployment