Actions26
- Agent Actions
- Conversation Actions
- Knowledge Base Actions
- Phone Actions
- Voice Actions
Knowledge Base → List Documents
AI-generatedOverview
The "List Documents" operation under the "Knowledge Base" resource allows users to retrieve a list of documents stored in a knowledge base. This node is useful for scenarios where you want to programmatically access, filter, and manage documents within a knowledge base system, such as fetching relevant documents for further processing, analysis, or display.
Practical examples include:
- Retrieving all documents related to a specific topic or search term.
- Filtering documents owned by the current user.
- Using an advanced search powered by Typesense (a fast search engine) to find documents efficiently.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all matching documents or limit the number of results. |
| Limit | Maximum number of documents to return if not returning all (minimum 1, maximum 100). |
| Filters | Collection of filters to narrow down the document list: |
| - Search | Search for documents whose names start with this string. |
| - Show Only Owned Documents | If true, only documents owned by the user (not shared) will be returned. |
| - Use Typesense | If true, the search will use the Typesense database for faster and more efficient searching. |
Output
The output is a JSON array containing the list of documents retrieved from the knowledge base. Each item in the array represents a document object with its associated metadata and content fields (the exact structure depends on the knowledge base API response).
If binary data were involved (e.g., document attachments), it would be included in the binary output field, but this operation primarily returns JSON data representing document details.
Dependencies
- Requires an active connection to the ElevenLabs Conversational AI API backend that manages the knowledge base.
- Requires valid API authentication credentials configured in n8n to authorize requests.
- Optionally uses Typesense DB for enhanced search capabilities if enabled via the "Use Typesense" filter.
Troubleshooting
- Empty Results: If no documents are returned, verify the search filter and ownership filter settings. Also, ensure that documents exist in the knowledge base.
- API Authentication Errors: Ensure that the API key or authentication token is correctly set up in n8n credentials.
- Limit Exceeded: The "Limit" property must be between 1 and 100; setting values outside this range may cause errors.
- Typesense Search Issues: If enabling Typesense search causes errors, confirm that the Typesense service is properly configured and accessible.
- Continue On Fail: If enabled, the node will continue processing other items even if one fails, returning error messages in the output JSON.
Links and References
- ElevenLabs Conversational AI Documentation (general reference for API usage)
- Typesense Documentation (for understanding the search engine used optionally)
- n8n Documentation (for general node usage and credential setup)