Skip to main content
POST
/
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
});

const response = await client.knowledge.collections.documents.upload('x', {
  mimeType: 'x',
  name: 'x',
});

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

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

Body

application/json
name
string
required

Document name (filename)

Required string length: 1 - 255
mimeType
string
required

MIME type of the document

Minimum string length: 1
size
number

File size in bytes

Response

Document created with upload URL

document
object
required
uploadUrl
string
required

Presigned URL for uploading the file