Skip to main content
GET
/
api
/
v1
/
knowledge
/
documents
List knowledge documents
curl --request GET \
  --url http://127.0.0.1:4000/api/v1/knowledge/documents \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "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"
    }
  ]
}

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.

Query Parameters

​
projectId
string
Minimum string length: 1
​
status
enum<string>
Available options:
uploaded,
indexing,
indexed,
failed
​
limit
integer
Required range: 1 <= x <= 1000

Response

Knowledge document list

​
items
object[]
required