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

console.log(response.document);
{
  "message": "<string>",
  "document": {
    "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

Body

application/json
preferUnstructured
boolean

Use Unstructured.io for extraction if available

Response

Processing started

message
string
required
document
object
required