Brainfish REST API documentation, endpoints, and integration guides for developers.

For developers and technical users. Covers the REST API, JavaScript SDK, widget installation, mobile, MCP server, and advanced configuration options.

Accessing Video Upload Settings as Super Admin

Guide: Setting up a Client Action

Guide: Setting up an API Action

How to Configure and Test an API Action

How to implement Client Actions in a React Native app (via WebView) [ALPHA]

Use JSON Schema with API actions and client actions

Actions

Catalog and CatalogContent Management

Get company search queries

How to Integrate Brainfish API with WhatsApp for Automatic Responses

API Reference

Brainfish MCP Server

Connect your agents to Brainfish with A2A and MCP

How to Connect MCP Using Claude

MCP Server

Adding Custom Properties and Events for User Tracking

How to determine what Widget version is installed

Install Brainfish in a Mobile App

Understanding Isolation and Group Isolation Flags

Using Import, Export, and API Tokens

Widget SDK

Advanced

Creating and Removing Users

How to Manage Team Members and Groups

How to Manage Your User Profile and Preferences

Managing User Accounts

A Guide to Account and Company Settings

How to Activate a Suspended User Account

How to Add a Team Member

How to Filter Members by Status

Account & Access

Managing Profile and Dashboard

Getting Started: Navigating the Brainfish Platform

Get Started with Brainfish

Language and Localization Support

Platform Overview

Quickstart

What is Brainfish

Why Brainfish for enterprise

Onboarding

Getting Support for Brainfish, Including Slack Support

Is there a community forum?

Stuck Logging In?

Help & Support

Pricing

Reference

Getting Started

Agent Identity (Using identities to improve accuracy and context)

Agent Identity Templates and Automatic Business Context in Brainfish

Brainfish Agent Setting: Include Business Context

Configuring Custom Instructions and Article Depth

Configuring Web Agents

Configuring Your Agents

Configuring Advanced Agent Settings

Creating and Configuring a Help Center Agent (Including Suggested Follow-up Actions)

Customizing Your Help Center Agent Appearance

Designing and Positioning Agent Identities for Specific Use Cases

Editing an Agent's Settings

How to Add a Knowledge Source to an Agent

How to Change the Name of an Agent

How to Configure an Agent

How to Configure Custom Instructions and Response Style for AI Agents

How to customise the Popup logo

How to Disable the Disclaimer in Popup Settings

How to Manage Agents

Managing and Customizing Agents

Simulation: Test Your Agent

Troubleshooting Agents

Agents

How to Create and Define a New API Action

How to Configure a Custom JavaScript Callback for a Handoff Action

How to set up an Intercom Handoff in a Brainfish Agent or Handoff Action

How to Set Up Zendesk Handoff Actions

Salesforce Handoff Integration

Human Handoff Integrations

Configuring the Handoff Action

Testing the Handoff Workflow

Setting Up Front Ticket Handoff

Setting up JS Callbacks with AI Action Buttons

Zendesk Handoff Integration

Zendesk Live Agent Handoff

Handoffs & Actions

Applying Custom Fonts to Your Help Center (Including CDN/Cache Behavior)

Authenticated help centers

Citation Configuration and Behavior in Brainfish Search Responses

Configuration options not appearing in Help Center?

Configuring Region Segmentation for Agents

Creating URL Redirect Rules for Ambient Knowledge

Custom Links

Customising the Help Center for Your Brand

How to Set Up a Custom Domain

Migrating a Live Custom Domain (Zero-Downtime Switchover)

Domain Configuration

How collections and sections appear in the Help Center

How endpoints are ordered in your API Reference

How to choose article sort order on your Help Center

How to Create a Custom Home Page for Sidebar Layout

How to enable Region Segmentation

How to Preview the Help Center

How to Set Up 301 Redirects in Help Center

How to Set Up a Custom Home Page (Sidebar Layout)

