Prompt Collections
Retrieve Prompt Collection
API Reference
Virtual Keys
Prompts
- POSTCreate Prompt
- GETList Prompts
- GETRetrieve Prompt
- PUTUpdate Prompt
- DELDelete Prompt
- PUTPublish Prompt
- GETList Prompt Versions
- GETRetrieve Prompt Version
- PUTUpdate Prompt Version
- Prompt Partials
- Prompt Labels
- Prompt Collections
API Keys
Analytics [BETA]
- Summary
- Groups Paginated Data
- Graphs - Time Series Data
User Invites
Workspaces
Workspace Members
Audit Logs
OpenAPI
Retrieve Prompt Collection
Retrieves details of a specific collection
GET
/
collections
/
{collectionId}
curl --request GET \
--url https://api.portkey.ai/v1/collections/{collectionId} \
--header 'x-portkey-api-key: <api-key>'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"parent_collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_default": true,
"status": "active",
"created_at": "2023-11-07T05:31:56Z",
"last_updated_at": "2023-11-07T05:31:56Z",
"child_collections": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"last_updated_at": "2023-11-07T05:31:56Z",
"collection_details": {
"child_collections_count": 123,
"prompts_count": 123,
"child_collections_last_updated_at": "2023-11-07T05:31:56Z",
"prompts_last_updated_at": "2023-11-07T05:31:56Z"
}
}
]
}
Authorizations
Path Parameters
ID or slug of the collection
Response
200
application/json
Collection details
Available options:
active
, archived
Was this page helpful?
curl --request GET \
--url https://api.portkey.ai/v1/collections/{collectionId} \
--header 'x-portkey-api-key: <api-key>'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"parent_collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_default": true,
"status": "active",
"created_at": "2023-11-07T05:31:56Z",
"last_updated_at": "2023-11-07T05:31:56Z",
"child_collections": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"last_updated_at": "2023-11-07T05:31:56Z",
"collection_details": {
"child_collections_count": 123,
"prompts_count": 123,
"child_collections_last_updated_at": "2023-11-07T05:31:56Z",
"prompts_last_updated_at": "2023-11-07T05:31:56Z"
}
}
]
}