Biel.ai 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.
Biel.ai is an AI-powered documentation assistant. It indexes your technical documentation and provides AI chat and search capabilities through widgets, MCP servers, and this REST API.
Base URL: https://app.biel.ai
The API is available on Business and Enterprise plans. Contact us to upgrade.
Authorization & permissions
Biel.ai uses API key authentication with granular permissions.
- Public projects: Read operations don't require authentication. Write operations require an API key.
- Private projects: All operations require an API key.
Projects are public by default. Configure this in Project settings.
Available permissions
| Permission | Description | Required For |
|---|---|---|
project_read | Read project details | Getting project information |
project_search | Search documents within projects | Searching project content, tracking search clicks |
project_sources_read | View project sources | Listing project sources (files, URLs, sitemaps) |
project_sources_create | Upload sources | Adding files, URLs, and sitemaps to projects |
project_sources_delete | Delete sources | Removing sources from projects |
project_sync | Refresh/sync project data | Triggering project data refresh |
chat_create | Create chats and send messages | Interacting with the AI chat |
Create an API key
- In app.biel.ai, go to Team > API Keys.
- Click Create API Key, enter a name, and select permissions.
- 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
- API Key: ApiKeyAuth
API Key authentication using the format: Api-Key <your-api-key>
Create your API key in Team Settings and assign the required permissions for your use case.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | Authorization |