Retrieve Prompt Deployment History | Vellum

DEPRECATED: This endpoint is deprecated and will be removed in a future release. Please use the retrieve_prompt_deployment_release xendpoint instead.

Path parameters

history_id_or_release_tagstringRequiredformat: "uuid"

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

idstringRequired

Either the Prompt Deployment's ID or its unique name

Headers

X-API-KEYstringRequired

Response

idstringformat: "uuid"

deployment_idstringformat: "uuid"

timestampstringformat: "date-time"

labelstring<=150 characters

A human-readable label for the deployment

namestring<=150 characters

A name that uniquely identifies this deployment within its workspace

input_variableslist of objects

descriptionstring or null

A human-readable description of the deployment

1	{
2	"id": "foo",
3	"deployment_id": "foo",
4	"timestamp": "foo",
5	"label": "foo",
6	"name": "foo",
7	"input_variables": [
8	{
9	"id": "foo",
10	"key": "foo",
11	"type": "STRING",
12	"required": true,
13	"default": {
14	"type": "STRING",
15	"value": "foo"
16	},
17	"extensions": {
18	"color": "foo"
19	}
20	}
21	],
22	"description": "foo"
23	}

1	import { VellumClient } from "vellum-ai";
2
3	const client = new VellumClient({ apiKey: "YOUR_API_KEY" });
4	await client.deployments.deploymentHistoryItemRetrieve("history_id_or_release_tag", "id");