List Prompt Deployments

Beta

GET

Used to list all Prompt Deployments.

limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

orderingstringOptional

Which field to use when ordering the results.

status"ACTIVE" or "ARCHIVED"Optional

status

Allowed values: ACTIVEARCHIVED

This endpoint returns an object.

countintegerOptional

nextstringOptional

previousstringOptional

resultslist of objectsOptional

1	{
2	"count": 123,
3	"next": "http://api.example.org/accounts/?offset=400&limit=100",
4	"previous": "http://api.example.org/accounts/?offset=200&limit=100",
5	"results": [
6	{
7	"id": "id",
8	"created": "2024-01-15T09:30:00Z",
9	"label": "label",
10	"name": "name",
11	"last_deployed_on": "2024-01-15T09:30:00Z",
12	"input_variables": [
13	{
14	"id": "id",
15	"key": "key",
16	"type": "STRING"
17	}
18	],
19	"status": "ACTIVE",
20	"environment": "DEVELOPMENT",
21	"description": "description"
22	}
23	]
24	}

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