Retrieve Prompt Deployment | Vellum

Used to retrieve a Prompt Deployment given its ID or name.

idstringRequired

Either the Prompt Deployment's ID or its unique name

idstringformat: "uuid"

createdstringformat: "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

last_deployed_onstringformat: "date-time"

input_variableslist of objects

last_deployed_history_item_idstringformat: "uuid"

The ID of the history item associated with this Deployment's LATEST Release Tag

statusenum or null

The current status of the deployment

Allowed values:

environmentenum or null

The environment this deployment is used in

Allowed values:

descriptionstring or null

A human-readable description of the deployment

active_model_version_idslist of strings or nullDeprecated

Deprecated. This now always returns an empty array.

1	from vellum import Vellum
2
3	client = Vellum(
4	api_key="YOUR_API_KEY",
5	)
6	client.deployments.retrieve(
7	id="id",
8	)

1	{
2	"id": "foo",
3	"created": "foo",
4	"label": "foo",
5	"name": "foo",
6	"last_deployed_on": "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	"last_deployed_history_item_id": "foo",
23	"status": "ACTIVE",
24	"environment": "DEVELOPMENT",
25	"description": "foo",
26	"active_model_version_ids": [
27	"foo"
28	]
29	}