Client SDKWorkflowsWorkflow Sandboxes

Deploy Workflow Sandbox

Path parameters

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

Headers

X-API-KEYstringRequired

Request

This endpoint expects an object.
workflow_deployment_idstringOptionalformat: "uuid"

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_namestringOptional>=1 character

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.

labelstringOptional>=1 character
In the event that a new Workflow 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.

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

Response

idstringformat: "uuid"
namestring<=150 characters
A name that uniquely identifies this workflow deployment within its workspace
labelstring<=150 characters

A human-readable label for the workflow deployment

createdstringformat: "date-time"
last_deployed_onstringformat: "date-time"
last_deployed_history_item_idstringformat: "uuid"
The ID of the history item associated with this Workflow Deployment's LATEST Release Tag
input_variableslist of objects
The input variables this Workflow Deployment expects to receive values for when it is executed.
output_variableslist of objects
The output variables this Workflow Deployment produces values for when it's executed.
statusenumOptional

The current status of the workflow deployment

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

The environment this workflow deployment is used in

  • DEVELOPMENT - Development
  • STAGING - Staging
  • PRODUCTION - Production
Allowed values:
descriptionstringOptional

A human-readable description of the workflow deployment