FruxonDocs
ApiKnowledge bases

Lists the documents in a knowledge base, optionally filtered by title and status.

Returns the editable authoring documents for a knowledge base. The list includes drafts and archived documents because publish eligibility is controlled per document; pass `status` to narrow to one lifecycle state (for example `status=PUBLISHED` for the documents the next publish will index).

GET
/v1/tenants/{tenant}/knowledgeBases/{knowledgeBase}/documents

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

knowledgeBase*string

The knowledge base id.

Formatuuid
tenant*string

The tenant identifier

Query Parameters

PageSize?integer

The maximum number of items to return per page

Formatint32
PageToken.Skip?integer
Formatint32
PageToken.Cursor?string

Opaque cursor token from an external system (e.g. RAG API). When set, M:Fruxon.Common.Collections.PageToken.AsString returns this value directly instead of encoding Fruxon.Common.Collections.PageToken.Skip.

search?string

Optional case-insensitive substring of the document title. Wildcards are matched literally.

status?string

Optional lifecycle filter (DRAFT, PUBLISHED, or ARCHIVED). Omit for every status.

Value in"UNSPECIFIED" | "DRAFT" | "PUBLISHED" | "ARCHIVED"

Response Body

curl -X GET "https://api.fruxon.com/v1/tenants/string/knowledgeBases/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents"
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "knowledgeBaseId": "00000000-0000-0000-0000-000000000000",
      "title": "string",
      "bodyMarkdown": "string",
      "status": "DRAFT",
      "locale": "string",
      "tags": [
        "string"
      ],
      "metadata": {},
      "sourceConversationIds": [
        "string"
      ],
      "lastReviewedAt": 0,
      "lastReviewedBy": "string",
      "createdAt": 0,
      "modifiedAt": 0
    }
  ],
  "nextPageToken": "string",
  "totalCount": 0
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}