Back to Directus

Overview

content/guides/11.ai/1.assistant/0.index.md

latest4.3 KB
Original Source

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

<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:info" color="info"} AI Assistant requires an API key from a supported provider. Administrators configure API keys for OpenAI, Anthropic, Google, or an OpenAI-compatible endpoint in Settings → AI. ::

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
  • Flow Automation: Create new Flows and trigger them manually
  • File Attachments: Upload images, documents, audio, and video for AI analysis
  • Data Exploration: Query your data and understand your schema structure

Supported Models

:icon{name="i-simple-icons-openai" class="align-middle mr-1 size-5"} OpenAI

ModelModel IDContext Window Size
GPT-4o Minigpt-4o-mini128k tokens
GPT-4.1 Nanogpt-4.1-nano1M tokens
GPT-4.1 Minigpt-4.1-mini1M tokens
GPT-4.1gpt-4.11M tokens
GPT-5 Nanogpt-5-nano400k tokens
GPT-5 Minigpt-5-mini400k tokens
GPT-5gpt-5400k tokens
GPT-5.2gpt-5.2400k tokens
GPT-5.2 Chatgpt-5.2-chat-latest128k tokens
GPT-5.2 Progpt-5.2-pro400k tokens

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

ModelModel IDContext Window Size
Claude Haiku 4.5claude-haiku-4-5200k tokens
Claude Sonnet 4.5claude-sonnet-4-5200k tokens
Claude Opus 4.5claude-opus-4-5200k tokens

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

ModelModel IDContext Window Size
Gemini 2.5 Flashgemini-2.5-flash1M tokens
Gemini 2.5 Progemini-2.5-pro1M tokens
Gemini 3 Flash Previewgemini-3-flash-preview1M tokens
Gemini 3 Pro Previewgemini-3-pro-preview1M 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, DeepSeek, Mistral, and more. Configure custom models in Settings → AI.

Have feedback or feature requests? Submit on our roadmap.

Key Features

  • Tool Approval: All tools require approval by default. Configure per-tool settings.
  • Uses Your Permissions: The AI operates with your existing Directus role and access policies.
  • File Attachments: Upload files or select from your library. Supports images, PDFs, text, audio, and video up to 50MB.
  • Streaming Responses: Responses stream in real-time. Stop or retry at any time.

::callout{icon="material-symbols:warning" color="warning"} Conversations are stored in your browser only. They are not saved to the server or shared between devices. Closing your browser or clearing localStorage will delete your conversation history. ::


Get Started

::card-group

:::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/assistant/usage"} Learn how to use AI Assistant effectively in your daily workflow. :::

:::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/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/assistant/security"} Access control, data protection, and security considerations. :::

::