Skip to main content
POST
/
api
/
v1
/
knowledge
/
documents
/
{id}
/
index
Index knowledge document
curl --request POST \
  --url http://127.0.0.1:4000/api/v1/knowledge/documents/{id}/index \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "commandId": "<string>",
  "maxChars": 2200,
  "overlapChars": 800
}
'
{
  "document": {
    "id": "<string>",
    "name": "<string>",
    "fileType": "<string>",
    "source": "<string>",
    "projectId": "<string>",
    "version": 123,
    "checksum": "<string>",
    "filePath": "<string>",
    "markdownPath": "<string>",
    "converterCommand": "<string>",
    "converterMeta": {},
    "errorMessage": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "chunkCount": 123,
  "embeddingModel": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://familyco.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required
Minimum string length: 1

Body

application/json
commandId
string
Minimum string length: 1
maxChars
integer
Required range: 400 <= x <= 4000
overlapChars
integer
Required range: 0 <= x <= 1600

Response

Indexing completed

document
object
required
chunkCount
integer
required
embeddingModel
string
required