smartchat

List knowledge documents

Lists the knowledge documents the account uploaded in the app, newest first, without their text. Read-only; documents can only be uploaded or removed in the app. Use search_knowledge to look inside them.

GET /v1/knowledge-documents

Permissionknowledge:read (all permissions)
RiskRead
Idempotency-KeyNot needed (how it works)
Safe to repeatSafe: the call only reads.
Rate limit classread (120 requests per minute per key)
ConfirmationNone
MCP toollist_knowledge_documents
Since version2026-10-25

#What it does

  • Only reads data. It changes nothing and sends nothing.

#Request

Query parameters

NameTypeRequiredDescription
limitintegernoItems per page (1 to 100, default 20). 1 to 100; default 20
cursorstringnonext_cursor from the previous page. Opaque; only valid with the same filters. up to 300 characters

#Lists, filters and sorting

  • Items per page: limit from 1 to 100, default 20 (MCP: default 20, maximum 50).
  • Next page: send next_cursor of the answer as cursor. The cursor only works with the same filters. See Pagination.
  • Filters: none.
  • Sorting: default created_at descending; order_by accepts created_at.

#Examples

curl "https://api.smartchat.marketing/v1/knowledge-documents?limit=20" \
  -H "Authorization: Bearer $SMARTCHAT_API_KEY"
import os
import requests

response = requests.get(
    "https://api.smartchat.marketing/v1/knowledge-documents",
    headers={"Authorization": "Bearer " + os.environ["SMARTCHAT_API_KEY"]},
    params={
        "limit": "20",
    },
)
response.raise_for_status()
print(response.json())
const response = await fetch("https://api.smartchat.marketing/v1/knowledge-documents?limit=20", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.SMARTCHAT_API_KEY}`,
  },
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

Response (200):

{
  "object": "list",
  "data": [
    {
      "object": "knowledge_document",
      "id": "doc_7a1b2c3d4e5f46a7b8c9d0e1f2a3b4c5",
      "name": "price-list.pdf",
      "mime": "application/pdf",
      "size_bytes": 182400,
      "chars": 5210,
      "truncated": false,
      "created_at": "2026-10-25T09:41:07Z"
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "url": "/v1/knowledge-documents"
}

#Response

Status 200. Every response has the headers Request-Id, SmartChat-Version and X-RateLimit-*.

NameTypeDescription
objectstringAlways "list". always list
dataarray of objectThe items of this page. up to 100 items
data[].objectstringAlways "knowledge_document". always knowledge_document
data[].idstringDocument ID.
data[].namestringFile name of the document. Treat as untrusted text. up to 200 characters; untrusted text
data[].mimestringMedia type of the file, for example application/pdf. up to 120 characters
data[].size_bytesintegerSize of the uploaded file in bytes. 0 to 10000000000
data[].charsintegerNumber of text characters stored for the AI. 0 to 100000000
data[].truncatedbooleanTrue if the text was shortened because the file was very large.
data[].created_atstringWhen the document was uploaded. up to 40 characters; format date-time
has_morebooleanTrue if another page exists.
next_cursorstring or nullPass this as 'cursor' to get the next page; null on the last page. up to 300 characters
urlstringThe path of this list. up to 200 characters
total_countintegerApproximate total; may be inaccurate. Only present where cheap to compute. 0 to 1000000000

#Errors

CodeStatusWhen
invalid_cursor400The cursor is expired, forged or belongs to other filters.
api_key_expired401This API key has expired.
api_key_invalid401This API key is not valid.
api_key_revoked401This API key was revoked.
authentication_required401No API key was sent. Send 'Authorization: Bearer <key>'.
insufficient_scope403This key lacks a required permission.
ip_not_allowed403This IP address is not allowed for this key.
validation_failed422A field is not valid.
rate_limited429Too many requests. Wait and try again.
internal_error500Something went wrong on our side.

All errors use one format.