Knowledge Base & Settings
Access structured entities, categories, attachments, and configurations in Zapier
Knowledge Base & Settings Actions
Use these actions to browse, filter, or retrieve exact Knowledge Base records and employee/workspace settings deterministically.
Entity & Document Actions
Get many entities
Use this when your Zap needs to list or filter knowledge-base entities.
Inputs
| Field | Description |
|---|---|
| Category | Optional category selected from a dropdown. |
| Search | Optional text search filter. |
| Source | Optional source filter. |
| SKU | Optional SKU filter. |
| Tags | Optional tag filter. |
| Fields | Optional comma-separated AgentBrains API field keys. |
| Recursive | Optional recursive category lookup. |
Field Formatting
The Fields input expects real AgentBrains API field names, not Zapier display labels.
- Correct:
_id,name,details,source,sku,tags,categoryId,createdAt,updatedAt - Incorrect:
Document Details, Document Name, Source
For example, if Zapier displays a field as "Document Details", the actual API field may be details.
Get Entity
Use this when your Zap already knows the exact entity or document ID.
Inputs
| Field | Description |
|---|---|
| Entity ID or Alias | The AgentBrains entity/document ID or alias. |
Outputs
Returns the matching entity fields such as ID, name, title, details, source, SKU, and text when available.
Recommended Pattern
Use Get many entities to find candidate records, then use Get Entity to retrieve the exact record.
Get entities by category type
Use this when your Zap needs entities under a selected category type alias.
Inputs
| Field | Description |
|---|---|
| Category Type | Category type selected from a dropdown. |
Outputs
Returns matching entities/documents for the selected category type.
Category Actions
List many categories
Use this when your Zap needs to list categories or filter by parent category.
Inputs
| Field | Description |
|---|---|
| Extended | Whether to return extended category data. |
| Fields | Optional comma-separated AgentBrains API field keys. |
| Parent Category ID | Optional parent category ObjectId. |
Important Note about Parent
Leave Parent Category ID empty unless you have a valid parent category ObjectId. Empty parent values are not sent by the integration.
Field Formatting
Use real AgentBrains API field names.
- Correct:
_id,name,key,aliasKey,details,parent,createdAt,updatedAt - Incorrect:
Category Name, Category Details, Parent Category
Get Category
Use this when your Zap needs one exact category.
Inputs
| Field | Description |
|---|---|
| Category ID or Key | Category ID or key. |
Outputs
Returns category metadata such as ID, name, title, key, description, and details when available.
List categories by type
Use this when your Zap needs categories under a selected category type alias.
Inputs
| Field | Description |
|---|---|
| Category Type | Category type selected from a dropdown. |
Outputs
Returns category records for the selected category type.
Image & Attachment Actions
Get an image
Use this when your Zap already has an image or attachment ID.
Inputs
| Field | Description |
|---|---|
| Image ID | The AgentBrains attachment/image ID. |
Outputs
Returns image or attachment details such as ID, name, URL, type, MIME type, and description.
Relationship Type Actions
List Relationship Types
Use this when your Zap needs to inspect available knowledge-base relationship types.
Inputs
None.
Outputs
Returns relationship type records such as ID, name, and key.
Employee & Company Settings
Get Employee Configuration
Use this when your Zap needs employee-specific AgentBrains configuration.
Inputs
| Field | Description |
|---|---|
| Employee | Employee selected from a dropdown. |
Outputs
Returns employee information and configuration.
Example
Use this before an AI or message-generation step so the Zap can use the correct employee instructions, settings, or campaign configuration.
Get Company Data
Use this when your Zap needs company-level context.
Inputs
None.
Outputs
Returns company information for the authenticated AgentBrains tenant.
Recommended workflow patterns
Deterministic answer flow
Use Get Entity when the answer must come from a specific known document, policy, manual, product sheet, or record.
Category-based workflow
Use List categories by type to select a category group, then use Get entities by category type or Get many entities to retrieve records.
Employee-configured AI workflow
Use Get Employee Configuration before an AI, message, or routing step to load the correct AgentBrains employee settings into the Zap.
Company-context workflow
Use Get Company Data before generating emails, support replies, CRM notes, or reports that need consistent company context.
What the actions map to
The Zapier integration is built on top of the AgentBrains public API:
- Entity actions use AgentBrains knowledge-base entity endpoints.
- Category actions use AgentBrains category and category-alias endpoints.
- Image actions use AgentBrains retrieval and attachment endpoints.
- Employee actions use AgentBrains employee endpoints.
- Company actions use the AgentBrains company info endpoint.
- Relationship actions use AgentBrains relationship type endpoints.