Update Collection

Update collection.

PUT /api/v1/collections/{collection_id}

Update Collection

cURL

curl --request PUT \
  --url https://api.example.com/api/v1/collections/{collection_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "store_type": "<string>",
  "visibility": "<string>",
  "status": "<string>",
  "tags": [
    "<string>"
  ],
  "parent_id": "<string>",
  "stats": {},
  "meta_data": {},
  "settings": {},
  "embedding": {},
  "source_type": "<string>",
  "source_id": "<string>"
}
'

import requests

url = "https://api.example.com/api/v1/collections/{collection_id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "store_type": "<string>",
    "visibility": "<string>",
    "status": "<string>",
    "tags": ["<string>"],
    "parent_id": "<string>",
    "stats": {},
    "meta_data": {},
    "settings": {},
    "embedding": {},
    "source_type": "<string>",
    "source_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    store_type: '<string>',
    visibility: '<string>',
    status: '<string>',
    tags: ['<string>'],
    parent_id: '<string>',
    stats: {},
    meta_data: {},
    settings: {},
    embedding: {},
    source_type: '<string>',
    source_id: '<string>'
  })
};

fetch('https://api.example.com/api/v1/collections/{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.example.com/api/v1/collections/{collection_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'store_type' => '<string>',
    'visibility' => '<string>',
    'status' => '<string>',
    'tags' => [
        '<string>'
    ],
    'parent_id' => '<string>',
    'stats' => [
        
    ],
    'meta_data' => [
        
    ],
    'settings' => [
        
    ],
    'embedding' => [
        
    ],
    'source_type' => '<string>',
    'source_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.example.com/api/v1/collections/{collection_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"store_type\": \"<string>\",\n  \"visibility\": \"<string>\",\n  \"status\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"parent_id\": \"<string>\",\n  \"stats\": {},\n  \"meta_data\": {},\n  \"settings\": {},\n  \"embedding\": {},\n  \"source_type\": \"<string>\",\n  \"source_id\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://api.example.com/api/v1/collections/{collection_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"store_type\": \"<string>\",\n  \"visibility\": \"<string>\",\n  \"status\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"parent_id\": \"<string>\",\n  \"stats\": {},\n  \"meta_data\": {},\n  \"settings\": {},\n  \"embedding\": {},\n  \"source_type\": \"<string>\",\n  \"source_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/collections/{collection_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"store_type\": \"<string>\",\n  \"visibility\": \"<string>\",\n  \"status\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"parent_id\": \"<string>\",\n  \"stats\": {},\n  \"meta_data\": {},\n  \"settings\": {},\n  \"embedding\": {},\n  \"source_type\": \"<string>\",\n  \"source_id\": \"<string>\"\n}"

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

200

{
  "id": "<string>",
  "name": "<string>",
  "workspace_id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "description": "<string>",
  "store_type": "<string>",
  "visibility": "private",
  "status": "active",
  "tags": [
    "<string>"
  ],
  "parent_id": "<string>",
  "stats": {},
  "meta_data": {},
  "settings": {},
  "embedding": {},
  "source_type": "document",
  "source_id": "<string>",
  "created_by": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Workspace-Id · string | null

The workspace ID

Path Parameters

collection_id · string · required

Body

application/json

Schema for updating a collection.

name · string | null

Required string length: 1 - 100

description · string | null

Maximum string length: 255

store_type · string | null

visibility · string | null

status · string | null

tags · string[] | null

parent_id · string | null

stats · Stats · object | null

meta_data · Meta Data · object | null

settings · Settings · object | null

embedding · Embedding · object | null

source_type · string | null

source_id · string | null

Response

200

application/json

Successful Response

Schema for reading collection data.

id · string · required

Collection ID

name · string · required

Collection name

Required string length: 1 - 100

workspace_id · string · required

Reference to workspace

created_at · string | null

updated_at · string | null

description · string | null

Collection description

Maximum string length: 255

store_type · string enum<string>

Storage type for the collection

visibility · string · default: private

Collection visibility (private/public)

status · string · default: active

Collection status

tags · string[] | null

Collection tags for organization

parent_id · string | null

Reference to parent collection

stats · Stats · object

Collection statistics

meta_data · Meta Data · object

Collection metadata

settings · Settings · object

Collection configuration settings

embedding · EmbeddingModelSettings · object | null

Embedding configuration

Show child attributes

source_type · string | null · default: document

Collection source type

source_id · string | null

Collection source ID

created_by · string | null

User who created the collection