Read Collection

Get collection by ID.

GET /api/v1/collections/{collection_id}

Read Collection

cURL

curl --request GET \
  --url https://api.example.com/api/v1/collections/{collection_id} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/collections/{collection_id}")
  .header("Authorization", "Bearer <token>")
  .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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

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