Skip to main content
GET
/
knowledge
/
collections
/
{id}
JavaScript
import Reminix from '@reminix/sdk';

const client = new Reminix({
  apiKey: process.env['REMINIX_API_KEY'], // This is the default and can be omitted
});

const knowledgeCollection = await client.knowledge.collections.retrieve('x');

console.log(knowledgeCollection.id);
{
  "id": "<string>",
  "projectId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "embeddingModel": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "documentCount": 123,
  "readyDocumentCount": 123
}

Authorizations

Authorization
string
header
required

API Key or Personal Access Token (PAT). When using PAT, include X-Project header.

Path Parameters

id
string
required
Minimum string length: 1

Response

Collection details

id
string
required

Unique collection ID

projectId
string
required

Project ID

name
string
required

Collection name

description
string | null
required

Collection description

embeddingModel
string
required

Embedding model used

createdAt
string
required

When the collection was created

updatedAt
string
required

When the collection was last updated

documentCount
number

Total number of documents

readyDocumentCount
number

Number of processed documents