Directus llms.txt

The actual file

Source Markdown

The saved llms.txt text, displayed as source. The file belongs to its publisher; the live endpoint may change.

Showing the first 18000 characters. Load the complete file to read the remainder.

# Directus Documentation

> Directus is a real-time API and no-code Data Studio for managing any SQL database. It provides REST and GraphQL APIs, granular access control, authentication, file storage, automations, realtime via WebSockets, analytics dashboards, AI integration, and a full extension system. The Data Studio is a web application for non-technical users to browse, manage, and visualize data without writing code.

## Documentation Sets

- [Complete Directus Documentation](https://directus.com/docs/llms-full.txt): All Directus documentation pages in a single file.

## Getting Started

Introduction to Directus concepts, project creation, first steps with the API, authentication, file uploads, automations, and realtime.

- [Overview](https://directus.com/docs/raw/getting-started/overview.md): Learn what Directus is, when to use it, and how it works.
- [Accessibility](https://directus.com/docs/raw/getting-started/accessibility.md): We are always looking for ways to make Directus Studio more accessible. Here are some of the methods we currently support.
- [Create a Project](https://directus.com/docs/raw/getting-started/create-a-project.md): Learn about how to create a managed Directus project or self-host with Docker.
- [Configure a Data Model](https://directus.com/docs/raw/getting-started/data-model.md): This guide will cover creating a collection in Directus via the Data Studio, creating fields, and configuring relationships.
- [Use the API](https://directus.com/docs/raw/getting-started/use-the-api.md): Get started with Directus APIs. Learn to interact with collections, fetch, and create data.
- [Authenticate a User](https://directus.com/docs/raw/getting-started/authenticate-user.md): Get started with Directus Auth. Learn how to register, login, create users, and make authenticated requests.
- [Upload & Access Files](https://directus.com/docs/raw/getting-started/upload-files.md): This guide will cover importing a file via URL, requesting assets, and using transformation parameters.
- [Create a Flow](https://directus.com/docs/raw/getting-started/create-an-automation.md): Get started using flows, triggers, operations, and the data chain in Directus.
- [Connect to Realtime Data](https://directus.com/docs/raw/getting-started/connect-to-realtime.md): This guide will cover connecting to Directus via WebSockets on the web, subscribing to changes, and creating new items over the connection.
- [Resources & Links](https://directus.com/docs/raw/getting-started/resources.md): Key links across the Directus ecosystem.

## Guides - Data Model

Creating and configuring collections, fields, relationships, and interfaces in Directus.

- [Collections](https://directus.com/docs/raw/guides/data-model/collections.md): Directus collections help you manage your data. Create custom collections, define fields, configure relationships, and leverage features like content versioning and access control. Learn how to create, configure, and manage collections in Directus.
- [Fields](https://directus.com/docs/raw/guides/data-model/fields.md): Directus fields let you define how your data is stored and displayed. Learn about creating fields, data types, interfaces, validations, relationships, and more. Discover how to configure fields to perfectly suit your data modeling needs in Directus.
- [Interfaces](https://directus.com/docs/raw/guides/data-model/interfaces.md): Manage your data effectively with Directus fields. Discover various field types, interfaces, validations, and relationships to perfectly suit your data modeling needs.
- [Rich Text](https://directus.com/docs/raw/guides/data-model/rich-text.md): Configure custom formats for the WYSIWYG interface, understand what the editor stores, and style the resulting HTML in your app's frontend CSS.
- [Relationships](https://directus.com/docs/raw/guides/data-model/relationships.md): Leverage Directus relationships to create powerful data connections. Explore Many to One, One to Many, Many to Many, and Many to Any relationships, along with Translations for multilingual content management.

## Guides - Content

Browsing, filtering, editing, importing/exporting, and managing items in the Data Studio. Includes live preview, content versioning, translations, visual editor, and collaborative editing.

- [Collection Page](https://directus.com/docs/raw/guides/content/explore.md): Learn to filter, layout, batch edit and more on the collection page.
- [Item Page](https://directus.com/docs/raw/guides/content/editor.md): Learn to create, duplicate, archive and perform other actions with items using Directus.
- [Layouts](https://directus.com/docs/raw/guides/content/layouts.md): Learn to use layouts for viewing and interacting with items in a collection using Directus.
- [Import & Export](https://directus.com/docs/raw/guides/content/import-export.md): Learn to import and export multiple items stored as files using Directus.
- [Live Preview](https://directus.com/docs/raw/guides/content/live-preview.md): Learn to set up your project for live previewing items from your application.
- [Content Versioning](https://directus.com/docs/raw/guides/content/content-versioning.md): This guide covers the process of enabling and utilizing Content Versioning in Directus.
- [Translations](https://directus.com/docs/raw/guides/content/translations.md): Both content and the data studio can be translated into multiple languages.
- [Visual Editor](https://directus.com/docs/raw/guides/content/visual-editor.md): The Directus visual editor module allows you to visually edit the content of your website directly in-place.
- [Frontend Library](https://directus.com/docs/raw/guides/content/visual-editor/frontend-library.md): A library that allows your website to communicate with your Directus project and enables Visual Editing.
- [Studio Module](https://directus.com/docs/raw/guides/content/visual-editor/studio-module.md): Learn how to edit your website's content in place from within the Directus Studio.
- [Customization](https://directus.com/docs/raw/guides/content/visual-editor/customization.md): Customize the styling of your Visual Editing experience to suit your brand or website theming.
- [Collaborative Editing](https://directus.com/docs/raw/guides/content/collaborative-editing.md): Directus Collaborative Editing enables real-time data synchronization and collaborative editing across collections, allowing multiple users to edit content simultaneously without conflicts.
- [Configuration](https://directus.com/docs/raw/guides/content/collaborative-editing/configuration.md): Learn how to configure Collaborative Editing in your Directus project.
- [Usage Guide](https://directus.com/docs/raw/guides/content/collaborative-editing/usage.md): Learn how to use Collaborative Editing for real-time collaboration on content in your Directus project.
- [Development & Custom Extensions](https://directus.com/docs/raw/guides/content/collaborative-editing/development.md): Learn how Custom Interfaces integrate with Collaborative Editing in Directus.

## Guides - Auth

Access tokens, cookie-based auth, access control policies, user creation, email login, two-factor authentication, accountability, and SSO configuration.

- [Access Tokens](https://directus.com/docs/raw/guides/auth/tokens-cookies.md): Learn how to authenticate requests & explore standard, session, and static token types.
- [Access Control](https://directus.com/docs/raw/guides/auth/access-control.md): Manage user and role permissions and policies for interacting with data in Directus.
- [Creating Users](https://directus.com/docs/raw/guides/auth/creating-users.md): Learn about creating users in directus, including API creation, inviting users, and seamless invites.
- [Email Login](https://directus.com/docs/raw/guides/auth/email-login.md): Learn about user registration, login with standard/session tokens, refresh, logout, and resetting passwords.
- [Two-Factor Authentication](https://directus.com/docs/raw/guides/auth/2fa.md): Secure your logins with one-time codes! Learn how to generate secrets, enable/disable 2FA.
- [Accountability](https://directus.com/docs/raw/guides/auth/accountability.md): Learn to audit user activity and enforce accountability using the activity feed.
- [Single Sign-On](https://directus.com/docs/raw/guides/auth/sso.md): Single Sign-On is a mechanism which allows to use external providers to login into systems.
- [Seamless SSO](https://directus.com/docs/raw/guides/auth/sso/seamless.md): Seamless SSO is a setup to allow logging in without the user ever seeing Directus' login page.

## Guides - APIs

Using the Directus REST and GraphQL APIs - authentication mechanics, filter operators, query parameters, pagination, relational queries, error handling, and the JavaScript/TypeScript SDK.

- [Authentication](https://directus.com/docs/raw/guides/connect/authentication.md): Discover how to authenticate Directus API requests using authorization headers, session cookies, or query parameters.
- [Filter Rules](https://directus.com/docs/raw/guides/connect/filter-rules.md): Learn about filter rules in Directus - available operators, filter syntax, relational fields, dynamic variables, logical operators, and functions parameters. Understand how to build complex filters for permissions, validations, and automations.
- [Query Parameters](https://directus.com/docs/raw/guides/connect/query-parameters.md): Learn about Directus query parameters - fields, filter, search, sort, limit, offset, page, aggregate, groupBy, deep, alias, and export. Understand how to customize your API requests and retrieve specific data from your collections.
- [Relational Data](https://directus.com/docs/raw/guides/connect/relations.md): Directus enables you to manage and interact with relational data. This section will guide you through the different types of relationships and how to work with them.
- [Errors](https://directus.com/docs/raw/guides/connect/errors.md): Learn how Directus returns errors over REST, GraphQL, and the SDK. Includes core error codes, HTTP status codes, response shape, and patterns for handling errors in your application.
- [Directus SDK](https://directus.com/docs/raw/guides/connect/sdk.md): A JavaScript and TypeScript library that simplifies working with Directus.
- [Quickstart](https://directus.com/docs/raw/guides/connect/json/quickstart.md): Quickstart for extracting and filtering values inside JSON fields with the json() function and _json filter operator.
- [Advanced Querying](https://directus.com/docs/raw/guides/connect/json/advanced-querying.md): Advanced JSON querying for the `json(field, path)` function and `_json` filter operator, including path notation, relational queries, GraphQL support, SDK usage, depth limits, and database-specific behavior.

## Guides - Files

Uploading, managing, transforming, and controlling access to files and assets.

- [Upload Files](https://directus.com/docs/raw/guides/files/upload.md): Learn to upload files to Directus via both the data studio or API.
- [Download Files](https://directus.com/docs/raw/guides/files/download.md): Learn to download content from the File Library
- [Manage Files](https://directus.com/docs/raw/guides/files/manage.md): Learn to view, modify, edit and set files' focal points.
- [Access Files](https://directus.com/docs/raw/guides/files/access.md): Learn how to access uploaded files, authenticate, provide optional filenames and directly download them.
- [Transform Files](https://directus.com/docs/raw/guides/files/transform.md): Learn how to transform files and set custom presets for these transformations.

## Guides - Flows

Building event-driven automations with Flows, triggers, data chains, and operations.



## Guides - Realtime

WebSocket authentication, subscriptions, and real-time data actions.

- [Authentication](https://directus.com/docs/raw/guides/realtime/authentication.md): Learn to implement the three authentication modes.
- [Subscriptions](https://directus.com/docs/raw/guides/realtime/subscriptions.md): Learn to manage realtime subscriptions with both websockets and GraphQL.
- [Actions](https://directus.com/docs/raw/guides/realtime/actions.md): Learn to execute CRUD actions via websockets.
- [Custom WebSocket Handlers](https://directus.com/docs/raw/guides/realtime/custom-handlers.md): Build custom WebSocket message handlers, push messages to connected clients, and react to WebSocket events using hook extensions.

## Guides - Insights

Building no-code analytics dashboards with configurable panels and visualizations.

- [Insights Overview](https://directus.com/docs/raw/guides/insights/overview.md): Insights is a module in Directus that allows rapid, no-code build-out of analytics dashboards.
- [Panels](https://directus.com/docs/raw/guides/insights/panels.md): Panels are the building-blocks you can add onto insights dashboards to create, save and display data analytics.

## Guides - Extensions

Extending Directus with custom interfaces, displays, layouts, panels, modules, endpoints, hooks, operations, and bundles. Includes the Marketplace and CLI.

- [Extensions Overview](https://directus.com/docs/raw/guides/extensions/overview.md): Extensions are used to extend the functionality of Directus.
- [Extensions Quickstart](https://directus.com/docs/raw/guides/extensions/quickstart.md): This guide will cover how to get started with developing an extension for Directus.
- [API Extensions Overview](https://directus.com/docs/raw/guides/extensions/api-extensions.md): API Extensions extend the functionality of the API.
- [Event Hooks](https://directus.com/docs/raw/guides/extensions/api-extensions/hooks.md): Hooks allow running code when during the Directus lifecycle or database events.
- [API Endpoints](https://directus.com/docs/raw/guides/extensions/api-extensions/endpoints.md): Endpoints allow you to register new API routes in your Directus project.
- [Flow Operations](https://directus.com/docs/raw/guides/extensions/api-extensions/operations.md): Operations are single steps in a Flow - the no-code automation tool in Directus.
- [Services](https://directus.com/docs/raw/guides/extensions/api-extensions/services.md): When building extensions, you may use internal Directus services directly.
- [Sandbox](https://directus.com/docs/raw/guides/extensions/api-extensions/sandbox.md): Sandboxed Extensions run in an isolated environment and must request permission scopes.
- [App Extensions Overview](https://directus.com/docs/raw/guides/extensions/app-extensions.md): App Extensions extend the functionality of the Data Studio.
- [Item Page Interfaces](https://directus.com/docs/raw/guides/extensions/app-extensions/interfaces.md): Interfaces are form inputs used primarily on the Directus item page.
- [Inline Displays](https://directus.com/docs/raw/guides/extensions/app-extensions/displays.md): Displays are used to display a single value throughout the Data Studio.
- [Collection Page Layouts](https://directus.com/docs/raw/guides/extensions/app-extensions/layouts.md): Layouts are used to display a list of items on collection pages in different ways.
- [Dashboard Panels](https://directus.com/docs/raw/guides/extensions/app-extensions/panels.md): Panels are customizable components within Directus Insights dashboards.
- [Custom Modules](https://directus.com/docs/raw/guides/extensions/app-extensions/modules.md): Modules are top-level areas of the Data Studio, navigated to from the left-hand module bar.
- [Custom Themes](https://directus.com/docs/raw/guides/extensions/app-extensions/themes.md): Themes are used to style elements of the Data Studio including colors and fonts.
- [Rich Text Extensions](https://directus.com/docs/raw/guides/extensions/app-extensions/richtext.md): Rich text extensions add Tiptap nodes, marks, and toolbar buttons to the WYSIWYG interface.
- [UI Library](https://directus.com/docs/raw/guides/extensions/app-extensions/ui-library.md): Directus offers globally-registered UI components for building extensions.
- [Composables](https://directus.com/docs/raw/guides/extensions/app-extensions/composables.md): Vue composables for working with Directus services when building extensions.
- [Bundling Extensions](https://directus.com/docs/raw/guides/extensions/bundles.md): Bundles are a way to group extensions together as a single distributable package.
- [Marketplace](https://directus.com/docs/raw/guides/extensions/marketplace.md): The Directus Marketplace provides a way for users to install extensions in their projects directly the Data Studio.
- [Publishing Extensions](https://directus.com/docs/raw/guides/extensions/marketplace/publishing.md): Publish extensions to the Directus Marketplace via npm, including required metadata, best practices, and author profile setup.
- [CLI](https://directus.com/docs/raw/guides/extensions/cli.md): Using the create-directus-extension to build, validate and manage extensions.

## Guides - AI

Using the built-in AI Assistant in the Data Studio and connecting external AI tools via the MCP server.

- [AI + Directus](https://directus.com/docs/raw/guides/ai.md): Use AI to interact with Directus - either through the built-in AI Assistant or by connecting external AI tools via MCP.
- [Overview](https://directus.com/docs/raw/guides/ai/assistant.md): Chat with an AI assistant directly inside Directus. Create content, manage your schema, trigger automations, and explore your data through natural conversation.
- [Setup](https://directus.com/docs/raw/guides/ai/assistant/setup.md): Configure AI Assistant by adding your AI provider API keys and customizing assistant behavior.
- [Usage](https://directus.com/docs/raw/guides/ai/assistant/usage.md): Learn how to use AI Assistant to interact with your Directus instance through natural conversation.
- [Tools](https://directus.com/docs/raw/guides/ai/assistant/tools.md): Reference of all tools available to AI Assistant for interacting with your Directus instance.
- [Best Practices](https://directus.com/docs/raw/guid