Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.
Version: 1.0.0

Biel.ai API

Legacy API

This is the reference for API v1. v1 keeps working for existing integrations, but it no longer receives new features and is scheduled for retirement in January 2027. New integrations should use API v2. To move an existing integration, see the migration guide.

Base URL: https://app.biel.ai

Chat and query API access are included on every plan. Management operations require Business or Enterprise. Private projects require Professional or higher.

Authorization & permissions​

Biel.ai uses API key authentication with granular permissions.

  • Public projects: Widget operations, including reading project configuration, searching, and sending messages, do not require an API key. Project, source, conversation, sync, analytics, and team management operations require one. Check each endpoint.
  • Private projects: All operations require an API key.

Projects are public by default. Configure this in Project settings.

Available permissions​

PermissionDescriptionRequired For
project_readRead project detailsGetting project information
project_searchSearch documents within projectsSearching project content, tracking search clicks
project_sources_readView project sourcesListing project sources (files, URLs, sitemaps)
project_sources_createUpload sourcesAdding files, URLs, and sitemaps to projects
project_sources_deleteDelete sourcesRemoving sources from projects
project_syncRefresh/sync project dataTriggering project data refresh
chat_createCreate chats and send messagesInteracting with the AI chat

Create an API key​

  1. In app.biel.ai, click Team in the top navigation and scroll to API keys.
  2. Click Create API key and enter a Key name.
  3. Under Project access, select the intended project and choose the required permissions.
  4. Click Create API Key and copy the key. You won't be able to view it again.

Using your API key​

Include the key in the Authorization header:

Authorization: Api-Key <your-api-key>

Read-only keys (project_read, project_search) can be exposed client-side. Keys with write permissions should always be stored server-side.

Authentication​

Send Authorization: Api-Key <your-api-key>.

Create a key in Team > API keys with access to the project and the permissions required by the endpoint.

Security Scheme Type:

apiKey

Header parameter name:

Authorization