Update Collection

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
}
'

const options = {
  method: 'PATCH',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Updated Collection Name',
    description: 'Updated description',
    is_public: true
  })
};

fetch('https://api.videodb.io/collection/{collection_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.videodb.io/collection/{collection_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Updated Collection Name',
    'description' => 'Updated description',
    'is_public' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-access-token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.videodb.io/collection/{collection_id}"

	payload := strings.NewReader("{\n  \"name\": \"Updated Collection Name\",\n  \"description\": \"Updated description\",\n  \"is_public\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-access-token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.videodb.io/collection/{collection_id}")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Updated Collection Name\",\n  \"description\": \"Updated description\",\n  \"is_public\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.videodb.io/collection/{collection_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Updated Collection Name\",\n  \"description\": \"Updated description\",\n  \"is_public\": true\n}"

response = http.request(request)
puts response.read_body

$headers=@{}
$headers.Add("x-access-token", "<api-key>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://api.videodb.io/collection/{collection_id}' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
  "name": "Updated Collection Name",
  "description": "Updated description",
  "is_public": true
}'

import Foundation

let parameters = [
  "name": "Updated Collection Name",
  "description": "Updated description",
  "is_public": true
] as [String : Any?]

let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])

let url = URL(string: "https://api.videodb.io/collection/{collection_id}")!
var request = URLRequest(url: url)
request.httpMethod = "PATCH"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
  "x-access-token": "<api-key>",
  "Content-Type": "application/json"
]
request.httpBody = postData

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))

using RestSharp;


var options = new RestClientOptions("https://api.videodb.io/collection/{collection_id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n  \"name\": \"Updated Collection Name\",\n  \"description\": \"Updated description\",\n  \"is_public\": true\n}", false);
var response = await client.PatchAsync(request);

Console.WriteLine("{0}", response.Content);

using RestSharp;


var options = new RestClientOptions("https://api.videodb.io/collection/{collection_id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n  \"name\": \"Updated Collection Name\",\n  \"description\": \"Updated description\",\n  \"is_public\": true\n}", false);
var response = await client.PatchAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'PATCH',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Updated Collection Name',
    description: 'Updated description',
    is_public: true
  })
};

fetch('https://api.videodb.io/collection/{collection_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.videodb.io/collection/{collection_id}");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-access-token: <api-key>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n  \"name\": \"Updated Collection Name\",\n  \"description\": \"Updated description\",\n  \"is_public\": true\n}");

CURLcode ret = curl_easy_perform(hnd);

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.videodb.io/collection/{collection_id}");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-access-token: <api-key>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n  \"name\": \"Updated Collection Name\",\n  \"description\": \"Updated description\",\n  \"is_public\": true\n}");

CURLcode ret = curl_easy_perform(hnd);

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n  \"name\": \"Updated Collection Name\",\n  \"description\": \"Updated description\",\n  \"is_public\": true\n}")
val request = Request.Builder()
  .url("https://api.videodb.io/collection/{collection_id}")
  .patch(body)
  .addHeader("x-access-token", "<api-key>")
  .addHeader("Content-Type", "application/json")
  .build()

val response = client.newCall(request).execute()

{
  "success": true,
  "data": {
    "id": "default",
    "name": "My Collection",
    "description": "Collection description",
    "is_public": false,
    "owner": "u-12345",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

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
}
'

const options = {
  method: 'PATCH',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Updated Collection Name',
    description: 'Updated description',
    is_public: true
  })
};

fetch('https://api.videodb.io/collection/{collection_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.videodb.io/collection/{collection_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Updated Collection Name',
    'description' => 'Updated description',
    'is_public' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-access-token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.videodb.io/collection/{collection_id}"

	payload := strings.NewReader("{\n  \"name\": \"Updated Collection Name\",\n  \"description\": \"Updated description\",\n  \"is_public\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-access-token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.videodb.io/collection/{collection_id}")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Updated Collection Name\",\n  \"description\": \"Updated description\",\n  \"is_public\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.videodb.io/collection/{collection_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Updated Collection Name\",\n  \"description\": \"Updated description\",\n  \"is_public\": true\n}"

response = http.request(request)
puts response.read_body

$headers=@{}
$headers.Add("x-access-token", "<api-key>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://api.videodb.io/collection/{collection_id}' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
  "name": "Updated Collection Name",
  "description": "Updated description",
  "is_public": true
}'

import Foundation

let parameters = [
  "name": "Updated Collection Name",
  "description": "Updated description",
  "is_public": true
] as [String : Any?]

let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])

let url = URL(string: "https://api.videodb.io/collection/{collection_id}")!
var request = URLRequest(url: url)
request.httpMethod = "PATCH"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
  "x-access-token": "<api-key>",
  "Content-Type": "application/json"
]
request.httpBody = postData

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))

using RestSharp;


var options = new RestClientOptions("https://api.videodb.io/collection/{collection_id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n  \"name\": \"Updated Collection Name\",\n  \"description\": \"Updated description\",\n  \"is_public\": true\n}", false);
var response = await client.PatchAsync(request);

Console.WriteLine("{0}", response.Content);

using RestSharp;


var options = new RestClientOptions("https://api.videodb.io/collection/{collection_id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-access-token", "<api-key>");
request.AddJsonBody("{\n  \"name\": \"Updated Collection Name\",\n  \"description\": \"Updated description\",\n  \"is_public\": true\n}", false);
var response = await client.PatchAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'PATCH',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Updated Collection Name',
    description: 'Updated description',
    is_public: true
  })
};

fetch('https://api.videodb.io/collection/{collection_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.videodb.io/collection/{collection_id}");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-access-token: <api-key>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n  \"name\": \"Updated Collection Name\",\n  \"description\": \"Updated description\",\n  \"is_public\": true\n}");

CURLcode ret = curl_easy_perform(hnd);

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.videodb.io/collection/{collection_id}");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-access-token: <api-key>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n  \"name\": \"Updated Collection Name\",\n  \"description\": \"Updated description\",\n  \"is_public\": true\n}");

CURLcode ret = curl_easy_perform(hnd);

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n  \"name\": \"Updated Collection Name\",\n  \"description\": \"Updated description\",\n  \"is_public\": true\n}")
val request = Request.Builder()
  .url("https://api.videodb.io/collection/{collection_id}")
  .patch(body)
  .addHeader("x-access-token", "<api-key>")
  .addHeader("Content-Type", "application/json")
  .build()

val response = client.newCall(request).execute()

{
  "success": true,
  "data": {
    "id": "default",
    "name": "My Collection",
    "description": "Collection description",
    "is_public": false,
    "owner": "u-12345",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

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

import { connect } from 'videodb';

const conn = connect({ apiKey: 'your_api_key' });
const coll = await conn.updateCollection(
    'c-a1b2c3d4',
    'Q1 2024 Demos',
    'Updated product demos'
);

// Or update via collection object
const coll = await conn.getCollection('c-a1b2c3d4');
await coll.makePublic();  // 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

Show child attributes

⌘I

Overview

Authentication

Collections

Videos

Streaming & Playback

Transcription

Search V2 & Ask

Indexing & Search

Scene & Frame Analysis

Advanced Operations

Audio

Images

AI Generation

Timeline & Compilation

Billing

Downloads

Utilities

Assets

Editor

Transcode

Meeting

Capture

RTStream

RTStream Transcription

RTStream Scene Indexing

RTStream Events & Alerts

Public Collections

Authorizations

Path Parameters

Body

Response