Real-Time AgentsAgent Knowledge Base

List Knowledge Items

Lists all knowledge items belonging to the authenticated user’s team.

HTTP Request

$GET https://app.resemble.ai/api/v2/knowledge_items

Query Parameters

ParameterTypeDescription
statusstringFilter by status: pending, processing, ready, failed (optional)
source_typestringFilter by source type: document, url, text (optional)
pageintegerPage number (default: 1)
per_pageintegerItems per page (default: 20, max: 100)

Example Request

$curl --request GET "https://app.resemble.ai/api/v2/knowledge_items" \
>  -H "Authorization: Bearer YOUR_API_TOKEN" \
>  -H "Content-Type: application/json"

Example Request with Filters

$curl --request GET "https://app.resemble.ai/api/v2/knowledge_items?status=ready&source_type=url&page=1&per_page=20" \
>  -H "Authorization: Bearer YOUR_API_TOKEN" \
>  -H "Content-Type: application/json"

Response

1{
2  "success": true,
3  "items": [
4    {
5      "uuid": "550e8400-e29b-41d4-a716-446655440000",
6      "title": "Product FAQ",
7      "description": "Frequently asked questions",
8      "source_type": "url",
9      "status": "ready",
10      "error_message": null,
11      "chunk_count": 15,
12      "url": "https://example.com/faq",
13      "agent_count": 2,
14      "created_at": "2025-12-01T10:00:00Z",
15      "updated_at": "2025-12-01T10:05:00Z"
16    },
17    {
18      "uuid": "660e8400-e29b-41d4-a716-446655440001",
19      "title": "Product Manual",
20      "description": "Complete product documentation",
21      "source_type": "document",
22      "status": "ready",
23      "error_message": null,
24      "chunk_count": 42,
25      "document_url": "https://storage.example.com/signed-url",
26      "document_filename": "manual.pdf",
27      "agent_count": 1,
28      "created_at": "2025-12-01T09:00:00Z",
29      "updated_at": "2025-12-01T09:15:00Z"
30    },
31    {
32      "uuid": "770e8400-e29b-41d4-a716-446655440002",
33      "title": "Product Information",
34      "description": "Core product details",
35      "source_type": "text",
36      "status": "processing",
37      "error_message": null,
38      "chunk_count": null,
39      "agent_count": 0,
40      "created_at": "2025-12-01T11:00:00Z",
41      "updated_at": "2025-12-01T11:00:00Z"
42    }
43  ],
44  "pagination": {
45    "page": 1,
46    "per_page": 20,
47    "total_count": 3,
48    "total_pages": 1
49  }
50}

Response Body

AttributeTypeDescription
successbooleanIndicates if the request was successful
itemsarrayArray of knowledge item objects
paginationobjectPagination metadata
uuidstringUnique identifier for the knowledge item
titlestringDisplay title (max 50 chars)
descriptionstringDescription (max 200 chars)
source_typestringSource type: document, url, or text
statusstringStatus: pending, processing, ready, or failed
error_messagestringError details if status is failed (null otherwise)
chunk_countintegerNumber of chunks created (null until processed)
urlstringSource URL (only for url type)
document_urlstringSigned URL to download document (only for document type, expires after 1 hour)
document_filenamestringOriginal filename (only for document type)
agent_countintegerNumber of agents using this item
created_atstringISO8601 timestamp of creation
updated_atstringISO8601 timestamp of last update

Pagination Object

AttributeTypeDescription
pageintegerCurrent page number (1-based)
per_pageintegerItems per page
total_countintegerTotal number of items matching the filters
total_pagesintegerTotal number of pages

Status Filtering

Use the status parameter to filter by processing status:

  • pending: Waiting for ingestion to start
  • processing: Currently being processed
  • ready: Successfully processed and ready to attach to agents
  • failed: Processing failed (check error_message field)

Source Type Filtering

Use the source_type parameter to filter by content source:

  • document: PDF files
  • url: Web pages
  • text: Plain text content