Real-Time AgentsAgent Knowledge Base

Get Knowledge Item

Retrieves a single knowledge item with detailed information including attached agents.

HTTP Request

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

URL Parameters

ParameterTypeDescription
uuidstringThe UUID of the knowledge item

Example Request

$curl --request GET "https://app.resemble.ai/api/v2/knowledge_items/550e8400-e29b-41d4-a716-446655440000" \
>  -H "Authorization: Bearer YOUR_API_TOKEN" \
>  -H "Content-Type: application/json"

Response (URL Type)

1{
2  "success": true,
3  "item": {
4    "uuid": "550e8400-e29b-41d4-a716-446655440000",
5    "title": "Product FAQ",
6    "description": "FAQ content",
7    "source_type": "url",
8    "status": "ready",
9    "error_message": null,
10    "chunk_count": 15,
11    "url": "https://example.com/faq",
12    "agents": [
13      {
14        "uuid": "agent-uuid-1",
15        "name": "Support Agent"
16      },
17      {
18        "uuid": "agent-uuid-2",
19        "name": "Sales Agent"
20      }
21    ],
22    "created_at": "2025-12-01T10:00:00Z",
23    "updated_at": "2025-12-01T10:05:00Z"
24  }
25}

Response (Document Type)

1{
2  "success": true,
3  "item": {
4    "uuid": "660e8400-e29b-41d4-a716-446655440001",
5    "title": "Product Manual",
6    "description": "Complete product documentation",
7    "source_type": "document",
8    "status": "ready",
9    "error_message": null,
10    "chunk_count": 42,
11    "document_url": "https://storage.example.com/signed-url",
12    "document_filename": "manual.pdf",
13    "agents": [
14      {
15        "uuid": "agent-uuid-1",
16        "name": "Support Agent"
17      }
18    ],
19    "created_at": "2025-12-01T09:00:00Z",
20    "updated_at": "2025-12-01T09:15:00Z"
21  }
22}

Response (Failed Status)

1{
2  "success": true,
3  "item": {
4    "uuid": "770e8400-e29b-41d4-a716-446655440002",
5    "title": "Invalid Document",
6    "description": "Test document",
7    "source_type": "document",
8    "status": "failed",
9    "error_message": "Failed to extract text from PDF: file is corrupted",
10    "chunk_count": null,
11    "document_url": "https://storage.example.com/signed-url",
12    "document_filename": "test.pdf",
13    "agents": [],
14    "created_at": "2025-12-01T08:00:00Z",
15    "updated_at": "2025-12-01T08:02:00Z"
16  }
17}

Response Body

AttributeTypeDescription
successbooleanIndicates if the request was successful
itemobjectKnowledge item object
uuidstringUnique identifier
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)
agentsarrayArray of agents using this knowledge item
agents[].uuidstringAgent UUID
agents[].namestringAgent name
created_atstringISO8601 timestamp of creation
updated_atstringISO8601 timestamp of last update

Error Response (Not Found)

1{
2  "success": false,
3  "errors": {
4    "base": ["Knowledge item not found"]
5  },
6  "message": "Failed to retrieve knowledge item"
7}

Use Cases

  • Check Processing Status: Poll this endpoint to monitor ingestion progress
  • View Attached Agents: See which agents are using this knowledge item
  • Download Documents: Use the signed document_url to download PDF files
  • Debugging Failures: Read error_message when status is failed