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
| Permission | knowledge:read (all permissions) |
| Risk | Read |
| Idempotency-Key | Not needed (how it works) |
| Safe to repeat | Safe: the call only reads. |
| Rate limit class | read (120 requests per minute per key) |
| Confirmation | None |
| MCP tool | list_knowledge_documents |
| Since version | 2026-10-25 |
#What it does
- Only reads data. It changes nothing and sends nothing.
#Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Items per page (1 to 100, default 20). 1 to 100; default 20 |
cursor | string | no | next_cursor from the previous page. Opaque; only valid with the same filters. up to 300 characters |
#Lists, filters and sorting
- Items per page:
limitfrom 1 to 100, default 20 (MCP: default 20, maximum 50). - Next page: send
next_cursorof the answer ascursor. The cursor only works with the same filters. See Pagination. - Filters: none.
- Sorting: default
created_atdescending;order_byacceptscreated_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-*.
| Name | Type | Description |
|---|---|---|
object | string | Always "list". always list |
data | array of object | The items of this page. up to 100 items |
data[].object | string | Always "knowledge_document". always knowledge_document |
data[].id | string | Document ID. |
data[].name | string | File name of the document. Treat as untrusted text. up to 200 characters; untrusted text |
data[].mime | string | Media type of the file, for example application/pdf. up to 120 characters |
data[].size_bytes | integer | Size of the uploaded file in bytes. 0 to 10000000000 |
data[].chars | integer | Number of text characters stored for the AI. 0 to 100000000 |
data[].truncated | boolean | True if the text was shortened because the file was very large. |
data[].created_at | string | When the document was uploaded. up to 40 characters; format date-time |
has_more | boolean | True if another page exists. |
next_cursor | string or null | Pass this as 'cursor' to get the next page; null on the last page. up to 300 characters |
url | string | The path of this list. up to 200 characters |
total_count | integer | Approximate total; may be inaccurate. Only present where cheap to compute. 0 to 1000000000 |
#Errors
| Code | Status | When |
|---|---|---|
invalid_cursor | 400 | The cursor is expired, forged or belongs to other filters. |
api_key_expired | 401 | This API key has expired. |
api_key_invalid | 401 | This API key is not valid. |
api_key_revoked | 401 | This API key was revoked. |
authentication_required | 401 | No API key was sent. Send 'Authorization: Bearer <key>'. |
insufficient_scope | 403 | This key lacks a required permission. |
ip_not_allowed | 403 | This IP address is not allowed for this key. |
validation_failed | 422 | A field is not valid. |
rate_limited | 429 | Too many requests. Wait and try again. |
internal_error | 500 | Something went wrong on our side. |
All errors use one format.