Deployments

Retrieve

Beta
GET
https://api.vellum.ai/v1/deployments/:id
Used to retrieve a deployment given its ID or name.

Path parameters

id
string
Either the Deployment's ID or its unique name

Response

This endpoint return an object.
id
string
created
datetime
label
string
A human-readable label for the deployment
name
string
A name that uniquely identifies this deployment within its workspace
last_deployed_on
datetime
input_variables
list of objects
active_model_version_ids
list of strings

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

status
optional enum

The current status of the deployment

  • ACTIVE - Active
  • ARCHIVED - Archived
Allowed values: ACTIVEARCHIVED
environment
optional enum

The environment this deployment is used in

  • DEVELOPMENT - Development
  • STAGING - Staging
  • PRODUCTION - Production
Allowed values: DEVELOPMENTSTAGINGPRODUCTION
GET
/v1/deployments/:id
curl https://api.vellum.ai/v1/deployments/id \
-H "X_API_KEY: <apiKey>"
Response
{
"id": "id",
"created": "2024-01-15T09:30:00Z",
"label": "label",
"name": "name",
"last_deployed_on": "2024-01-15T09:30:00Z",
"input_variables": [
{
"id": "id",
"key": "key",
"type": "STRING"
}
],
"active_model_version_ids": [
"active_model_version_ids"
],
"status": "ACTIVE",
"environment": "DEVELOPMENT"
}