How to Set Up Multiple Help Centers in Brainfish

Knowledge Grouping: Segmenting Answers

Navigate to a specific region

Help Center

Adding Additional Teams Channels to an Agent

Brainfish Assist (Chrome Extension & Instant Answers Overview)

Brainfish Integrations: Embed Apps in Articles and Sync External Data Sources

Configuring GitHub App Inbox Settings in Your Help Desk

Connecting Slack Channels in the Dashboard

Connecting the Front Integration

Disconnecting Channels and the Teams Integration

How to Add a Zendesk Data Source

How to Configure and Manage the Microsoft Teams Integration

How to Connect to Salesforce Using an External Client App

How to Create an External Client App in Salesforce

How to Create a New Slack Agent

How to Set Up and Configure the Slack Agent

Including Query Details in Support Handoffs from the AI Assistant

Slack Integration Permissions

Integrate and Manage Slack Agents

Moving Channels Between Agents

Salesforce Email Agent Integration

Integrations

Guidance & Nudges: A Complete Guide to Creating, Configuring, and Publishing Nudges

How Guidance Nudges Work in Brainfish

Nudges & Guidance

Attaching Images to Questions

Brainfish Search Bar & Pop-up Modal Guide

Brainfish Widget - Contextual Help

Brainfish Widget Overrides Guide

How to Integrate Brainfish Widgets with Google Tag Manager: A Step-by-Step Guide

How to Set a Custom Mount Target for Your Pop-up Widget

Implementing Brainfish Popup Agent With Custom Button

Installing Brainfish in Micro-UI Architectures

Integrating Brainfish Widgets with Angular

Integrating Brainfish Widgets with HTML

Integrating Brainfish Widgets with React

Integrating Brainfish Widgets with Salesforce Lightning Web Components (LWC)

Integrating Brainfish Widgets with Solid.js

Integrating Brainfish Widgets with Vue

Migration Guide: Upgrading to the New Brainfish Popup Widget

Using the Widget History Tab

Widgets & embedding

Distribution

Configuring Knowledge Sources for Brainfish Assist (Chrome Extension)

Connecting a New External Data Source

Create Knowledge from GitHub PRs

Freshdesk Knowledge Sync

HelpJuice Knowledge Sync

Helpscout Knowledge Sync

How do I enable the Content Sync?

How to Connect Confluence as an External Data Source in Brainfish

How to get an Intercom access token

How to Integrate Brainfish with Confluence for AI-Powered Knowledge Search

HubSpot CSV Export

Intercom Knowledge Sync

Notion Knowledge Sync

Brainfish OAS GitHub Actions Sync

OpenAPI Specification (OAS) API Documentation Sync

Readme V2 Knowledge Sync

Get the Slack Bot Token

Sync Slack Channel Messages into Brainfish

Syncing Your Google Drive Content

Website Knowledge Sync

Zendesk Knowledge Sync

External Data Sources

Accessing and Reviewing Session Replays

Ambient Agent FAQs

Brainfish Auto-Discovery of Sessions and Knowledge Creation

Brainfish Auto-Discovery of Sessions and Knowledge Creation from Slack

Brainfish Session Auto-Discovery and Sampling Behavior

Can I Download Videos Recorded in the Brainfish Knowledge Platform?

Creating a Knowledge Base Article from a Messaging Conversation

Generate articles from Slack threads with @Brainfish

Generating Knowledge Base Articles from Video Content

How sessions are selected for AI generation

How to Automatically Create Knowledge Base Articles from Videos

How to Review and Approve Generated Answers

Speaking instructions to Brainfish while you record

Using Brainfish to Generate Product Marketing Knowledge Articles from Videos and Session Replays

Video Upload Limits for Articles and Video-to-Article Generation

Generate, Review, and Publish Knowledge Base Article Suggestions from Videos, Session Replays, Slack, and APIs

API

Share

Share

API

Share

Share