Retrieve Prompt Deployment

Beta

GET

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

idstringRequired

Either the Deployment’s ID or its unique name

This endpoint returns an object.

idstring

createddatetime

labelstring

A human-readable label for the deployment

namestring

A name that uniquely identifies this deployment within its workspace

last_deployed_ondatetime

input_variableslist of objects

last_deployed_history_item_idstring

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

active_model_version_idslist of stringsDeprecated

Deprecated. The Prompt execution endpoints return a prompt_version_id that could be used instead.

status"ACTIVE" or "ARCHIVED"Optional

Allowed values: ACTIVEARCHIVED

The current status of the deployment

environmentenumOptional

Allowed values: DEVELOPMENTSTAGINGPRODUCTION

The environment this deployment is used in

descriptionstringOptional

A human-readable description of the deployment

1	{
2	"id": "id",
3	"created": "2024-01-15T09:30:00Z",
4	"label": "label",
5	"name": "name",
6	"last_deployed_on": "2024-01-15T09:30:00Z",
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	"last_deployed_history_item_id": "last_deployed_history_item_id",
19	"active_model_version_ids": [
20	"active_model_version_ids"
21	],
22	"status": "ACTIVE",
23	"environment": "DEVELOPMENT",
24	"description": "description"
25	}

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