---
title: API Reference
---

## Projects

### AI Settings

#### PATCH /api/projects/{projectId}/ai-settings

Updates the AI feature settings for a project.

**Required Permission:** Project update (`RLS_UPDATE_PERMISSION`)

**Path Parameters**

| Parameter | Type | Description |
|-----------|------|-------------|
| `projectId` | `string` | The unique identifier of the project |

**Request Body**

```json
{
  "aiEnabled": true
}
```

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `aiEnabled` | `boolean` | Yes | Whether AI features are enabled for the project |

**Response — Success (200)**

```json
{
  "success": true
}
```

**Response — Server Error (500)**

```json
{
  "success": false,
  "error": "Error message describing what went wrong"
}
```

---

## AI Features

AI features in the Business Platform are opt-in and must be explicitly enabled per project before they can be used. When AI features are disabled, all AI-related endpoints return a `403 Forbidden` response.

### Enabling AI Features

AI features can be toggled in the project settings UI under **Settings → Features → AI Settings**, or programmatically via the [PATCH /api/projects/{projectId}/ai-settings](#patch-apiprojectsprojectidai-settings) endpoint.

### Enforcement

The following endpoints enforce the `aiEnabled` flag. If `aiEnabled` is `false` for the given project, they return `403 Forbidden`:

| Endpoint | Description |
|----------|-------------|
| `POST /api/projects/{projectId}/ai-agents/{agentId}/chat` | AI agent chat |
| `POST /api/projects/{projectId}/types/{typeId}/ai-extract` | AI-powered data extraction |
| `POST /api/help/chat` | Documentation help chat (when a project route is active) |

**403 Response — AI disabled**

```json
{
  "error": "AI features are disabled for this project. Please enable AI features in project settings."
}
```

For the documentation help chat endpoint (`/api/help/chat`), the error message is also returned in German when the user's language is set to `de`:

```json
{
  "error": "KI-Features sind für dieses Projekt deaktiviert. Bitte aktivieren Sie KI-Features in den Projekteinstellungen."
}
```

### Data Privacy

When AI features are enabled for a project, the following capabilities may send data to third-party AI providers:

- **Documentation chat** — User queries are processed to retrieve relevant documentation.
- **AI agents** — Configured agents process project data according to their setup.
- **Action summaries** — Automated summaries of actions may be generated.
- **Smart import** — Document content may be analysed for structured data extraction.

**AI Providers**

Data processed by AI features may be sent to one or more of the following providers:

- **Mistral AI**
- **OpenAI**

Review each provider's data processing agreements before enabling AI features in projects that handle sensitive data.