AgentBrains Knowledge Base icon

AgentBrains Knowledge Base

Interact with the AgentBrains Knowledge Base (Entities, Categories)

Actions11

Documents → Get Related Entities

AI-generated

Summary

Retrieves entities linked to a specified entity ID via its relationships.

Inputs

  • id (required) — The ID of the entity to query for related entities.
  • returnAll — Whether to return all results or only up to a given limit.
  • limit — Max number of results to return if returnAll is false.
  • type — Filters relationships by a specific type (e.g., "is-accessory-for").

Output shape

A list of items containing the related entities.

If returnAll is false, the result is limited to the specified limit. Supports pagination via the 'items' wrapper.

Examples

Example 1: Find all items related to a specific product.

Resource: Documents, Operation: Get Related Entities, ID: [product_id]

Example 2: Find all accessories for a specific product.

Resource: Documents, Operation: Get Related Entities, ID: [product_id], Additional Fields: Type: is-accessory-for

Example 3: Retrieve up to 100 related entities.

Resource: Documents, Operation: Get Related Entities, ID: [entity_id], Limit: 100

Links

Discussion