List Workflow Deployments | Vellum

1 import { VellumClient } from "vellum-ai"; 2 3 const client = new VellumClient({ apiKey: "YOUR_API_KEY" }); 4 await client.workflowDeployments.list();

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": "id", 8 "name": "name", 9 "label": "label", 10 "created": "2024-01-15T09:30:00Z", 11 "last_deployed_on": "2024-01-15T09:30:00Z", 12 "input_variables": [ 13 { 14 "id": "id", 15 "key": "key", 16 "type": "STRING" 17 } 18 ], 19 "output_variables": [ 20 { 21 "id": "id", 22 "key": "key", 23 "type": "STRING" 24 } 25 ], 26 "status": "ACTIVE", 27 "environment": "DEVELOPMENT", 28 "description": "description" 29 } 30 ] 31 }

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

countintegerOptional

nextstringOptionalformat: "uri"

previousstringOptionalformat: "uri"

resultslist of objectsOptional

Headers

Query parameters

Response