List Workflow Deployments

Beta

GET

https://api.vellum.ai/v1/workflow-deployments

GET

/v1/workflow-deployments

1 from vellum import Vellum
2 
3 client = Vellum(
4     api_key="YOUR_API_KEY",
5 )
6 client.workflow_deployments.list()

Try it

200listExample

1 {
2   "count": 123,
3   "next": "http://api.example.org/accounts/?offset=400&limit=100",
4   "previous": "http://api.example.org/accounts/?offset=200&limit=100",
5   "results": [
6     {
7       "id": "foo",
8       "name": "foo",
9       "label": "foo",
10       "created": "foo",
11       "last_deployed_on": "foo",
12       "input_variables": [
13         {
14           "id": "foo",
15           "key": "foo",
16           "type": "STRING",
17           "required": true,
18           "default": {
19             "type": "STRING",
20             "value": "foo"
21           },
22           "extensions": {
23             "color": "foo"
24           }
25         }
26       ],
27       "output_variables": [
28         {
29           "id": "foo",
30           "key": "foo",
31           "type": "STRING",
32           "required": true,
33           "default": {
34             "type": "STRING",
35             "value": "foo"
36           },
37           "extensions": {
38             "color": "foo"
39           }
40         }
41       ],
42       "status": "ACTIVE",
43       "environment": "DEVELOPMENT",
44       "description": "foo"
45     }
46   ]
47 }

Used to list all Workflow Deployments.

Query parameters

limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

orderingstringOptional

Which field to use when ordering the results.

statusenumOptional

status

Allowed values:

Response

countinteger or null

nextstring or nullformat: "uri"

previousstring or nullformat: "uri"

resultslist of objects or null

Headers

Query parameters

Response