Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion app/app.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ export default defineAppConfig({
},
{
label: 'AI',
to: '/guides/ai/mcp',
to: '/guides/ai/',
icon: 'directus-ai',
},
{
Expand Down
4 changes: 2 additions & 2 deletions app/pages/[...slug].vue
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ const showComingSoonBadge = computed(() => {
const { data: surround } = await useAsyncData(`${route.path}-surround`, () => queryCollectionItemSurroundings('content',
route.path,
{
fields: ['title', 'description', 'navigation', 'path'],
fields: ['title', 'description', 'path'],
},
));
).where('path', 'NOT LIKE', '%.navigation'));
</script>

<template>
Expand Down
10 changes: 5 additions & 5 deletions content/configuration/ai.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
title: AI
description: Configuration for AI Chat and Model Context Protocol (MCP) features.
description: Configuration for AI Assistant and Model Context Protocol (MCP) features.
---

:partial{content="config-env-vars"}

## AI Chat
## AI Assistant

| Variable | Description | Default Value |
| -------- | ----------- | ------------- |
| `AI_ENABLED` | Whether AI Chat features are available. Set to `false` to completely disable AI Chat across the entire instance, hiding the sidebar for all users and disabling the settings for administrators. | `true` |
| `AI_ENABLED` | Whether AI Assistant features are available. Set to `false` to completely disable AI Assistant across the entire instance, hiding the sidebar for all users and disabling the settings for administrators. | `true` |

::callout{icon="material-symbols:info" color="info"}
When `AI_ENABLED` is set to `false`:
- The `/ai/chat` API route is not mounted
- AI Chat sidebar is hidden from all users
- The API routes for the assistant are not mounted
- AI Assistant sidebar is hidden from all users
- AI settings form displays a disabled notice

This is useful for compliance requirements where AI features must be completely hidden.
Expand Down
30 changes: 30 additions & 0 deletions content/guides/10.ai/0.index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: AI + Directus
description: Use AI to interact with Directus - either through the built-in AI Assistant or by connecting external AI tools via MCP.
---

Directus offers two ways to integrate AI into your workflow, depending on where you prefer to work.

## Inside Directus: AI Assistant

The built-in AI Assistant provides a conversational assistant directly within the Directus Data Studio.

- Works directly in the Directus UI
- No additional client setup required
- Best for content editors, quick tasks, and users who live in Directus

::card{icon="material-symbols:chat" title="AI Assistant" to="/guides/ai/assistant"}
Learn how to configure and use the built-in AI assistant.
::

## External AI Tools: MCP Server

The Model Context Protocol (MCP) server lets you connect external AI tools to Directus.

- Use Claude Desktop, ChatGPT, Cursor, or other MCP-compatible clients
- Bring Directus capabilities to where you already work
- Best for developers, power users, and complex workflows

::card{icon="material-symbols:hub" title="MCP Server" to="/guides/ai/mcp"}
Connect your preferred AI tools to Directus.
::
3 changes: 3 additions & 0 deletions content/guides/10.ai/1.assistant/.navigation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
title: AI Assistant
headline: AI Assistant
---
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,17 @@ title: Overview
description: Chat with an AI assistant directly inside Directus. Create content, manage your schema, trigger automations, and explore your data through natural conversation.
---

Directus AI Chat is an embedded conversational assistant that helps you interact with your Directus instance through natural language.
Directus AI Assistant is an embedded conversational assistant that helps you interact with your Directus instance through natural language.

<video title="AI Chat creating a blog post" autoplay playsinline muted loop controls class="rounded-md">
<video title="AI Assistant creating a blog post" autoplay playsinline muted loop controls class="rounded-md">
<source src="/docs/video/ai-chat-blog-post.mp4" type="video/mp4" />
</video>

::callout{icon="material-symbols:science" color="warning"}
**AI Chat is currently in beta.** Features and tools may change as we refine the experience based on feedback.
::

::callout{icon="material-symbols:info" color="info"}
**AI Chat requires an OpenAI or Anthropic API key.** Administrators [configure API keys](/guides/ai/chat/setup) in Settings → AI.
**AI Assistant requires an API key from a supported provider.** Administrators [configure API keys](/guides/ai/assistant/setup) for OpenAI, Anthropic, Google, or an OpenAI-compatible endpoint in Settings → AI.
::

## What can AI Chat do?
## What can AI Assistant do?

- **Content Management**: Create, update, and organize items across your collections
- **Schema Operations**: Explore your data model, add new fields and collections
Expand All @@ -30,22 +26,43 @@ Directus AI Chat is an embedded conversational assistant that helps you interact

| Model | Model ID | Context Window Size |
|-------|----------|---------|
| GPT-4o Mini | `gpt-4o-mini` | 128k tokens |
| GPT-4.1 Nano | `gpt-4.1-nano` | 1M tokens |
| GPT-4.1 Mini | `gpt-4.1-mini` | 1M tokens |
| GPT-4.1 | `gpt-4.1` | 1M tokens |
| GPT-5 Nano | `gpt-5-nano` | 400k tokens |
| GPT-5 Mini | `gpt-5-mini` | 400k tokens |
| GPT-5 | `gpt-5` | 400k tokens |
| GPT-5.2 | `gpt-5.2` | 400k tokens |
| GPT-5.2 Chat | `gpt-5.2-chat-latest` | 128k tokens |
| GPT-5.2 Pro | `gpt-5.2-pro` | 400k tokens |

### :icon{name="i-simple-icons-claude" class="align-middle mr-1 size-5"} Anthropic
### :icon{name="i-simple-icons-anthropic" class="align-middle mr-1 size-5"} Anthropic

| Model | Model ID | Context Window Size |
|-------|----------|---------|
| Claude Haiku 4.5 | `claude-haiku-4-5` | 200k tokens |
| Claude Sonnet 4.5 | `claude-sonnet-4-5` | 200k tokens |
| Claude Opus 4.5 | `claude-opus-4-5` | 200k tokens |

### :icon{name="i-simple-icons-googlegemini" class="align-middle mr-1 size-5"} Google

| Model | Model ID | Context Window Size |
|-------|----------|---------|
| Gemini 2.5 Flash | `gemini-2.5-flash` | 1M tokens |
| Gemini 2.5 Pro | `gemini-2.5-pro` | 1M tokens |
| Gemini 3 Flash Preview | `gemini-3-flash-preview` | 1M tokens |
| Gemini 3 Pro Preview | `gemini-3-pro-preview` | 1M tokens |

### :icon{name="material-symbols:cloud" class="align-middle mr-1 size-5"} OpenAI-Compatible

Use any OpenAI-compatible API endpoint including self-hosted models (Ollama, LM Studio), Azure OpenAI, Mistral, and more. Configure custom models in [Settings → AI](/guides/ai/assistant/setup#openai-compatible-providers).

Want additional models or features? [Submit a request on our roadmap](https://roadmap.directus.io/).
Have feedback or feature requests? [Submit on our roadmap](https://roadmap.directus.io/).

## Key Features

- **Tool Approval**: All tools require approval by default. [Configure per-tool settings](/guides/ai/chat/tools#tool-behavior).
- **Tool Approval**: All tools require approval by default. [Configure per-tool settings](/guides/ai/assistant/tools#tool-behavior).
- **Uses Your Permissions**: The AI operates with your existing Directus role and access policies.
- **Streaming Responses**: Responses stream in real-time. Stop or retry at any time.

Expand All @@ -59,23 +76,23 @@ Want additional models or features? [Submit a request on our roadmap](https://ro

::card-group

:::card{title="Admin Setup" icon="material-symbols:settings" to="/guides/ai/chat/setup"}
:::card{title="Admin Setup" icon="material-symbols:settings" to="/guides/ai/assistant/setup"}
Configure API keys and customize the AI assistant behavior.
:::

:::card{title="User Guide" icon="material-symbols:chat" to="/guides/ai/chat/usage"}
Learn how to use AI Chat effectively in your daily workflow.
:::card{title="User Guide" icon="material-symbols:chat" to="/guides/ai/assistant/usage"}
Learn how to use AI Assistant effectively in your daily workflow.
:::

:::card{title="Available Tools" icon="material-symbols:construction" to="/guides/ai/chat/tools"}
:::card{title="Available Tools" icon="material-symbols:construction" to="/guides/ai/assistant/tools"}
Reference of all tools the AI can use to interact with Directus.
:::

:::card{title="Tips & Best Practices" icon="material-symbols:lightbulb" to="/guides/ai/chat/tips"}
Get the most out of AI Chat with practical tips and example prompts.
:::card{title="Tips & Best Practices" icon="material-symbols:lightbulb" to="/guides/ai/assistant/tips"}
Get the most out of AI Assistant with practical tips and example prompts.
:::

:::card{title="Security" icon="material-symbols:security" to="/guides/ai/chat/security"}
:::card{title="Security" icon="material-symbols:security" to="/guides/ai/assistant/security"}
Access control, data protection, and security considerations.
:::

Expand Down
Loading