Workflow Deployments

Retrieve

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

Path parameters

idstringRequired
Either the Workflow Deployment's ID or its unique name

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
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
GET
$curl https://api.vellum.ai/v1/workflow-deployments/id \
> -H "X_API_KEY: <apiKey>"
Response
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 "input_variables": [
8 {
9 "id": "id",
10 "key": "key",
11 "type": "STRING"
12 }
13 ],
14 "output_variables": [
15 {
16 "id": "id",
17 "key": "key",
18 "type": "STRING"
19 }
20 ],
21 "status": "ACTIVE",
22 "environment": "DEVELOPMENT"
23}