Retrieve Workflow Deployment History

Beta

GET

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

Path parameters

history_id_or_release_tagstringRequired

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

idstringRequired

A UUID string identifying this workflow deployment.

Response

idstring

workflow_deployment_idstring

timestampdatetime

labelstring<=150 characters

A human-readable label for the workflow deployment

namestring<=150 characters

A name that uniquely identifies this workflow deployment within its workspace

input_variableslist of objects

output_variableslist of objects

descriptionstringOptional

A human-readable description of the workflow deployment

Built with

1	{
2	"id": "id",
3	"workflow_deployment_id": "workflow_deployment_id",
4	"timestamp": "2024-01-15T09:30:00Z",
5	"label": "label",
6	"name": "name",
7	"input_variables": [
8	{
9	"id": "id",
10	"key": "key",
11	"type": "STRING",
12	"required": true,
13	"default": {
14	"type": "SEARCH_RESULTS"
15	}
16	}
17	],
18	"output_variables": [
19	{
20	"id": "id",
21	"key": "key",
22	"type": "STRING",
23	"required": true,
24	"default": {
25	"type": "SEARCH_RESULTS"
26	}
27	}
28	],
29	"description": "description"
30	}

1	curl https://api.vellum.ai/v1/workflow-deployments/id/history/history_id_or_release_tag \
2	-H "X_API_KEY: <apiKey>"