Actions11
- Documents Actions
- Category Actions
- Images Actions
- Relationship Types Actions
Documents → Get by Category Type
AI-generatedSummary
Retrieves entities from the AgentBrains Knowledge Base filtered by a category type alias.
Inputs
- categoryAlias (required) — The category type name or ID (alias) to filter entities by.
- returnAll — Whether to return all results or only up to a given limit.
- limit — Max number of results to return when returnAll is false.
- additionalFields.fields — Comma-separated list of specific fields to include in the response.
- additionalFields.sku — Filters entities by exact Stock Keeping Unit (SKU).
- additionalFields.source — Filters entities by their original source identifier.
- additionalFields.tags — Filters entities by one or more tags (comma-separated).
Output shape
A list of items, each containing an entity object with selected fields.
When returnAll is false, the result is limited to the configured limit (default 50). The operation maps API response structures (data, value, or direct arrays) into standard n8n item arrays.
Examples
Example 1: Retrieve a limited set of documents by a specific category type.
Resource: Documents, Operation: Get by Category Type, Category Alias: 'product-docs', Limit: 20
Example 2: Fetch all documents of a category type and return specific fields.
Resource: Documents, Operation: Get by Category Type, Category Alias: 'faq', Return All: true, Additional Fields: Fields: name,description,details
Example 3: Filter entities by category type and retrieve only those matching a specific tag.
Resource: Documents, Operation: Get by Category Type, Category Alias: 'news', Additional Fields: Tags: 'urgent'