AgentBrains icon

AgentBrains

Interact with AgentBrains Knowledge Base, Conversation, Employee, RAG, Document Structuring, and Synthetic QA functionality

Actions21

Document → Get by Category Type

AI-generated

Summary

Lists knowledge-base entities (documents, products, or services) that belong to a selected category type by calling GET /knowledge-base/entities/{categoryAlias}.

Inputs

  • categoryAlias (required) — Selects the category type whose entities to list. The dropdown is loaded from GET /knowledge-base/category-aliases and the selected value is the alias key, which becomes the URL path segment: GET /knowledge-base/entities/{categoryAlias}. An expression can supply the alias key directly.
  • returnAll — When true, returns every entity the API returns for the category type. When false, the result array is truncated to the configured Limit.
  • limit — Maximum number of results to return when Return All is disabled. The node slices the API response to this many items.
  • additionalFields — Optional query filters sent with the request: Fields (comma-separated response field projection), SKU (exact-match entity lookup), Source (filter by original source identifier), and Tags (comma-separated tag filter).

Output shape

{ "items": [ ... ] }

One output item per input item. Each output item's JSON is shaped as { "items": [...] } containing the matching entities. When Return All is off, the items array is sliced to the configured Limit (default 50). If the API response is an envelope like { data: [...] } or { value: [...] }, that array is extracted; a non-array response is wrapped into a single-item array. If the request fails and Continue On Fail is enabled, the output item is { "error": "..." }.

Links

Discussion