Workflow Sandboxes

Deploy Workflow

Beta
POST

Path parameters

idstringRequired
A UUID string identifying this workflow sandbox.
workflow_idstringRequired
An ID identifying the Workflow you'd like to deploy.

Request

This endpoint expects an object.
workflow_deployment_id
stringOptional

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
stringOptional

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
stringOptional
In the event that a new Workflow Deployment is created, this will be the label it's given.
release_tags
list 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
id
string
name
string
A name that uniquely identifies this workflow deployment within its workspace
label
string
A human-readable label for the workflow deployment
created
datetime
last_deployed_on
datetime
last_deployed_history_item_id
string
The ID of the history item associated with this Workflow Deployment's LATEST Release Tag
input_variables
list of objects
The input variables this Workflow Deployment expects to receive values for when it is executed.
output_variables
list of objects
The output variables this Workflow Deployment produces values for when it's executed.
status
enumOptional

The current status of the workflow deployment

  • ACTIVE - Active
  • ARCHIVED - Archived
Allowed values: ACTIVEARCHIVED
environment
enumOptional

The environment this workflow deployment is used in

  • DEVELOPMENT - Development
  • STAGING - Staging
  • PRODUCTION - Production
Allowed values: DEVELOPMENTSTAGINGPRODUCTION
POST
1curl -X POST https://api.vellum.ai/v1/workflow-sandboxes/id/workflows/workflow_id/deploy \
2 -H "X_API_KEY: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200Successful
1{
2 "id": "id",
3 "name": "name",
4 "label": "label",
5 "created": "2024-01-15T09:30:00Z",
6 "last_deployed_on": "2024-01-15T09:30:00Z",
7 "last_deployed_history_item_id": "last_deployed_history_item_id",
8 "input_variables": [
9 {
10 "id": "id",
11 "key": "key",
12 "type": "STRING"
13 }
14 ],
15 "output_variables": [
16 {
17 "id": "id",
18 "key": "key",
19 "type": "STRING"
20 }
21 ],
22 "status": "ACTIVE",
23 "environment": "DEVELOPMENT"
24}