Retrieve Workflow Deployment

Beta

GET

Used to retrieve a workflow deployment given its ID or name.

idstringRequired

Either the Workflow Deployment's ID or its unique name

This endpoint returns an object.

idstring

namestring

A name that uniquely identifies this workflow deployment within its workspace

labelstring

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

environmentenumOptional

Allowed values: DEVELOPMENTSTAGINGPRODUCTION

The environment this workflow deployment is used in

descriptionstringOptional

A human-readable description of the workflow deployment

1	{
2	"id": "id",
3	"name": "name",
4	"label": "label",
5	"status": "ACTIVE",
6	"environment": "DEVELOPMENT",
7	"created": "2024-01-15T09:30:00Z",
8	"last_deployed_on": "2024-01-15T09:30:00Z",
9	"last_deployed_history_item_id": "last_deployed_history_item_id",
10	"input_variables": [
11	{
12	"id": "id",
13	"key": "key",
14	"type": "STRING"
15	}
16	],
17	"output_variables": [
18	{
19	"id": "id",
20	"key": "key",
21	"type": "STRING"
22	}
23	],
24	"description": "description"
25	}

1	curl https://api.vellum.ai/v1/workflow-deployments/id \
2	-H "X_API_KEY: <apiKey>"