API reference
List a knowledge base's sources
GET /v1/knowledge-bases/{knowledge_base_id}/documents
Every source in a knowledge base — your files, the pages of a website it read, and its topics — newest first, each with where it is in indexing. Filter by status. Needs knowledge:read.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
knowledge_base_id |
path | string (uuid) | Yes | |
status |
query | KnowledgeDocumentStatus or null | No | Only sources in this state. |
limit |
query | integer | No | How many to return, 1 to 100. |
cursor |
query | string or null | No | next_cursor from the previous page, with the same filters. |
Answer
200 with KnowledgeDocumentList.
Errors
Every error is a problem document with a stable code.
| Status | When |
|---|---|
401 |
The key is missing, mistyped, unknown, revoked or expired. |
403 |
The key lacks a permission, a live key was sent from a browser, or the organization is frozen and the request would change something. |
404 |
This key reaches no such knowledge base. |
422 |
Validation Error |
429 |
Too many requests for this key or its organization; see Retry-After. |
500 |
Something went wrong on our side. Quote the request_id to support. |
Examples
#!/bin/sh
# List what a knowledge base holds
curl -sS --fail-with-body -X GET "https://api.aigently.ai/v1/knowledge-bases/6e8a0c2d-4f6b-4d8e-a0c2-4e6a8c0e2a4c/documents?status=failed" \
-H "Authorization: Bearer $AIGENTLY_API_KEY"
Try it
Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.