List collections

GET

/api/collections

const url = 'https://firma.company-gpt.com/companygpt/rag/api/api/collections?filter=mine';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://firma.company-gpt.com/companygpt/rag/api/api/collections?filter=mine' \
  --header 'Authorization: Bearer <token>'

List collections accessible to the caller. Not paginated — returns every matching collection.

Authorizations

BearerAuth

Parameters

Query Parameters

filter

string

Allowed values: mine shared public all

Scope of collections to return (default: all)

Responses

200

List of collections

application/json

Response for GET /api/collections. Note there is no pagination — the endpoint returns every collection the “filter” query selects in a single array.

object

collections

required

Array<object>

Enriched collection representation returned ONLY by GET /api/collections (the list endpoint) — adds RBAC/display metadata not present on CollectionInfo.

object

required

string format: uuid

name

required

string

displayName

required

string

description

required

string

ownerId

required

string format: uuid

owner

object

required

string format: uuid

email

required

string

name

string

visibility

required

string

Allowed values: private shared public

searchLanguage

required

string

collectionType

required

string

Allowed values: rag dataset

datasetMode

string

Allowed values: imported live

liveSchema

object

structuredExtractionEnabled

required

boolean

extractionInstructions

string

extractionMaxPages

integer

nullable

imageDescriptionsEnabled

required

boolean

imageDescriptionMode

string

Allowed values: all empty_pages

tableSizeBytes

required

Total on-disk size of the vector table including indexes

integer format: int64

myRole

required

string

Allowed values: owner admin viewer

shareCount

required

integer

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "collections": [
    {
      "visibility": "private",
      "collectionType": "rag",
      "datasetMode": "imported",
      "imageDescriptionMode": "all",
      "myRole": "owner"
    }
  ]
}

400

Invalid filter value

401

Unauthorized