List Workflow Deployment Releases

Beta

GET

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

GET

/v1/workflow-deployments/:id/releases

1 from vellum import Vellum
2 
3 client = Vellum(
4     api_version="YOUR_API_VERSION",
5     api_key="YOUR_API_KEY",
6 )
7 client.workflow_deployments.list_workflow_deployment_releases(
8     id="id",
9 )

Try it

200Retrieved

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": "string",
8       "created": "2024-01-15T09:30:00Z",
9       "environment": {
10         "id": "string",
11         "name": "string",
12         "label": "string"
13       },
14       "created_by": {
15         "id": "string",
16         "email": "string",
17         "full_name": "string"
18       },
19       "workflow_version": {
20         "id": "string",
21         "input_variables": [
22           {
23             "id": "string",
24             "key": "string",
25             "type": "STRING",
26             "required": true,
27             "default": {
28               "type": "STRING",
29               "value": "string"
30             },
31             "extensions": {
32               "color": "string"
33             }
34           }
35         ],
36         "output_variables": [
37           {
38             "id": "string",
39             "key": "string",
40             "type": "STRING",
41             "required": true,
42             "default": {
43               "type": "STRING",
44               "value": "string"
45             },
46             "extensions": {
47               "color": "string"
48             }
49           }
50         ]
51       },
52       "deployment": {
53         "name": "string"
54       },
55       "release_tags": [
56         {
57           "name": "string",
58           "source": "SYSTEM"
59         }
60       ],
61       "reviews": [
62         {
63           "id": "string",
64           "created": "2024-01-15T09:30:00Z",
65           "reviewer": {
66             "id": "string",
67             "full_name": "string"
68           },
69           "state": "APPROVED"
70         }
71       ],
72       "description": "string"
73     }
74   ]
75 }

List the Releases of the specified Workflow Deployment for the current Environment.

Authentication

X-API-KEYstring

API Key authentication via header

Path parameters

idstringRequired

Either the Workflow Deployment's ID or its unique name

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.

Response

countinteger or null

nextstring or nullformat: "uri"

previousstring or nullformat: "uri"

resultslist of objects or null

Authentication

Path parameters

Headers

Query parameters

Response