Skip to main content
POST
/
api
/
v1
/
collections
Create Collection
curl --request POST \
  --url https://api.example.com/api/v1/collections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<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>"
}
'
import requests

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

payload = {
"name": "<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>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<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>'
})
};

fetch('https://api.example.com/api/v1/collections', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<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>'
]),
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"

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

req, _ := http.NewRequest("POST", 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.post("https://api.example.com/api/v1/collections")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"store_type\": \"<string>\",\n \"visibility\": \"private\",\n \"status\": \"active\",\n \"tags\": [\n \"<string>\"\n ],\n \"parent_id\": \"<string>\",\n \"stats\": {},\n \"meta_data\": {},\n \"settings\": {},\n \"embedding\": {},\n \"source_type\": \"document\",\n \"source_id\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.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\": \"private\",\n \"status\": \"active\",\n \"tags\": [\n \"<string>\"\n ],\n \"parent_id\": \"<string>\",\n \"stats\": {},\n \"meta_data\": {},\n \"settings\": {},\n \"embedding\": {},\n \"source_type\": \"document\",\n \"source_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "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

Body

application/json

Schema for creating a new collection.

name
string
required

Collection name

Required string length: 1 - 100
description
string | null

Collection description

Maximum string length: 255
store_type

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

source_type
string | null
default:document

Collection source type

source_id
string | null

Collection source ID

Response

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

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

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