For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
BlogLog InRequest Demo
HomeProductDevelopersSelf-HostingChangelog
HomeProductDevelopersSelf-HostingChangelog
  • Getting Started
    • Overview
  • Workflows SDK
    • Introduction
    • Installation
    • Core Concepts
    • Defining Control Flow
    • Configuration
    • Custom Docker Images
  • Client SDK
    • Introduction
    • Authentication
    • API Versioning
      • POSTExecute Prompt
      • STREAMExecute Prompt as Stream
      • POSTSubmit Prompt Execution Actuals
      • POSTRetrieve Provider Payload
        • GETList Prompt Deployments
        • GETRetrieve Prompt Deployment
        • GETRetrieve Prompt Deployment Release
        • GETRetrieve Prompt Deployment Release Tag
        • GETList Prompt Deployment Release Tags
        • PATCHUpdate Prompt Deployment Release Tag
        • GETRetrieve Prompt Deployment History
LogoLogo
BlogLog InRequest Demo
Client SDKPromptsPrompt Deployments

Retrieve Prompt Deployment

Beta
GET
https://api.vellum.ai/v1/deployments/:id
GET
/v1/deployments/:id
1import requests
2
3url = "https://api.vellum.ai/v1/deployments/id"
4
5headers = {"X-API-KEY": "<apiKey>"}
6
7response = requests.get(url, headers=headers)
8
9print(response.json())
200Retrieved
1{
2  "id": "string",
3  "created": "2024-01-15T09:30:00Z",
4  "label": "string",
5  "name": "string",
6  "last_deployed_on": "2024-01-15T09:30:00Z",
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  "last_deployed_history_item_id": "string",
26  "active_model_version_ids": [
27    "string"
28  ],
29  "status": "ACTIVE",
30  "environment": "DEVELOPMENT",
31  "description": "string"
32}
Used to retrieve a Prompt Deployment given its ID or name.
Was this page helpful?
Previous

Retrieve Prompt Deployment Release

Next
Built with

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

idstringRequired
Either the Prompt Deployment's ID or its unique name

Headers

X-API-VersionstringOptional

Response

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
active_model_version_idslist of strings or nullRead-onlyDeprecated
Deprecated. This now always returns an empty array.
statusenum

The current status of the deployment

  • ACTIVE - Active
  • ARCHIVED - Archived
  • PENDING_DELETION - Pending Deletion
Allowed values:
environmentenum or null
Deprecated. The value returned will always be 'PRODUCTION'.
Allowed values:
descriptionstring or null

A human-readable description of the deployment