# Biel.ai docs

> Ask AI assistant for technical documentation

This file contains links to documentation sections following the llmstxt.org standard.

## Table of Contents

- [View analytics](https://docs.biel.ai/administration/analytics.md): Track assistant, MCP, and search usage, FAQs, and content gaps.
- [Manage projects](https://docs.biel.ai/administration/projects.md): View, configure, and manage your Biel.ai projects.
- [Manage roles](https://docs.biel.ai/administration/roles.md): Assign and manage team member roles and permissions.
- [Manage subscription](https://docs.biel.ai/administration/subscription.md): Manage your Biel.ai subscription, billing, and usage.
- [Manage team](https://docs.biel.ai/administration/team.md): Manage team members, roles, and settings in Biel.ai.
- [Whitelabel](https://docs.biel.ai/administration/whitelabel.md): Remove Biel.ai branding from the assistant widget.
- [Administration](https://docs.biel.ai/administration.md): Administrative guides for managing Biel.ai.
- [Add source](https://docs.biel.ai/api/add-source.md): Add sources to a project. Supports files, URLs, sitemaps, hosted sites (ZIP), GitHub repositories, OpenAPI specifications, and Confluence spaces. A...
- [Biel.ai API](https://docs.biel.ai/api/biel-ai-api.md): Biel.ai is an AI-powered documentation assistant. It indexes your technical documentation and provides AI chat and search capabilities through widg...
- [Create a project](https://docs.biel.ai/api/create-project.md): Create a new project. The slug is auto-generated. Configure the project with [`PATCH /api/v2/projects/{slug}/`](/api/update-project) after creation.
- [Delete a chat](https://docs.biel.ai/api/delete-chat.md): Delete a conversation.
- [Delete a project](https://docs.biel.ai/api/delete-project.md): Permanently delete a project, all its sources, indexed content, and chat history.
- [Delete source](https://docs.biel.ai/api/delete-source.md): Remove a source and its indexed content from a project.
- [Get chat analytics](https://docs.biel.ai/api/get-chat-analytics.md): Aggregate KPIs and daily activity for the AI chat over a date range. MCP-only conversations are excluded. For those, see [`GET /api/v2/projects/{sl...
- [Get a chat](https://docs.biel.ai/api/get-chat.md): Retrieve a single conversation, including all of its messages ordered chronologically.
- [Get indexed document text](https://docs.biel.ai/api/get-indexed-document.md): Read a document's complete indexed text without contacting the original
- [Get advanced analytics insights](https://docs.biel.ai/api/get-insights-analytics.md): Surface conversation-driven insights for the project: top recurring questions (`faqs`) and content gaps where users asked something the assistant c...
- [Get MCP analytics](https://docs.biel.ai/api/get-mcp-analytics.md): Aggregate KPIs and daily activity for conversations that originated from the MCP server.
- [Get project details](https://docs.biel.ai/api/get-project.md): Retrieve project settings, filters, and metadata.
- [Get search analytics](https://docs.biel.ai/api/get-search-analytics.md): Aggregate KPIs and daily activity for the search experience over a date range. Counts come from [`GET /api/v2/projects/{slug}/search/`](/api/search...
- [Get source detail](https://docs.biel.ai/api/get-source.md): Retrieve detail for a single source.
- [Get a sync run](https://docs.biel.ai/api/get-sync-run.md): Retrieve a specific sync run by UUID. Returns the same shape as [`GET /api/v2/projects/{slug}/sync/`](/api/get-sync-status), but addresses a single...
- [Get latest sync status](https://docs.biel.ai/api/get-sync-status.md): Inspect the most recent sync run for the project, including overall status, the URLs that were processed, and the event log for the run.
- [Get a team](https://docs.biel.ai/api/get-team.md): Retrieve the team identified by `slug`. The `slug` must match the team that owns the authenticating API key. Requesting any other team returns 404.
- [Invite a team member](https://docs.biel.ai/api/invite-team-member.md): Send an email invitation to join the team with the given role. The invitee becomes a member once they accept.
- [List chats](https://docs.biel.ai/api/list-chats.md): List chats for a project. Results are paginated and ordered by `created_at`.
- [List projects](https://docs.biel.ai/api/list-projects.md): List projects accessible to the API key. Results are paginated.
- [List sources](https://docs.biel.ai/api/list-sources.md): List all sources associated with a project. Results are paginated.
- [List team members](https://docs.biel.ai/api/list-team-members.md): List the active members of the team. The `slug` must match the team that owns the authenticating API key.
- [List teams accessible to the API key](https://docs.biel.ai/api/list-teams.md): Return the team this API key belongs to. Because every API key is scoped to a single team, the returned array always contains exactly one entry.
- [Migrate from API v1 to v2](https://docs.biel.ai/api/migrate-from-v1.md): Move an existing Biel.ai API v1 integration to API v2. Endpoint mapping, permission renames, and breaking changes.
- [Re-crawl a single page](https://docs.biel.ai/api/recrawl-url.md): Re-crawl one page and replace it in the project's search index, without touching the rest of the index. Returns immediately with `202`; the crawl r...
- [Remove a team member](https://docs.biel.ai/api/remove-team-member.md): Remove a member from the team. The `id` is the membership id returned by [`GET /api/v2/teams/{slug}/members/`](/api/list-team-members). The team's ...
- [Search project content](https://docs.biel.ai/api/search-project.md): Keyword search across indexed project content by default. Set
- [Send a message](https://docs.biel.ai/api/send-message.md): Send a message and get an AI response. Returns 201 for new chats, 200 for existing ones.
- [Submit feedback for a message](https://docs.biel.ai/api/submit-message-feedback.md): Record a like (`1`) or dislike (`0`) reaction on an AI-generated message.
- [Start a sync](https://docs.biel.ai/api/sync-project.md): Re-crawl all project sources and update the search index. Returns immediately; the crawl runs in the background. Poll [`GET /api/v2/projects/{slug}...
- [Track a search result click](https://docs.biel.ai/api/track-search-click.md): Register a click on a search result for analytics. Call this after the user clicks on a result returned by [`GET /api/v2/projects/{slug}/search/`](...
- [Update a project](https://docs.biel.ai/api/update-project.md): Update one or more project settings. Only the supplied fields are modified. Feature configuration is grouped under `config` (for example, `config.m...
- [Update a team member](https://docs.biel.ai/api/update-team-member.md): Change a member's role. The `id` is the membership id returned by [`GET /api/v2/teams/{slug}/members/`](/api/list-team-members).
- [Update team settings](https://docs.biel.ai/api/update-team.md): Update the team's `name` and/or `slug`. The `slug` in the path must match the team that owns the authenticating API key. Include only the fields yo...
- [Validate an OpenAPI specification](https://docs.biel.ai/api/validate-open-api.md): Validate an OpenAPI specification against the same checks Biel runs when it indexes your spec, including `$ref` resolution. A `200` means the next ...
- [WebSocket API](https://docs.biel.ai/api/websocket.md): Real-time chat via WebSocket for streaming AI responses.
- [Accessibility](https://docs.biel.ai/customization/accessibility.md): Keyboard support, focus behavior, and screen reader labels for the Biel.ai chat and search widgets.
- [Actions](https://docs.biel.ai/customization/actions.md): Define clickable buttons that appear in assistant answers when specific conditions are met.
- [Chat progress](https://docs.biel.ai/customization/chat-progress.md): Configure the assistant progress spinner, loading dots, and fallback loading text.
- [Prompt customization](https://docs.biel.ai/customization/custom-prompt.md): Configure how the Biel.ai assistant responds using the default prompt or a custom prompt.
- [Dark mode](https://docs.biel.ai/customization/dark-mode.md): Enable dark mode for the Biel.ai assistant widget.
- [Data privacy](https://docs.biel.ai/customization/data-privacy.md): Configure PII redaction, IP collection, and Terms & Conditions for your Biel.ai assistant.
- [Confluence as a data source](https://docs.biel.ai/customization/data-sources/confluence.md): Connect a Confluence Cloud space to Biel.ai as a data source.
- [Files](https://docs.biel.ai/customization/data-sources/files.md): Upload documents in PDF, Word, Excel, and other formats
- [GitHub repositories](https://docs.biel.ai/customization/data-sources/github.md): Add GitHub repositories and their documentation
- [OpenAPI](https://docs.biel.ai/customization/data-sources/openapi.md): Add OpenAPI/Swagger specs to your Biel.ai project for accurate API documentation indexing.
- [Sources overview](https://docs.biel.ai/customization/sources.md): Connect websites, Git repositories, Confluence spaces, OpenAPI specs, and uploaded files as documentation sources for your Biel.ai project.
- [Private content](https://docs.biel.ai/customization/data-sources/private-content.md): Configure your assistant to access content behind login pages and VPN.
- [Sitemaps](https://docs.biel.ai/customization/data-sources/sitemaps.md): Add entire websites using XML sitemap files
- [URLs](https://docs.biel.ai/customization/data-sources/urls.md): Add individual web pages to your project
- [Embedded mode](https://docs.biel.ai/customization/embedded-mode.md): Embed the Biel.ai assistant directly into your page layout instead of using a floating button.
- [Initial message](https://docs.biel.ai/customization/initial-message.md): Set the first message the assistant displays when a user opens it.
- [Widget customization](https://docs.biel.ai/customization/layout.md): All available properties for the biel-button and biel-search-button widgets.
- [Models](https://docs.biel.ai/customization/models.md): Choose the AI model that powers your Biel.ai assistant.
- [Reasoning modes](https://docs.biel.ai/customization/reasoning-modes.md): Control how the Biel.ai assistant reasons through questions with Auto, Instant, and Think modes.
- [Search filters](https://docs.biel.ai/customization/search-filters.md): Add category filters to the Biel.ai search widget to help users narrow results.
- [Search](https://docs.biel.ai/customization/search.md): Configure and customize the Biel.ai search widget, including ranking boosts and metadata.
- [Styles](https://docs.biel.ai/customization/styles.md): Customize the Biel.ai widget appearance with CSS custom properties and CSS parts.
- [Suggested questions](https://docs.biel.ai/customization/suggested-questions.md): Add clickable question prompts that appear when users open the assistant.
- [Web search (beta)](https://docs.biel.ai/customization/web-search.md): Augment answers with real-time results from the internet.
- [Workflows (Enterprise)](https://docs.biel.ai/customization/workflows.md): Build agentic RAG systems for documentation with multi-agent orchestration, intelligent routing, and custom actions. Enterprise-grade agentic assis...
- [Customization](https://docs.biel.ai/customization.md): Customize the Biel.ai widget appearance, behavior, AI settings, and data sources.
- [Ask AI assistant widget for Antora](https://docs.biel.ai/installation/antora.md): Add an AI assistant or AI search widget to your Antora documentation site with this step-by-step guide.
- [Ask AI assistant widget for Astro](https://docs.biel.ai/installation/astro.md): Add an AI assistant or AI search widget to your Astro site with the astro-biel integration.
- [Basic installation](https://docs.biel.ai/installation/cdn.md): Add a Biel.ai assistant or search widget to any HTML site using a CDN.
- [Ask AI assistant widget for Confluence](https://docs.biel.ai/installation/confluence.md): Add an AI assistant or AI search widget for your Confluence content on a documentation site that supports custom JavaScript.
- [Ask AI assistant widget for Docusaurus](https://docs.biel.ai/installation/docusaurus.md): Add an AI assistant or AI search widget to your Docusaurus v3 site with Biel.ai.
- [Ask AI assistant widget for Fumadocs](https://docs.biel.ai/installation/fumadocs.md): Add an AI assistant or AI search widget to your Fumadocs site with this step-by-step guide.
- [Ask AI assistant widget for Gatsby](https://docs.biel.ai/installation/gatsby.md): Add an AI assistant or AI search widget to your Gatsby site with this step-by-step guide.
- [Ask AI assistant widget for GitBook](https://docs.biel.ai/installation/gitbook.md): Index GitBook documentation in Biel.ai and host the assistant or search widget on a site that supports custom JavaScript.
- [Ask AI assistant widget for Hugo](https://docs.biel.ai/installation/hugo.md): Add an AI assistant or AI search widget to your Hugo site with this step-by-step guide.
- [Ask AI assistant widget for Jekyll](https://docs.biel.ai/installation/jekyll.md): Add an AI assistant or AI search widget to your Jekyll site with this step-by-step guide.
- [Ask AI assistant widget for MadCap Flare](https://docs.biel.ai/installation/madcap-flare.md): Add an AI assistant or AI search widget to your MadCap Flare documentation with this step-by-step guide.
- [Ask AI assistant widget for Mintlify](https://docs.biel.ai/installation/mintlify.md): Add an AI assistant or AI search widget to your Mintlify docs with this step-by-step guide.
- [Ask AI assistant widget for MkDocs](https://docs.biel.ai/installation/mkdocs.md): Add an AI assistant or AI search widget to your MkDocs site with Biel.ai.
- [Ask AI assistant widget for Next.js](https://docs.biel.ai/installation/nextjs.md): Add an AI assistant or AI search widget to your Next.js site with this step-by-step guide.
- [Ask AI assistant widget for Nextra](https://docs.biel.ai/installation/nextra.md): Add an AI assistant or AI search widget to your Nextra site with Biel.ai.
- [Ask AI assistant for Nimbus documentation](https://docs.biel.ai/installation/nimbus.md): Add an AI assistant, optional page search, and hosted MCP to Cloudflare Nimbus documentation with astro-biel.
- [Ask AI assistant widget for NPM projects](https://docs.biel.ai/installation/npm.md): Add an AI assistant or AI search widget to your site with this step-by-step guide.
- [Ask AI assistant widget for Paligo](https://docs.biel.ai/installation/paligo.md): Add an AI assistant or AI search widget to your Paligo documentation with this step-by-step guide.
- [Ask AI assistant widget for React](https://docs.biel.ai/installation/react.md): Add an AI assistant or AI search widget to your React site with this step-by-step guide.
- [Ask AI assistant widget for ReadMe](https://docs.biel.ai/installation/readmeio.md): Add an AI assistant or AI search widget to your ReadMe documentation with this step-by-step guide.
- [Ask AI assistant widget for Read the Docs](https://docs.biel.ai/installation/readthedocs.md): Add an AI assistant or AI search widget to your Read the Docs site with this step-by-step guide.
- [Ask AI assistant widget for Sphinx](https://docs.biel.ai/installation/sphinx.md): Add an AI assistant or AI search widget to your Sphinx site with Biel.ai.
- [Ask AI assistant widget for Starlight](https://docs.biel.ai/installation/starlight.md): Add an AI assistant or AI search widget to your Starlight documentation site with the starlight-biel plugin.
- [Ask AI assistant widget for VitePress](https://docs.biel.ai/installation/vitepress.md): Add an AI assistant or AI search widget to your VitePress documentation with this step-by-step guide.
- [Ask AI assistant widget for Vue.js](https://docs.biel.ai/installation/vue.md): Add an AI assistant or AI search widget to your Vue.js site with this step-by-step guide.
- [Ask AI assistant widget for VuePress](https://docs.biel.ai/installation/vuepress.md): Add an AI assistant or AI search widget to your VuePress documentation with this step-by-step guide.
- [Ask AI assistant widget for Webflow](https://docs.biel.ai/installation/webflow.md): Add an AI assistant or AI search widget to your Webflow site with this step-by-step guide.
- [Ask AI and site search for WordPress](https://docs.biel.ai/installation/wordpress.md): Add Biel.ai's official Ask AI assistant and AI search plugins to WordPress without editing your theme.
- [Ask AI assistant widget for Zensical](https://docs.biel.ai/installation/zensical.md): Add an AI assistant or AI search widget to your Zensical site with Biel.ai.
- [Installation](https://docs.biel.ai/installation.md): Step-by-step installation guides for a range of programming languages and frameworks.
- [Create a ChatGPT plugin for your documentation](https://docs.biel.ai/integrations/chatgpt-plugin.md): Connect your Biel.ai documentation to ChatGPT through MCP, test the plugin, and prepare it for directory submission.
- [Create a Claude connector for your documentation](https://docs.biel.ai/integrations/claude-connector.md): Connect Claude to your Biel.ai documentation through a remote MCP server and prepare a public connector listing.
- [Discord Integration for Biel.ai](https://docs.biel.ai/integrations/discord.md): Add an AI assistant to your Discord server that answers questions from your documentation using Biel.ai.
- [GitHub workflow integration](https://docs.biel.ai/integrations/github-workflow.md): Automatically sync your Biel.ai project when documentation changes using GitHub Actions.
- [Make integration for RAG workflows](https://docs.biel.ai/integrations/make.md): Use Biel.ai as a RAG source in Make (formerly Integromat) for intelligent document retrieval and AI-powered automation.
- [Connect AI assistants to your documentation with MCP](https://docs.biel.ai/integrations/mcp-server.md): Connect ChatGPT, Claude, Cursor, and other MCP clients to search and read your documentation with Biel.ai. Follow the setup steps and control access.
- [Microsoft Teams Integration for Biel.ai](https://docs.biel.ai/integrations/microsoft-teams.md): Deploy the Biel.ai bot in Microsoft Teams so your team can ask questions to your documentation directly from any channel or chat.
- [n8n integration for RAG workflows](https://docs.biel.ai/integrations/n8n.md): Use Biel.ai as a RAG source in n8n workflows for intelligent document retrieval and AI-powered automation.
- [Slack Integration for Biel.ai](https://docs.biel.ai/integrations/slack.md): Connect your Biel.ai project to Slack so users can ask questions and get AI-powered answers directly from any Slack channel or DM.
- [WebMCP for docs: connect browser agents to your documentation](https://docs.biel.ai/integrations/webmcp.md): Let browser agents search and read your documentation with Biel.ai WebMCP. Learn how to enable it, test it, and control access.
- [Zapier integration for RAG workflows](https://docs.biel.ai/integrations/zapier.md): Use Biel.ai as a RAG source in Zapier for intelligent document retrieval and AI-powered automation.
- [Integrations](https://docs.biel.ai/integrations.md): Connect Biel.ai to AI development tools, IDEs, and other platforms to give them access to your documentation.
- [Set up the AI assistant for your docs](https://docs.biel.ai/): Create a Biel.ai account, set up a project, and test the AI assistant on your documentation in minutes.
- [Release notes](https://docs.biel.ai/release-notes.md): Release notes for Biel.ai and its ecosystem packages.
- [Production checklist](https://docs.biel.ai/security/checklist.md): Security checklist for deploying your Biel.ai assistant to production.
- [Security overview](https://docs.biel.ai/security/overview.md): Security features, architecture, and compliance in Biel.ai.
- [Providers](https://docs.biel.ai/security/providers.md): Third-party providers used by Biel.ai, their roles, and primary service regions.
- [Security](https://docs.biel.ai/security.md): Security features, architecture, and compliance in Biel.ai.
- [Support](https://docs.biel.ai/support.md): Get help with Biel.ai — documentation links, FAQs, and contact information.