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

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

// Automatically fetches more pages as needed.
for await (const knowledgeDocument of client.knowledge.collections.documents.list('x')) {
  console.log(knowledgeDocument.id);
}
{
  "data": [
    {
      "id": "<string>",
      "collectionId": "<string>",
      "name": "<string>",
      "sourceUrl": "<string>",
      "mimeType": "<string>",
      "status": "pending",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "metadata": "<unknown>"
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true
}

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

Query Parameters

limit
number
default:20
Required range: 1 <= x <= 100
cursor
string
status
enum<string>
Available options:
pending,
processing,
ready,
failed

Response

List of documents

data
object[]
required
nextCursor
string | null
required
hasMore
boolean
required