Deployments

List

GET
https://api.vellum.ai/v1/deployments

Query parameters

limit
optional integer
Number of results to return per page.
offset
optional integer
The initial index from which to return the results.
ordering
optional string
Which field to use when ordering the results.
status
optional enum
status
Allowed values: ACTIVEARCHIVED

Response

This endpoint return an object.
count
optional integer
next
optional string
previous
optional string
results
optional list of objects
GET
/v1/deployments
curl https://api.vellum.ai/v1/deployments \
-H "X_API_KEY: <apiKey>"
Response
{
"count": 1,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"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"
}
],
"status": "ACTIVE",
"environment": "DEVELOPMENT"
}
]
}