Skip to main content
GET
/
collection
/
{collection_id}
Get collection details
curl --request GET \
  --url https://api.videodb.io/collection/{collection_id} \
  --header 'x-access-token: <api-key>'
{
  "success": true,
  "data": {
    "id": "default",
    "name": "My Collection",
    "description": "Collection description",
    "is_public": false,
    "owner": "u-12345",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.videodb.io/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve details for a specific collection by ID. Use "default" to get your default collection. 
import videodb

conn = videodb.connect(api_key="your_api_key")

# Get default collection
coll = conn.get_collection()

# Get specific collection
coll = conn.get_collection("c-a1b2c3d4")

print(f"Collection: {coll.name}")
  • Pass no arguments or "default" to access your default collection
  • Public collections can be accessed by anyone with the collection ID

Authorizations

​
x-access-token
string
header
required

API key for authentication (sk-xxx format)

Path Parameters

​
collection_id
string
required
Example:

"default"

Response

200 - application/json

Collection details

​
success
boolean
Example:

true

​
data
object