Skip to main content
GET
/
knowledge
/
collections
/
{collectionId}
/
documents
/
{documentId}
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 knowledgeDocument = await client.knowledge.collections.documents.retrieve('x', {
  collectionId: 'x',
});

console.log(knowledgeDocument.id);
{
  "id": "<string>",
  "collectionId": "<string>",
  "name": "<string>",
  "sourceUrl": "<string>",
  "mimeType": "<string>",
  "status": "pending",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "metadata": "<unknown>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

collectionId
string
required
Minimum string length: 1
documentId
string
required
Minimum string length: 1

Response

Document details

id
string
required

Unique document ID

collectionId
string
required

Collection ID

name
string
required

Document name

sourceUrl
string
required

S3 URL of the document

mimeType
string
required

MIME type

status
enum<string>
required

Processing status

Available options:
pending,
processing,
ready,
failed
createdAt
string
required

When the document was created

updatedAt
string
required

When the document was last updated

metadata
any | null

Document metadata