Skip to main content
PATCH
/
collection
/
{collection_id}
Update collection
curl --request PATCH \
  --url https://api.videodb.io/collection/{collection_id} \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "name": "Updated Collection Name",
  "description": "Updated description",
  "is_public": true
}
'
{
  "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.

Update a collection’s name, description, or visibility. 
import videodb

conn = videodb.connect(api_key="your_api_key")
coll = conn.update_collection(
    id="c-a1b2c3d4",
    name="Q1 2024 Demos",
    description="Updated product demos"
)

# Or update via collection object
coll = conn.get_collection("c-a1b2c3d4")
coll.make_public()  # Make collection publicly accessible
Use make_public() / makePublic() or make_private() / makePrivate() methods for visibility control.

Public Collections

Learn about sharing collections publicly

Authorizations

​
x-access-token
string
header
required

API key for authentication (sk-xxx format)

Path Parameters

​
collection_id
string
required
Example:

"default"

Body

application/json
​
name
string
Example:

"Updated Collection Name"

​
description
string
Example:

"Updated description"

​
is_public
boolean
Example:

true

Response

200 - application/json

Collection updated

​
success
boolean
Example:

true

​
data
object