Retrieve Workflow Deployment Release

GET

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

GET

/v1/workflow-deployments/:id/releases/:release_id_or_release_tag

1 curl https://api.vellum.ai/v1/workflow-deployments/id/releases/release_id_or_release_tag \
2      -H "X-API-KEY: <X-API-KEY>"

Try it

200retrieveWorkflowDeploymentReleaseExample

1 {
2   "id": "foo",
3   "created": "foo",
4   "environment": {
5     "id": "foo",
6     "name": "foo",
7     "label": "foo"
8   },
9   "workflow_version": {
10     "id": "foo",
11     "input_variables": [
12       {
13         "id": "foo",
14         "key": "foo",
15         "type": "STRING",
16         "required": true,
17         "default": {
18           "type": "STRING",
19           "value": "foo"
20         },
21         "extensions": {
22           "color": "foo"
23         }
24       }
25     ],
26     "output_variables": [
27       {
28         "id": "foo",
29         "key": "foo",
30         "type": "STRING",
31         "required": true,
32         "default": {
33           "type": "STRING",
34           "value": "foo"
35         },
36         "extensions": {
37           "color": "foo"
38         }
39       }
40     ]
41   },
42   "deployment": {
43     "name": "foo"
44   },
45   "release_tags": [
46     {
47       "name": "foo",
48       "source": "SYSTEM"
49     }
50   ],
51   "reviews": [
52     {
53       "id": "foo",
54       "created": "foo",
55       "reviewer": {
56         "id": "foo",
57         "full_name": "foo"
58       },
59       "state": "APPROVED"
60     }
61   ],
62   "created_by": {
63     "id": "foo",
64     "email": "foo",
65     "full_name": "foo"
66   },
67   "description": "foo"
68 }

Retrieve a specific Workflow Deployment Release by either its UUID or the name of a Release Tag that points to it.

Path parameters

idstringRequired

Either the Workflow Deployment’s ID or its unique name

release_id_or_release_tagstringRequired

Either the UUID of Workflow Deployment Release you’d like to retrieve, or the name of a Release Tag that’s pointing to the Workflow Deployment Release you’d like to retrieve.

Response

idstringformat: "uuid"

createdstringformat: "date-time"

environmentobject

workflow_versionobject

deploymentobject

release_tagslist of objects

reviewslist of objects

created_byobjectOptional

descriptionstringOptional

Path parameters

Headers

Response