Deploy Workflow — Vellum

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_idstringOptional

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.

Response

idstring

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

createddatetime

last_deployed_ondatetime

last_deployed_history_item_idstring

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.

status"ACTIVE" or "ARCHIVED"Optional

Allowed values: ACTIVEARCHIVED

The current status of the workflow deployment

ACTIVE - Active
ARCHIVED - Archived

environmentenumOptional

Allowed values: DEVELOPMENTSTAGINGPRODUCTION

The environment this workflow deployment is used in

DEVELOPMENT - Development
STAGING - Staging
PRODUCTION - Production

descriptionstringOptional

A human-readable description of the workflow deployment

1	curl -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 '{}'

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	"required": true,
14	"default": {
15	"type": "SEARCH_RESULTS"
16	}
17	}
18	],
19	"output_variables": [
20	{
21	"id": "id",
22	"key": "key",
23	"type": "STRING",
24	"required": true,
25	"default": {
26	"type": "SEARCH_RESULTS"
27	}
28	}
29	],
30	"status": "ACTIVE",
31	"environment": "DEVELOPMENT",
32	"description": "description"
33	}