Retrieve Prompt Deployment History | Vellum

import requests
url = "https://api.vellum.ai/v1/deployments/id/history/history_id_or_release_tag"
headers = {"X-API-KEY": "<apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "id": "string",
  "deployment_id": "string",
  "timestamp": "2024-01-15T09:30:00Z",
  "label": "string",
  "name": "string",
  "input_variables": [
    {
      "id": "string",
      "key": "string",
      "type": "STRING",
      "required": true,
      "default": {
        "type": "STRING",
        "value": "string"
      },
      "extensions": {
        "color": "string",
        "description": "string",
        "title": "string"
      },
      "schema": {}
    }
  ],
  "description": "string"
}

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

Authentication

X-API-KEYstring

API Key authentication via header

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-VersionstringOptional

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	import requests
2
3	url = "https://api.vellum.ai/v1/deployments/id/history/history_id_or_release_tag"
4
5	headers = {"X-API-KEY": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

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