Skip to main content
POST
/
api
/
v1
/
collections
/
{collection_id}
/
archive
{
  "id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "name": "<string>",
  "description": "<string>",
  "store_type": "<string>",
  "visibility": "private",
  "status": "active",
  "tags": [
    "<string>"
  ],
  "parent_id": "<string>",
  "stats": {},
  "meta_data": {},
  "settings": {},
  "embedding": {
    "provider": "openai",
    "model": "<string>",
    "dimensions": 123,
    "use_default_cred": true,
    "credentials": {
      "api_key": "<string>",
      "credential_id": "<string>",
      "organization": "<string>",
      "base_url": "<string>",
      "batch_size": 123,
      "max_retries": 123,
      "timeout": 123
    }
  },
  "source_type": "<string>",
  "source_id": "<string>",
  "workspace_id": "<string>",
  "created_by": "<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

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 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
object

Collection statistics

meta_data
object

Collection metadata

settings
object

Collection configuration settings

embedding
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