Get collection details

GET

/api/collections/{collectionId}

const url = 'https://firma.company-gpt.com/companygpt/rag/api/api/collections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
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/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Get metadata for a specific collection

Authorizations

BearerAuth

Parameters

Path Parameters

collectionId

required

string format: uuid

Collection UUID

Responses

200

Collection details

application/json

Collection record as returned by POST /api/collections, GET /api/collections/{id} and PUT /api/collections/{id} (database.Collection, encoded as-is — this is a different, lower-level shape than the enriched CollectionResponse used by the list endpoint).

object

required

string format: uuid

name

required

string

displayName

required

string

description

required

string

created_by

string format: uuid

nullable

owner_id

required

string format: uuid

visibility

required

string

Allowed values: private shared public

searchLanguage

required

PostgreSQL text search dictionary, e.g. “english”

string

type

required

string

Allowed values: rag dataset

chunkingStrategy

required

string

Allowed values: recursive markdown semantic

chunkSize

integer

nullable

chunkOverlap

integer

nullable

datasetMode

required

Empty for “rag” collections; “imported” or “live” for “dataset” collections

string

Allowed values: "" imported live

liveSchema

Live-dataset / structured-extraction schema (see LiveSchema)

object

lastIngestedAt

string format: date-time

nullable

structuredExtractionEnabled

required

boolean

extractionInstructions

Omitted from the JSON body when empty

string

extractionMaxPages

integer

nullable

imageDescriptionsEnabled

required

boolean

imageDescriptionMode

required

string

Allowed values: "" all empty_pages

embeddingModel

Omitted from the JSON body when empty

string

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "visibility": "private",
  "type": "rag",
  "chunkingStrategy": "recursive",
  "datasetMode": "",
  "imageDescriptionMode": ""
}

400

Invalid collection ID

401

Unauthorized

403

Access denied

404

Collection not found