Skip to main content
GET
/
api
/
kb
/
collections
List Collections Api
curl --request GET \
  --url https://api.example.com/api/kb/collections \
  --header 'Authorization: Bearer <token>'
{
  "status": "<string>",
  "total_count": 123,
  "message": "<string>",
  "collections": [
    {
      "name": "<string>",
      "schema_version": "1.0.0",
      "embedding_model_id": "<string>",
      "embedding_dimension": 1,
      "documents": 0,
      "processed_documents": 0,
      "parses": 0,
      "chunks": 0,
      "embeddings": 0,
      "document_names": [
        "<string>"
      ],
      "collection_locked": false,
      "allow_mixed_parse_methods": false,
      "skip_config_validation": false,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "last_accessed_at": "2023-11-07T05:31:56Z",
      "extra_metadata": {}
    }
  ],
  "warnings": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

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

Response

200 - application/json

Successful Response

Response payload for the list collections operation.

status
string
required

Operation status: success|error

total_count
integer
required

Number of collections discovered

message
string
required

Human-readable status message

collections
CollectionInfo · object[]

Collection statistics

warnings
string[]

Non-fatal issues encountered during aggregation