[{"data":1,"prerenderedAt":3268},["ShallowReactive",2],{"content-navigation":3,"$fY4mAj2l3kRkTDttxn6FGzqBc2O9HAJ2qp-_8LmMX7aw":1832,"/guides/ai/assistant/setup":1837,"/guides/ai/assistant/setup-surround":3265},[4,112,119,224,333,429,481,1087,1113,1142],{"title":5,"path":6,"stem":7,"children":8,"page":89},"Partials","/_partials","_partials",[9,15,20,25,29,33,38,42,47,51,56,60,64,68,90,94,98,103,108],{"title":10,"path":11,"stem":12,"description":13,"icon":14,"links":14},"Advanced Field Creation Mode","/_partials/advanced-field-creation-mode","_partials/advanced-field-creation-mode","You can use these advanced options to automatically set the values of fields at specific events by clicking on \"Continue in Advanced Field Creation Mode\".",null,{"title":16,"path":17,"stem":18,"description":19,"icon":14,"links":14},"Authentication","/_partials/authentication","_partials/authentication","While the Public role can be configured to make data available without authentication, anything that is not public requires a user to authenticate their requests.",{"title":21,"path":22,"stem":23,"description":24,"icon":14,"links":14},"Config Env Vars","/_partials/config-env-vars","_partials/config-env-vars","",{"title":26,"path":27,"stem":28,"description":24,"icon":14,"links":14},"Deployment Public Instance","/_partials/deployment-public-instance","_partials/deployment-public-instance",{"title":30,"path":31,"stem":32,"description":24,"icon":14,"links":14},"Engine Studio Box","/_partials/engine-studio-box","_partials/engine-studio-box",{"title":34,"path":35,"stem":36,"description":37,"icon":14,"links":14},"Extension Hook Footguns","/_partials/extension-hook-footguns","_partials/extension-hook-footguns","Directus reads system collections to operate. Be careful when modifying the output of system collection read or query events. Also ensure not to directly or indirectly emit the same event your hook is handling or you will create an infinite loop.",{"title":39,"path":40,"stem":41,"description":24,"icon":14,"links":14},"Extension Hook System Collections","/_partials/extension-hook-system-collections","_partials/extension-hook-system-collections",{"title":43,"path":44,"stem":45,"description":46,"icon":14,"links":14},"Extensions Api","/_partials/extensions-api","_partials/extensions-api","This extension type is loaded into the Directus process. They can use the provided services exported by the @directus/extensions-sdk package and can be written in JavaScript or TypeScript.",{"title":48,"path":49,"stem":50,"description":24,"icon":14,"links":14},"Extensions Api Internals","/_partials/extensions-api-internals","_partials/extensions-api-internals",{"title":52,"path":53,"stem":54,"description":55,"icon":14,"links":14},"Extensions App","/_partials/extensions-app","_partials/extensions-app","This extension type is loaded into the Directus Data Studio. They are are built with Vue 3, and can use the provided composables exported by the @directus/extensions-sdk package. Extensions can be written in JavaScript or TypeScript.",{"title":57,"path":58,"stem":59,"description":24,"icon":14,"links":14},"Extensions App Internals","/_partials/extensions-app-internals","_partials/extensions-app-internals",{"title":61,"path":62,"stem":63,"description":24,"icon":14,"links":14},"Extensions Theme","/_partials/extensions-theme","_partials/extensions-theme",{"title":65,"path":66,"stem":67,"description":24,"icon":14,"links":14},"Extensions Uid","/_partials/extensions-uid","_partials/extensions-uid",{"title":69,"path":70,"stem":71,"children":72,"page":89},"Home Hero","/_partials/home-hero","_partials/home-hero",[73,77,81,85],{"title":74,"path":75,"stem":76,"description":24,"icon":14,"links":14},"Auth","/_partials/home-hero/auth","_partials/home-hero/auth",{"title":78,"path":79,"stem":80,"description":24,"icon":14,"links":14},"Data","/_partials/home-hero/data","_partials/home-hero/data",{"title":82,"path":83,"stem":84,"description":24,"icon":14,"links":14},"File","/_partials/home-hero/file","_partials/home-hero/file",{"title":86,"path":87,"stem":88,"description":24,"icon":14,"links":14},"Realtime","/_partials/home-hero/realtime","_partials/home-hero/realtime",false,{"title":91,"path":92,"stem":93,"description":24,"icon":14,"links":14},"Json Function","/_partials/json-function","_partials/json-function",{"title":95,"path":96,"stem":97,"description":24,"icon":14,"links":14},"License","/_partials/license","_partials/license",{"title":99,"path":100,"stem":101,"description":102,"icon":14,"links":14},"Query Functions","/_partials/query-functions","_partials/query-functions","Functions accept a field and return a modified value. Functions can be used in any query parameter you'd normally supply a field key, including fields, aggregation, and filters.",{"title":104,"path":105,"stem":106,"description":107,"icon":14,"links":14},"Quickstart Making Calls","/_partials/quickstart-making-calls","_partials/quickstart-making-calls","You can use a visual API testing tool like Postman or Hoppscotch, a terminal-based based tool like curl or HTTPie, or make HTTP requests directly in a script written in your programming language of choice.",{"title":109,"path":110,"stem":111,"description":24,"icon":14,"links":14},"Snippet Auth Token","/_partials/snippet-auth-token","_partials/snippet-auth-token",{"title":113,"path":114,"stem":115,"children":116,"description":118,"icon":14,"links":14},"Directus API Reference","/api","api/index",[117],{"title":113,"path":114,"stem":115,"description":118,"icon":14,"links":14},"Learn how to use our API",{"title":120,"path":121,"stem":122,"children":123,"page":89},"Cloud","/cloud","cloud",[124,144,174,204],{"title":125,"path":126,"stem":127,"children":128,"page":89},"Getting Started","/cloud/getting-started","cloud/1.getting-started",[129,134,139],{"title":130,"path":131,"stem":132,"description":133,"icon":14,"links":14},"Introduction","/cloud/getting-started/introduction","cloud/1.getting-started/1.introduction","Whether you're a hobbyist, startup, or enterprise, our flexible Directus Cloud platform lets you get up and running with Directus quickly.",{"title":135,"path":136,"stem":137,"description":138,"icon":14,"links":14},"Cloud Teams","/cloud/getting-started/teams","cloud/1.getting-started/2.teams","A team is an organizational system that groups accounts together as team members and provides consolidated billing for projects.",{"title":140,"path":141,"stem":142,"description":143,"icon":14,"links":14},"Managing Cloud Accounts","/cloud/getting-started/accounts","cloud/1.getting-started/3.accounts","An account is your portal to Directus Cloud. You can use it to manage your teams, team members, projects and billing.",{"title":145,"path":146,"stem":147,"children":148,"page":89},"Projects","/cloud/projects","cloud/2.projects",[149,154,159,164,169],{"title":150,"path":151,"stem":152,"description":153,"icon":14,"links":14},"Create a Project","/cloud/projects/create","cloud/2.projects/1.create","Create a project in Directus Cloud.",{"title":155,"path":156,"stem":157,"description":158,"icon":14,"links":14},"Destroy a Project","/cloud/projects/destroy","cloud/2.projects/2.destroy","Destroy a Directus Cloud project and cancel your subscription.",{"title":160,"path":161,"stem":162,"description":163,"icon":14,"links":14},"Version Upgrades","/cloud/projects/version-upgrades","cloud/2.projects/3.version-upgrades","Learn about automatic upgrades and version locking in Directus Cloud.",{"title":165,"path":166,"stem":167,"description":168,"icon":14,"links":14},"Monitoring Projects","/cloud/projects/monitoring","cloud/2.projects/4.monitoring","Learn how to monitor your Directus Cloud project.",{"title":170,"path":171,"stem":172,"description":173,"icon":14,"links":14},"Backups","/cloud/projects/backups","cloud/2.projects/5.backups","Learn about automatic backups in Directus Cloud.",{"title":175,"path":176,"stem":177,"children":178,"page":89},"Configuration","/cloud/configuration","cloud/3.configuration",[179,184,189,194,199],{"title":180,"path":181,"stem":182,"description":183,"icon":14,"links":14},"Custom Domains","/cloud/configuration/custom-domains","cloud/3.configuration/1.custom-domains","Learn how to set up a custom domain for your Directus Enterprise Cloud project.",{"title":185,"path":186,"stem":187,"description":188,"icon":14,"links":14},"Environment Variables","/cloud/configuration/environment-variables","cloud/3.configuration/2.environment-variables","Learn about environment variables in Directus Cloud.",{"title":190,"path":191,"stem":192,"description":193,"icon":14,"links":14},"Direct Database Access","/cloud/configuration/direct-database-access","cloud/3.configuration/3.direct-database-access","Learn how to directly access your Directus Cloud project's database.",{"title":195,"path":196,"stem":197,"description":198,"icon":14,"links":14},"Custom Extensions","/cloud/configuration/custom-extensions","cloud/3.configuration/4.custom-extensions","Learn how to deploy custom extensions to your Directus Cloud project.",{"title":200,"path":201,"stem":202,"description":203,"icon":14,"links":14},"Datacenter Regions","/cloud/configuration/datacenter-regions","cloud/3.configuration/5.datacenter-regions","Learn where datacenters for cloud projects are located.",{"title":205,"path":206,"stem":207,"children":208,"page":89},"Billing","/cloud/billing","cloud/4.billing",[209,214,219],{"title":210,"path":211,"stem":212,"description":213,"icon":14,"links":14},"Manage Billing","/cloud/billing/manage-billing","cloud/4.billing/1.manage-billing","Learn how to manage billing for your Directus Cloud project.",{"title":215,"path":216,"stem":217,"description":218,"icon":14,"links":14},"Changing Your Tier","/cloud/billing/changing-tier","cloud/4.billing/2.changing-tier","Learn how to change the tier of your Directus Cloud project.",{"title":220,"path":221,"stem":222,"description":223,"icon":14,"links":14},"Cancel Your Subscription","/cloud/billing/cancel-subscription","cloud/4.billing/3.cancel-subscription","Learn how to cancel your Directus Cloud project subscription.",{"title":225,"path":226,"stem":227,"children":228,"page":89},"Community","/community","community",[229,249,274,293,318],{"title":230,"path":231,"stem":232,"children":233,"page":89},"Overview","/community/overview","community/1.overview",[234,239,244],{"title":235,"path":236,"stem":237,"description":238,"icon":14,"links":14},"Welcome","/community/overview/welcome","community/1.overview/1.welcome","Welcome to the Directus community!",{"title":240,"path":241,"stem":242,"description":243,"icon":14,"links":14},"Code of Conduct","/community/overview/conduct","community/1.overview/2.conduct","Our standards, responsibilities, and enforcement guidelines to create a positive community.",{"title":245,"path":246,"stem":247,"description":248,"icon":14,"links":14},"Moderation Guidelines","/community/overview/moderation","community/1.overview/3.moderation","Guidelines we give to community moderators.",{"title":250,"path":251,"stem":252,"children":253,"page":89},"Contribution","/community/contribution","community/2.contribution",[254,259,264,269],{"title":255,"path":256,"stem":257,"description":258,"icon":14,"links":14},"Translations","/community/contribution/translations","community/2.contribution/1.translations","How to contribute to translating the Data Studio.",{"title":260,"path":261,"stem":262,"description":263,"icon":14,"links":14},"Documentation","/community/contribution/documentation","community/2.contribution/2.documentation","How to contribute to the Directus documentation.",{"title":265,"path":266,"stem":267,"description":268,"icon":14,"links":14},"Feature Requests","/community/contribution/feature-requests","community/2.contribution/3.feature-requests","How to add feature requests, and our process for reviewing them.",{"title":270,"path":271,"stem":272,"description":273,"icon":14,"links":14},"Pull Requests","/community/contribution/pull-requests","community/2.contribution/4.pull-requests","Our process for contributing pull requests to Directus.",{"title":275,"path":276,"stem":277,"children":278,"page":89},"Codebase","/community/codebase","community/3.codebase",[279,283,288],{"title":275,"path":280,"stem":281,"description":282,"icon":14,"links":14},"/community/codebase/overview","community/3.codebase/1.overview","Overview of the Directus codebase for new contributors",{"title":284,"path":285,"stem":286,"description":287,"icon":14,"links":14},"Development Environment","/community/codebase/dev-environment","community/3.codebase/2.dev-environment","How to set up and run a development environment for Directus so that you can work on the platform's source code.",{"title":289,"path":290,"stem":291,"description":292,"icon":14,"links":14},"Testing","/community/codebase/testing","community/3.codebase/3.testing","How to run unit and blackbox tests in the Directus codebase.",{"title":294,"path":295,"stem":296,"children":297,"page":89},"Reporting And Support","/community/reporting-and-support","community/4.reporting-and-support",[298,303,308,313],{"title":299,"path":300,"stem":301,"description":302,"icon":14,"links":14},"Troubleshooting Steps","/community/reporting-and-support/troubleshooting-steps","community/4.reporting-and-support/1.troubleshooting-steps","If you're experiencing issues or think you have found a problem in Directus, be sure to follow these steps.",{"title":304,"path":305,"stem":306,"description":307,"icon":14,"links":14},"Bug Reporting","/community/reporting-and-support/bug-reporting","community/4.reporting-and-support/2.bug-reporting","How to report bugs in Directus.",{"title":309,"path":310,"stem":311,"description":312,"icon":14,"links":14},"Security Reporting","/community/reporting-and-support/security-reporting","community/4.reporting-and-support/3.security-reporting","How to report security issues in Directus.",{"title":314,"path":315,"stem":316,"description":317,"icon":14,"links":14},"Customer Support","/community/reporting-and-support/customer-support","community/4.reporting-and-support/4.customer-support","How to get help with Directus as a user and customer.",{"title":319,"path":320,"stem":321,"children":322,"page":89},"Programs","/community/programs","community/5.programs",[323,328],{"title":324,"path":325,"stem":326,"description":327,"icon":14,"links":14},"Guest Authors","/community/programs/guest-authors","community/5.programs/1.guest-authors","Our guest author program invites authors to join and get paid to write tutorials for the Directus community.",{"title":329,"path":330,"stem":331,"description":332,"icon":14,"links":14},"Directus Labs","/community/programs/directus-labs","community/5.programs/2.directus-labs","Directus Labs is the official organization for Directus templates, settings and experimental projects.",{"title":175,"path":334,"stem":335,"children":336,"page":89},"/configuration","configuration",[337,341,346,351,356,361,366,371,376,381,386,391,396,401,406,410,415,420,425],{"title":130,"path":338,"stem":339,"description":340,"icon":14,"links":14},"/configuration/intro","configuration/0.intro","Environment variables are used for all configuration within a Directus project. These variables can be defined in a number of ways, which we cover below.",{"title":342,"path":343,"stem":344,"description":345,"icon":14,"links":14},"General","/configuration/general","configuration/1.general","Configuration for the general system, server, first admin user, and telemetry.",{"title":347,"path":348,"stem":349,"description":350,"icon":14,"links":14},"AI","/configuration/ai","configuration/ai","Configuration for AI Assistant and Model Context Protocol (MCP) features.",{"title":352,"path":353,"stem":354,"description":355,"icon":14,"links":14},"Auth & SSO","/configuration/auth-sso","configuration/auth-sso","Configuration for authentication methods, including local email/password, OAuth 2.0, OpenID, LDAP, and SAML.",{"title":357,"path":358,"stem":359,"description":360,"icon":14,"links":14},"Cache","/configuration/cache","configuration/cache","Configuration for internal and output caching.",{"title":362,"path":363,"stem":364,"description":365,"icon":14,"links":14},"Database","/configuration/database","configuration/database","Configuration for database connections.",{"title":367,"path":368,"stem":369,"description":370,"icon":14,"links":14},"Email","/configuration/email","configuration/email","Configuration for email settings and templates.",{"title":372,"path":373,"stem":374,"description":375,"icon":14,"links":14},"Extensions","/configuration/extensions","configuration/extensions","Configuration for extensions and the Directus Marketplace.",{"title":377,"path":378,"stem":379,"description":380,"icon":14,"links":14},"Files","/configuration/files","configuration/files","Configuration for storage locations, metadata, upload limits, and transformations.",{"title":382,"path":383,"stem":384,"description":385,"icon":14,"links":14},"Flows","/configuration/flows","configuration/flows","Configure environment variables, memory, and timeout for Flows.",{"title":387,"path":388,"stem":389,"description":390,"icon":14,"links":14},"Logging","/configuration/logging","configuration/logging","Configuration for general and Realtime logging.",{"title":392,"path":393,"stem":394,"description":395,"icon":14,"links":14},"Metrics","/configuration/metrics","configuration/metrics","Configuration for metrics.",{"title":397,"path":398,"stem":399,"description":400,"icon":14,"links":14},"Migrations","/configuration/migrations","configuration/migrations","Creation of custom migration files to automate database changes.",{"title":402,"path":403,"stem":404,"description":405,"icon":14,"links":14},"PM2","/configuration/pm2","configuration/pm2","Configuration for PM2, the process manager for Directus.",{"title":86,"path":407,"stem":408,"description":409,"icon":14,"links":14},"/configuration/realtime","configuration/realtime","Configuration for WebSockets and GraphQL Subscriptions.",{"title":411,"path":412,"stem":413,"description":414,"icon":14,"links":14},"Security & Limits","/configuration/security-limits","configuration/security-limits","Configuration for access tokens, cookies, CSP, hashing, CORS, rate limiting, and request limits.",{"title":416,"path":417,"stem":418,"description":419,"icon":14,"links":14},"Synchronization","/configuration/synchronization","configuration/synchronization","Configuration around synchronization and Redis.",{"title":421,"path":422,"stem":423,"description":424,"icon":14,"links":14},"Theming","/configuration/theming","configuration/theming","Configuration of the Data Studio's theming engine and appearance settings.",{"title":255,"path":426,"stem":427,"description":428,"icon":14,"links":14},"/configuration/translations","configuration/translations","Directus supports translations for both the Data Studio UI and authored content.",{"title":125,"description":14,"icon":14,"links":14,"path":430,"stem":431,"children":432,"page":89},"/getting-started","getting-started",[433,437,442,446,451,456,461,466,471,476],{"title":230,"path":434,"stem":435,"description":436,"icon":14,"links":14},"/getting-started/overview","getting-started/1.overview","Learn about the Directus Data Engine and Studio, when to use it, and how it works.",{"title":438,"path":439,"stem":440,"description":441,"icon":14,"links":14},"Accessibility","/getting-started/accessibility","getting-started/10.accessibility","We are always looking for ways to make Directus Studio more accessible. Here are some of the methods we currently support.",{"title":150,"path":443,"stem":444,"description":445,"icon":14,"links":14},"/getting-started/create-a-project","getting-started/2.create-a-project","Learn about how to create a managed Directus project or self-host with Docker.",{"title":447,"path":448,"stem":449,"description":450,"icon":14,"links":14,"label":447},"Configure a Data Model","/getting-started/data-model","getting-started/3.data-model","This guide will cover creating a collection in Directus via the Data Studio, creating fields, and configuring relationships.",{"title":452,"path":453,"stem":454,"description":455,"icon":14,"links":14},"Use the API","/getting-started/use-the-api","getting-started/4.use-the-api","Get started with Directus APIs. Learn to interact with collections, fetch, and create data.",{"title":457,"path":458,"stem":459,"description":460,"icon":14,"links":14},"Authenticate a User","/getting-started/authenticate-user","getting-started/5.authenticate-user","Get started with Directus Auth. Learn how to register, login, create users, and make authenticated requests.",{"title":462,"path":463,"stem":464,"description":465,"icon":14,"links":14},"Upload & Access Files","/getting-started/upload-files","getting-started/6.upload-files","This guide will cover importing a file via URL, requesting assets, and using transformation parameters.",{"title":467,"path":468,"stem":469,"description":470,"icon":14,"links":14},"Create an Automation","/getting-started/create-an-automation","getting-started/7.create-an-automation","Get started using flows, triggers, operations and the data chain in Directus Automate.",{"title":472,"path":473,"stem":474,"description":475,"icon":14,"links":14},"Connect to Realtime Data","/getting-started/connect-to-realtime","getting-started/8.connect-to-realtime","This guide will cover connecting to Directus via WebSockets on the web, subscribing to changes, and creating new items over the connection.",{"title":477,"path":478,"stem":479,"description":480,"icon":14,"links":14},"Resources & Links","/getting-started/resources","getting-started/9.resources","Key links across the Directus ecosystem.",{"title":482,"path":483,"stem":484,"children":485,"page":89},"Guides","/guides","guides",[486,512,595,642,677,707,732,756,771,886,899,988],{"title":487,"description":14,"icon":488,"links":14,"path":489,"stem":490,"children":491,"page":89},"Data Model","directus-explore","/guides/data-model","guides/01.data-model",[492,497,502,507],{"title":493,"path":494,"stem":495,"description":496,"icon":14,"links":14},"Collections","/guides/data-model/collections","guides/01.data-model/1.collections","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.",{"title":498,"path":499,"stem":500,"description":501,"icon":14,"links":14},"Fields","/guides/data-model/fields","guides/01.data-model/2.fields","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.",{"title":503,"path":504,"stem":505,"description":506,"icon":14,"links":14},"Interfaces","/guides/data-model/interfaces","guides/01.data-model/3.interfaces","Manage your data effectively with Directus fields. Discover various field types, interfaces, validations, and relationships to perfectly suit your data modeling needs.",{"title":508,"path":509,"stem":510,"description":511,"icon":14,"links":14},"Relationships","/guides/data-model/relationships","guides/01.data-model/4.relationships","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.",{"title":513,"description":14,"icon":514,"links":14,"path":515,"stem":516,"children":517,"page":89},"Content","directus-editor","/guides/content","guides/02.content",[518,523,528,533,538,543,548,552,574],{"title":519,"path":520,"stem":521,"description":522,"icon":14,"links":14},"Collection Explorer","/guides/content/explore","guides/02.content/1.explore","Learn to filter, layout, batch edit and more with collections in the collection explorer.",{"title":524,"path":525,"stem":526,"description":527,"icon":14,"links":14},"Item Editor","/guides/content/editor","guides/02.content/2.editor","Learn to create, duplicate, archive and perform other actions with items using Directus.",{"title":529,"path":530,"stem":531,"description":532,"icon":14,"links":14},"Layouts","/guides/content/layouts","guides/02.content/3.layouts","Learn to use layouts for viewing and interacting with items in a collection using Directus.",{"title":534,"path":535,"stem":536,"description":537,"icon":14,"links":14},"Import & Export","/guides/content/import-export","guides/02.content/4.import-export","Learn to import and export multiple items stored as files using Directus.",{"title":539,"path":540,"stem":541,"description":542,"icon":14,"links":14},"Live Preview","/guides/content/live-preview","guides/02.content/5.live-preview","Learn to set up your project for live previewing items from your application.",{"title":544,"path":545,"stem":546,"description":547,"icon":14,"links":14},"Content Versioning","/guides/content/content-versioning","guides/02.content/6.content-versioning","This guide covers the process of enabling and utilizing Content Versioning in Directus.",{"title":255,"path":549,"stem":550,"description":551,"icon":14,"links":14},"/guides/content/translations","guides/02.content/7.translations","Both content and the data studio can be translated into multiple languages.",{"title":553,"path":554,"stem":555,"children":556,"description":558,"icon":14,"links":14},"Visual Editor","/guides/content/visual-editor","guides/02.content/8.visual-editor/0.index",[557,559,564,569],{"title":553,"path":554,"stem":555,"description":558,"icon":14,"links":14},"The Directus visual editor module allows you to visually edit the content of your website directly in-place.",{"title":560,"path":561,"stem":562,"description":563,"icon":14,"links":14},"Frontend Library","/guides/content/visual-editor/frontend-library","guides/02.content/8.visual-editor/1.frontend-library","A library that allows your website to communicate with your Directus project and enables Visual Editing.",{"title":565,"path":566,"stem":567,"description":568,"icon":14,"links":14},"Studio Module","/guides/content/visual-editor/studio-module","guides/02.content/8.visual-editor/2.studio-module","Learn how to edit your website's content in place from within the Directus Studio.",{"title":570,"path":571,"stem":572,"description":573,"icon":14,"links":14},"Customization","/guides/content/visual-editor/customization","guides/02.content/8.visual-editor/3.customization","Customize the styling of your Visual Editing experience to suit your brand or website theming.",{"title":575,"path":576,"stem":577,"children":578,"description":580,"icon":14,"links":14},"Collaborative Editing","/guides/content/collaborative-editing","guides/02.content/9.collaborative-editing/0.index",[579,581,585,590],{"title":575,"path":576,"stem":577,"description":580,"icon":14,"links":14},"Directus Collaborative Editing enables real-time data synchronization and collaborative editing across collections, allowing multiple users to edit content simultaneously without conflicts.",{"title":175,"path":582,"stem":583,"description":584,"icon":14,"links":14},"/guides/content/collaborative-editing/configuration","guides/02.content/9.collaborative-editing/1.configuration","Learn how to configure Collaborative Editing in your Directus project.",{"title":586,"path":587,"stem":588,"description":589,"icon":14,"links":14},"Usage Guide","/guides/content/collaborative-editing/usage","guides/02.content/9.collaborative-editing/2.usage","Learn how to use Collaborative Editing for real-time collaboration on content in your Directus project.",{"title":591,"path":592,"stem":593,"description":594,"icon":14,"links":14},"Development & Custom Extensions","/guides/content/collaborative-editing/development","guides/02.content/9.collaborative-editing/3.development","Learn how Custom Interfaces integrate with Collaborative Editing in Directus.",{"title":74,"description":14,"icon":596,"links":14,"path":597,"stem":598,"children":599,"page":89},"directus-auth","/guides/auth","guides/03.auth",[600,605,610,615,620,625,630],{"title":601,"path":602,"stem":603,"description":604,"icon":14,"links":14},"Access Tokens","/guides/auth/tokens-cookies","guides/03.auth/1.tokens-cookies","Learn how to authenticate requests & explore standard, session, and static token types.",{"title":606,"path":607,"stem":608,"description":609,"icon":14,"links":14},"Access Control","/guides/auth/access-control","guides/03.auth/2.access-control","Manage user and role permissions and policies for interacting with data in Directus.",{"title":611,"path":612,"stem":613,"description":614,"icon":14,"links":14},"Creating Users","/guides/auth/creating-users","guides/03.auth/3.creating-users","Learn about creating users in directus, including API creation, inviting users, and seamless invites.",{"title":616,"path":617,"stem":618,"description":619,"icon":14,"links":14},"Email Login","/guides/auth/email-login","guides/03.auth/4.email-login","Learn about user registration, login with standard/session tokens, refresh, logout, and resetting passwords.",{"title":621,"path":622,"stem":623,"description":624,"icon":14,"links":14},"Two-Factor Auth","/guides/auth/2fa","guides/03.auth/5.2fa","Secure your logins with one-time codes! Learn how to generate secrets, enable/disable 2FA.",{"title":626,"path":627,"stem":628,"description":629,"icon":14,"links":14},"Accountability","/guides/auth/accountability","guides/03.auth/6.accountability","Learn to audit user activity and enforce accountability using the activity feed.",{"title":631,"path":632,"stem":633,"children":634,"description":636,"icon":14,"links":14},"Single Sign-On","/guides/auth/sso","guides/03.auth/7.sso/1.index",[635,637],{"title":631,"path":632,"stem":633,"description":636,"icon":14,"links":14},"Single Sign-On is a mechanism which allows to use external providers to login into systems.",{"title":638,"path":639,"stem":640,"description":641,"icon":14,"links":14},"Seamless SSO","/guides/auth/sso/seamless","guides/03.auth/7.sso/2.seamless","Seamless SSO is a setup to allow logging in without the user ever seeing Directus' login page.",{"title":643,"description":14,"icon":644,"links":14,"path":645,"stem":646,"children":647,"page":89},"Connect","directus-connect","/guides/connect","guides/04.connect",[648,652,657,662,667,672],{"title":16,"path":649,"stem":650,"description":651,"icon":14,"links":14},"/guides/connect/authentication","guides/04.connect/1.authentication","Discover how to authenticate Directus Connect requests using authorization headers, session cookies, or query parameters.",{"title":653,"path":654,"stem":655,"description":656,"icon":14,"links":14},"Filter Rules","/guides/connect/filter-rules","guides/04.connect/2.filter-rules","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.",{"title":658,"path":659,"stem":660,"description":661,"icon":14,"links":14},"Query Parameters","/guides/connect/query-parameters","guides/04.connect/3.query-parameters","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.",{"title":663,"path":664,"stem":665,"description":666,"icon":14,"links":14},"Relational Data","/guides/connect/relations","guides/04.connect/4.relations","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.",{"title":668,"path":669,"stem":670,"description":671,"icon":14,"links":14},"Error Codes","/guides/connect/errors","guides/04.connect/5.errors","Learn about Directus error codes - understand what each code means, from validation failures to rate limits exceeded. Troubleshoot issues with your API requests and resolve errors efficiently.",{"title":673,"path":674,"stem":675,"description":676,"icon":14,"links":14},"Directus SDK","/guides/connect/sdk","guides/04.connect/6.sdk","A JavaScript and TypeScript library that simplifies working with Directus.",{"title":377,"description":14,"icon":678,"links":14,"path":679,"stem":680,"children":681,"page":89},"directus-files","/guides/files","guides/05.files",[682,687,692,697,702],{"title":683,"path":684,"stem":685,"description":686,"icon":14,"links":14},"Upload Files","/guides/files/upload","guides/05.files/1.upload","Learn to upload files to Directus via both the data studio or API.",{"title":688,"path":689,"stem":690,"description":691,"icon":14,"links":14},"Download Files","/guides/files/download","guides/05.files/2.download","Learn to download content from the File Library",{"title":693,"path":694,"stem":695,"description":696,"icon":14,"links":14},"Manage Files","/guides/files/manage","guides/05.files/3.manage","Learn to view, modify, edit and set files' focal points.",{"title":698,"path":699,"stem":700,"description":701,"icon":14,"links":14},"Access Files","/guides/files/access","guides/05.files/4.access","Learn how to access uploaded files, authenticate, provide optional filenames and directly download them.",{"title":703,"path":704,"stem":705,"description":706,"icon":14,"links":14},"Transform Files","/guides/files/transform","guides/05.files/5.transform","Learn how to transform files and set custom presets for these transformations.",{"title":708,"description":14,"icon":709,"links":14,"path":710,"stem":711,"children":712,"page":89},"Automate","directus-automate","/guides/automate","guides/06.automate",[713,717,722,727],{"title":382,"path":714,"stem":715,"description":716,"icon":14,"links":14},"/guides/automate/flows","guides/06.automate/1.flows","Flows enable custom, event-driven data processing and task automation within Directus.",{"title":718,"path":719,"stem":720,"description":721,"icon":14,"links":14},"Data Chain","/guides/automate/data-chain","guides/06.automate/2.data-chain","Data chains are created by each flow and hold information that can be accessed within different operations.",{"title":723,"path":724,"stem":725,"description":726,"icon":14,"links":14},"Triggers","/guides/automate/triggers","guides/06.automate/3.triggers","Triggers define the action or events that start flows.",{"title":728,"path":729,"stem":730,"description":731,"icon":14,"links":14},"Operations","/guides/automate/operations","guides/06.automate/4.operations","Operations are individual customizable actions in a flow.",{"title":86,"description":14,"icon":733,"links":14,"path":734,"stem":735,"children":736,"page":89},"directus-realtime","/guides/realtime","guides/07.realtime",[737,741,746,751],{"title":16,"path":738,"stem":739,"description":740,"icon":14,"links":14},"/guides/realtime/authentication","guides/07.realtime/1.authentication","Learn to implement the three authentication modes.",{"title":742,"path":743,"stem":744,"description":745,"icon":14,"links":14},"Subscriptions","/guides/realtime/subscriptions","guides/07.realtime/2.subscriptions","Learn to manage realtime subscriptions with both websockets and GraphQL.",{"title":747,"path":748,"stem":749,"description":750,"icon":14,"links":14},"Actions","/guides/realtime/actions","guides/07.realtime/3.actions","Learn to execute CRUD actions via websockets.",{"title":752,"path":753,"stem":754,"description":755,"icon":14,"links":14},"Custom WebSocket Handlers","/guides/realtime/custom-handlers","guides/07.realtime/4.custom-handlers","Build custom WebSocket message handlers, push messages to connected clients, and react to WebSocket events using hook extensions.",{"title":757,"description":14,"icon":758,"links":14,"path":759,"stem":760,"children":761,"page":89},"Insights","directus-insights","/guides/insights","guides/08.insights",[762,766],{"title":230,"path":763,"stem":764,"description":765,"icon":14,"links":14},"/guides/insights/overview","guides/08.insights/1.overview","Insights is a module in Directus that allows rapid, no-code build-out of analytics dashboards.",{"title":767,"path":768,"stem":769,"description":770,"icon":14,"links":14},"Panels","/guides/insights/panels","guides/08.insights/2.panels","Panels are the building-blocks you can add onto insights dashboards to create, save and display data analytics.",{"title":372,"description":14,"icon":772,"links":14,"path":773,"stem":774,"children":775,"page":89},"directus-marketplace","/guides/extensions","guides/09.extensions",[776,780,785,817,864,869,881],{"title":230,"path":777,"stem":778,"description":779,"icon":14,"links":14},"/guides/extensions/overview","guides/09.extensions/0.overview","Extensions are used to extend the functionality of Directus.",{"title":781,"path":782,"stem":783,"description":784,"icon":14,"links":14},"Quickstart","/guides/extensions/quickstart","guides/09.extensions/1.quickstart","This guide will cover how to get started with developing an extension for Directus.",{"title":786,"path":787,"stem":788,"children":789,"description":791,"icon":14,"links":14},"API Extensions","/guides/extensions/api-extensions","guides/09.extensions/2.api-extensions/0.index",[790,792,797,802,807,812],{"title":786,"path":787,"stem":788,"description":791,"icon":14,"links":14},"API Extensions extend the functionality of the API.",{"title":793,"path":794,"stem":795,"description":796,"icon":14,"links":14},"Event Hooks","/guides/extensions/api-extensions/hooks","guides/09.extensions/2.api-extensions/1.hooks","Hooks allow running code when during the Directus lifecycle or database events.",{"title":798,"path":799,"stem":800,"description":801,"icon":14,"links":14},"API Endpoints","/guides/extensions/api-extensions/endpoints","guides/09.extensions/2.api-extensions/2.endpoints","Endpoints allow you to register new API routes in your Directus project.",{"title":803,"path":804,"stem":805,"description":806,"icon":14,"links":14},"Flow Operations","/guides/extensions/api-extensions/operations","guides/09.extensions/2.api-extensions/3.operations","Operations are single steps in a Flow - the no-code automation tool part of Directus Automate.",{"title":808,"path":809,"stem":810,"description":811,"icon":14,"links":14},"Services","/guides/extensions/api-extensions/services","guides/09.extensions/2.api-extensions/4.services","When building extensions, you may use internal Directus services directly.",{"title":813,"path":814,"stem":815,"description":816,"icon":14,"links":14},"Sandbox","/guides/extensions/api-extensions/sandbox","guides/09.extensions/2.api-extensions/5.sandbox","Sandboxed Extensions run in an isolated environment and must request permission scopes.",{"title":818,"path":819,"stem":820,"children":821,"description":823,"icon":14,"links":14},"App Extensions","/guides/extensions/app-extensions","guides/09.extensions/3.app-extensions/0.index",[822,824,829,834,839,844,849,854,859],{"title":818,"path":819,"stem":820,"description":823,"icon":14,"links":14},"App Extensions extend the functionality of the Data Studio.",{"title":825,"path":826,"stem":827,"description":828,"icon":14,"links":14},"Editor Interfaces","/guides/extensions/app-extensions/interfaces","guides/09.extensions/3.app-extensions/1.interfaces","Interfaces are form inputs used primarily inside of the Directus Editor.",{"title":830,"path":831,"stem":832,"description":833,"icon":14,"links":14},"Inline Displays","/guides/extensions/app-extensions/displays","guides/09.extensions/3.app-extensions/2.displays","Displays are used to display a single value throughout the Data Studio.",{"title":835,"path":836,"stem":837,"description":838,"icon":14,"links":14},"Explore Layouts","/guides/extensions/app-extensions/layouts","guides/09.extensions/3.app-extensions/3.layouts","Layouts are used to display a list of items in Explore pages in different ways.",{"title":840,"path":841,"stem":842,"description":843,"icon":14,"links":14},"Dashboard Panels","/guides/extensions/app-extensions/panels","guides/09.extensions/3.app-extensions/4.panels","Panels are customizable components within Directus Insights dashboards.",{"title":845,"path":846,"stem":847,"description":848,"icon":14,"links":14},"Custom Modules","/guides/extensions/app-extensions/modules","guides/09.extensions/3.app-extensions/5.modules","Modules are top-level areas of the Data Studio, navigated to from the left-hand module bar.",{"title":850,"path":851,"stem":852,"description":853,"icon":14,"links":14},"Custom Themes","/guides/extensions/app-extensions/themes","guides/09.extensions/3.app-extensions/6.themes","Themes are used to style elements of the Data Studio including colors and fonts.",{"title":855,"path":856,"stem":857,"description":858,"icon":14,"links":14},"UI Library","/guides/extensions/app-extensions/ui-library","guides/09.extensions/3.app-extensions/7.ui-library","Directus offers globally-registered UI components for building extensions.",{"title":860,"path":861,"stem":862,"description":863,"icon":14,"links":14},"Composables","/guides/extensions/app-extensions/composables","guides/09.extensions/3.app-extensions/8.composables","Vue composables for working with Directus services when building extensions.",{"title":865,"path":866,"stem":867,"description":868,"icon":14,"links":14},"Bundling Extensions","/guides/extensions/bundles","guides/09.extensions/4.bundles","Bundles are a way to group extensions together as a single distributable package.",{"title":870,"path":871,"stem":872,"children":873,"description":875,"icon":14,"links":14},"Marketplace Beta","/guides/extensions/marketplace","guides/09.extensions/5.marketplace/0.index",[874,876],{"title":870,"path":871,"stem":872,"description":875,"icon":14,"links":14},"The Directus Marketplace provides a way for users to install extensions in their projects directly the Data Studio.",{"title":877,"path":878,"stem":879,"description":880,"icon":14,"links":14},"Publishing Extensions","/guides/extensions/marketplace/publishing","guides/09.extensions/5.marketplace/1.publishing","Publish extensions to the Directus Marketplace via npm, including required metadata, best practices, and author profile setup.",{"title":882,"path":883,"stem":884,"description":885,"icon":14,"links":14},"CLI","/guides/extensions/cli","guides/09.extensions/6.cli","Using the create-directus-extension to build, validate and manage extensions.",{"title":887,"path":888,"stem":889,"children":890,"description":14,"icon":898,"links":14},"Deployments","/guides/deployments","guides/10.deployments/0.index",[891,893],{"title":230,"path":888,"stem":889,"description":892,"icon":14,"links":14},"Trigger, monitor, and manage frontend deployments directly from Directus.",{"title":894,"path":895,"stem":896,"description":897,"icon":14,"links":14},"Security","/guides/deployments/security","guides/10.deployments/1.security","Access control, permissions, and credential protection for the Deployment module.","directus-deployments",{"title":347,"path":900,"stem":901,"children":902,"description":14,"icon":987,"links":14},"/guides/ai","guides/11.ai/0.index",[903,906,937],{"title":904,"path":900,"stem":901,"description":905,"icon":14,"links":14},"AI + Directus","Use AI to interact with Directus - either through the built-in AI Assistant or by connecting external AI tools via MCP.",{"title":907,"path":908,"stem":909,"children":910,"description":14,"icon":14,"links":14},"AI Assistant","/guides/ai/assistant","guides/11.ai/1.assistant/0.index",[911,913,918,923,928,933],{"title":230,"path":908,"stem":909,"description":912,"icon":14,"links":14},"Chat with an AI assistant directly inside Directus. Create content, manage your schema, trigger automations, and explore your data through natural conversation.",{"title":914,"path":915,"stem":916,"description":917,"icon":14,"links":14},"Setup","/guides/ai/assistant/setup","guides/11.ai/1.assistant/1.setup","Configure AI Assistant by adding your AI provider API keys and customizing assistant behavior.",{"title":919,"path":920,"stem":921,"description":922,"icon":14,"links":14},"Usage","/guides/ai/assistant/usage","guides/11.ai/1.assistant/2.usage","Learn how to use AI Assistant to interact with your Directus instance through natural conversation.",{"title":924,"path":925,"stem":926,"description":927,"icon":14,"links":14},"Tools","/guides/ai/assistant/tools","guides/11.ai/1.assistant/3.tools","Reference of all tools available to AI Assistant for interacting with your Directus instance.",{"title":929,"path":930,"stem":931,"description":932,"icon":14,"links":14},"Best Practices","/guides/ai/assistant/tips","guides/11.ai/1.assistant/4.tips","Get the most out of AI Assistant with practical tips, example prompts, and common pitfalls to avoid.",{"title":894,"path":934,"stem":935,"description":936,"icon":14,"links":14},"/guides/ai/assistant/security","guides/11.ai/1.assistant/5.security","Security considerations for using AI Assistant safely with your Directus data.",{"title":938,"path":939,"stem":940,"children":941,"description":14,"icon":14,"links":14},"MCP Server","/guides/ai/mcp","guides/11.ai/2.mcp/0.index",[942,944,949,954,958,963,968,972],{"title":230,"path":939,"stem":940,"description":943,"icon":14,"links":14},"Connect AI assistants directly to your Directus instance. Let Claude, ChatGPT, and other AI tools manage your content without manual copy-pasting.",{"title":945,"path":946,"stem":947,"description":948,"icon":14,"links":14},"Installation","/guides/ai/mcp/installation","guides/11.ai/2.mcp/1.installation","Set up the Directus MCP server and connect your AI tools in under 5 minutes.",{"title":950,"path":951,"stem":952,"description":953,"icon":14,"links":14},"Use Cases","/guides/ai/mcp/use-cases","guides/11.ai/2.mcp/2.use-cases","Real examples of how to use AI with your Directus content to save time and reduce repetitive work.",{"title":924,"path":955,"stem":956,"description":957,"icon":14,"links":14},"/guides/ai/mcp/tools","guides/11.ai/2.mcp/3.tools","Learn about the tools available in the Directus remote MCP server and how they enable AI-powered content management.",{"title":959,"path":960,"stem":961,"description":962,"icon":14,"links":14},"Prompts","/guides/ai/mcp/prompts","guides/11.ai/2.mcp/4.prompts","Learn how to configure and use stored prompts with the Directus MCP Server.",{"title":964,"path":965,"stem":966,"description":967,"icon":14,"links":14},"Troubleshooting","/guides/ai/mcp/troubleshooting","guides/11.ai/2.mcp/5.troubleshooting","Common issues and solutions when setting up and using the Directus MCP server.",{"title":894,"path":969,"stem":970,"description":971,"icon":14,"links":14},"/guides/ai/mcp/security","guides/11.ai/2.mcp/6.security","Practical security guidelines for using the Directus MCP server safely and protecting your data.",{"title":973,"path":974,"stem":975,"children":976,"description":14,"icon":14,"links":14},"Local MCP","/guides/ai/mcp/local-mcp","guides/11.ai/2.mcp/7.local-mcp/0.index",[977,979,983],{"title":945,"path":974,"stem":975,"description":978,"icon":14,"links":14},"The Directus Content MCP Server allows you to interact with your Directus data through AI tools using the Model Context Protocol.",{"title":924,"path":980,"stem":981,"description":982,"icon":14,"links":14},"/guides/ai/mcp/local-mcp/tools","guides/11.ai/2.mcp/7.local-mcp/1.tools","Learn about the tools available in the local Directus Content MCP Server and how to configure them.",{"title":959,"path":984,"stem":985,"description":986,"icon":14,"links":14},"/guides/ai/mcp/local-mcp/prompts","guides/11.ai/2.mcp/7.local-mcp/2.prompts","Configure stored prompts with the local MCP server using environment variables and manual collection setup.","directus-ai",{"title":989,"description":14,"icon":990,"links":14,"path":991,"stem":992,"children":993},"Integrations","directus-integrations","/guides/integrations","guides/12.integrations/index",[994,996,1003,1024,1046,1065,1076],{"title":989,"path":991,"stem":992,"description":995,"icon":14,"links":14},"Connect Directus with third-party tools and services to extend functionality and automate workflows.",{"title":997,"path":998,"stem":999,"children":1000,"description":14,"icon":14,"links":14},"Framer","/guides/integrations/framer","guides/11.integrations/6.framer/0.index",[1001],{"title":997,"path":998,"stem":999,"description":1002,"icon":14,"links":14},"Connect your Directus collections to Framer's CMS to sync content in both directions using the Directus Framer plugin.",{"title":1004,"path":1005,"stem":1006,"children":1007,"description":14,"icon":14,"links":14},"n8n","/guides/integrations/n8n","guides/12.integrations/1.n8n/0.index",[1008,1011,1015,1020],{"title":1009,"path":1005,"stem":1006,"description":1010,"icon":14,"links":14},"Integration","Connect Directus with n8n to automate workflows, sync data, and integrate your CMS with other services using the Directus community node.",{"title":747,"path":1012,"stem":1013,"description":1014,"icon":14,"links":14},"/guides/integrations/n8n/directus-n8n-actions","guides/12.integrations/1.n8n/directus-n8n-actions","Complete guide for using Directus actions in n8n workflows, including working with items, users, and files.",{"title":1016,"path":1017,"stem":1018,"description":1019,"icon":14,"links":14},"Advanced","/guides/integrations/n8n/directus-n8n-advanced","guides/12.integrations/1.n8n/directus-n8n-advanced","Advanced guide for using Directus raw CRUD operations in n8n, including raw JSON operations, complex filters, relational queries, and query parameters.",{"title":723,"path":1021,"stem":1022,"description":1023,"icon":14,"links":14},"/guides/integrations/n8n/directus-n8n-triggers","guides/12.integrations/1.n8n/directus-n8n-triggers","Complete guide for using Directus triggers in n8n workflows to automate workflows when events happen in Directus.",{"title":1025,"path":1026,"stem":1027,"children":1028,"description":14,"icon":14,"links":14},"Clay","/guides/integrations/clay","guides/12.integrations/2.clay/0.index",[1029,1031,1036,1041],{"title":1009,"path":1026,"stem":1027,"description":1030,"icon":14,"links":14},"Connect Directus with Clay to automate data enrichment and sync content between platforms using webhooks and HTTP API templates.",{"title":1032,"path":1033,"stem":1034,"description":1035,"icon":14,"links":14},"Data Operations","/guides/integrations/clay/directus-clay-data-operations","guides/12.integrations/2.clay/directus-clay-data-operations","Advanced techniques for working with Directus data in Clay, including filters, pagination, common use cases, and best practices.",{"title":1037,"path":1038,"stem":1039,"description":1040,"icon":14,"links":14},"Templates","/guides/integrations/clay/use-clay-templates-with-directus","guides/12.integrations/2.clay/use-clay-templates-with-directus","Learn how to use Clay's pre-built HTTP API templates to connect with Directus for data enrichment and synchronization.",{"title":1042,"path":1043,"stem":1044,"description":1045,"icon":14,"links":14},"Webhooks","/guides/integrations/clay/use-directus-webhooks-with-clay","guides/12.integrations/2.clay/use-directus-webhooks-with-clay","Learn how to set up Directus Flows to automatically send data to Clay webhooks for real-time data synchronization.",{"title":1047,"path":1048,"stem":1049,"children":1050,"description":14,"icon":14,"links":14},"Zapier","/guides/integrations/zapier","guides/12.integrations/3.zapier/0.index",[1051,1053,1057,1061],{"title":1009,"path":1048,"stem":1049,"description":1052,"icon":14,"links":14},"Connect Directus with Zapier to automate workflows, sync data, and integrate your CMS with thousands of other apps using the Directus Zapier integration.",{"title":747,"path":1054,"stem":1055,"description":1056,"icon":14,"links":14},"/guides/integrations/zapier/actions","guides/12.integrations/3.zapier/actions","Complete guide for using Directus actions in Zapier workflows, including working with items, users, and files.",{"title":1016,"path":1058,"stem":1059,"description":1060,"icon":14,"links":14},"/guides/integrations/zapier/advanced","guides/12.integrations/3.zapier/advanced","Advanced guide for using Directus API features in Zapier, including raw request actions, advanced filtering, and custom API calls.",{"title":723,"path":1062,"stem":1063,"description":1064,"icon":14,"links":14},"/guides/integrations/zapier/triggers","guides/12.integrations/3.zapier/triggers","Complete guide for using Directus triggers in Zapier workflows to automatically start Zaps when events happen in Directus.",{"title":1066,"path":1067,"stem":1068,"children":1069,"description":14,"icon":14,"links":14},"Vercel","/guides/integrations/vercel","guides/12.integrations/4.vercel/0.index",[1070,1072],{"title":1066,"path":1067,"stem":1068,"description":1071,"icon":14,"links":14},"Connect Directus with Vercel to trigger deployments, monitor build status, and manage your frontend projects directly from your Directus instance.",{"title":887,"path":1073,"stem":1074,"description":1075,"icon":14,"links":14},"/guides/integrations/vercel/deployments","guides/12.integrations/4.vercel/deployments","Complete guide for triggering deployments, monitoring build status, and viewing logs for your Vercel projects from Directus.",{"title":1077,"path":1078,"stem":1079,"children":1080,"description":14,"icon":14,"links":14},"Netlify","/guides/integrations/netlify","guides/12.integrations/5.netlify/0.index",[1081,1083],{"title":1077,"path":1078,"stem":1079,"description":1082,"icon":14,"links":14},"Integrate Directus with Netlify to deploy your sites, track build progress, and manage frontend projects from within your Directus instance.",{"title":887,"path":1084,"stem":1085,"description":1086,"icon":14,"links":14},"/guides/integrations/netlify/deployments","guides/12.integrations/5.netlify/deployments","Full guide for triggering builds, tracking deployment progress, and viewing logs for your Netlify sites from Directus.",{"title":230,"path":1088,"stem":1089,"children":1090,"description":1092,"icon":14,"links":14},"/releases","releases/1.index",[1091,1093,1098],{"title":230,"path":1088,"stem":1089,"description":1092,"icon":14,"links":14},"Releases are how we roll out new features, updates, and fixes to Directus.",{"title":1094,"path":1095,"stem":1096,"description":1097,"icon":14,"links":14},"Changelog","/releases/changelog","releases/2.changelog","A monthly summary of what's new from the Directus team.",{"title":1099,"path":1100,"stem":1101,"children":1102,"description":1104,"icon":14,"links":14},"Breaking Changes","/releases/breaking-changes","releases/3.breaking-changes/0.index",[1103,1105,1109],{"title":1099,"path":1100,"stem":1101,"description":1104,"icon":14,"links":14},"Breaking changes may require action on your part before upgrading.",{"title":1106,"path":1107,"stem":1108,"description":1104,"icon":14,"links":14},"Version 10","/releases/breaking-changes/version-10","releases/3.breaking-changes/1.version-10",{"title":1110,"path":1111,"stem":1112,"description":1104,"icon":14,"links":14},"Version 11","/releases/breaking-changes/version-11","releases/3.breaking-changes/2.version-11",{"title":1114,"description":14,"icon":14,"links":14,"path":1115,"stem":1116,"children":1117,"page":89},"Self-Hosting","/self-hosting","self-hosting",[1118,1122,1127,1132,1137],{"title":230,"path":1119,"stem":1120,"description":1121,"icon":14,"links":14},"/self-hosting/overview","self-hosting/1.overview","Self-hosting Directus means running the Directus software on your own infrastructure.",{"title":1123,"path":1124,"stem":1125,"description":1126,"icon":14,"links":14},"Requirements","/self-hosting/requirements","self-hosting/2.requirements","This page outlines the requirements for self-hosting Directus.",{"title":1128,"path":1129,"stem":1130,"description":1131,"icon":14,"links":14},"Deployment","/self-hosting/deploying","self-hosting/3.deploying","This section covers the deployment process of Directus, including environment variables, versioning, persistence, and initial admin user setup.",{"title":1133,"path":1134,"stem":1135,"description":1136,"icon":14,"links":14},"Upgrading","/self-hosting/upgrading","self-hosting/4.upgrading","Learn how to upgrade Directus to the latest version.",{"title":1138,"path":1139,"stem":1140,"description":1141,"icon":14,"links":14},"Including Extensions","/self-hosting/including-extensions","self-hosting/5.including-extensions","Learn how to include extensions in your self-hosted Directus project.",{"title":1143,"path":1144,"stem":1145,"children":1146},"Tutorials","/tutorials","tutorials",[1147,1150,1370,1530,1576,1602,1719,1756],{"title":1143,"path":1144,"stem":1148,"description":1149,"icon":14,"links":14},"tutorials/index","This is a collection of step-by-step guides and practical examples to help you get the most out of our platform. Whether you're a beginner or an experienced user, our tutorials are designed to provide you with the knowledge and skills you need to succeed.",{"title":125,"path":1151,"stem":1152,"children":1153,"description":24,"icon":14,"links":14},"/tutorials/getting-started","tutorials/1.getting-started/index",[1154,1155,1160,1165,1170,1175,1180,1185,1190,1195,1200,1205,1210,1215,1220,1225,1230,1235,1240,1245,1250,1255,1260,1265,1270,1275,1280,1285,1290,1295,1300,1305,1310,1315,1320,1325,1330,1335,1340,1345,1350,1355,1360,1365],{"title":125,"path":1151,"stem":1152,"description":24,"icon":14,"links":14},{"title":1156,"path":1157,"stem":1158,"description":1159,"icon":14,"links":14},"Create Reusable Blocks with Many-to-Any Relationships","/tutorials/getting-started/create-reusable-blocks-with-many-to-any-relationships","tutorials/1.getting-started/create-reusable-blocks-with-many-to-any-relationships","Learn how to data model for multiple, repeating sections of content.",{"title":1161,"path":1162,"stem":1163,"description":1164,"icon":14,"links":14},"Fetch Data from Directus in Android with Kotlin","/tutorials/getting-started/fetch-data-from-directus-in-android-with-kotlin","tutorials/1.getting-started/fetch-data-from-directus-in-android-with-kotlin","Learn how to integrate Directus in your Android app with Kotlin.",{"title":1166,"path":1167,"stem":1168,"description":1169,"icon":14,"links":14},"Fetch Data from Directus in iOS with Swift","/tutorials/getting-started/fetch-data-from-directus-in-ios-with-swift","tutorials/1.getting-started/fetch-data-from-directus-in-ios-with-swift","Learn how to integrate Directus in your iOS app with Swift.",{"title":1171,"path":1172,"stem":1173,"description":1174,"icon":14,"links":14},"Fetch Data from Directus with Angular","/tutorials/getting-started/fetch-data-from-directus-with-angular","tutorials/1.getting-started/fetch-data-from-directus-with-angular","Learn how to integrate Directus in your Angular web application.",{"title":1176,"path":1177,"stem":1178,"description":1179,"icon":14,"links":14},"Fetch Data from Directus with Astro","/tutorials/getting-started/fetch-data-from-directus-with-astro","tutorials/1.getting-started/fetch-data-from-directus-with-astro","Learn how to integrate Directus in your Astro web application.",{"title":1181,"path":1182,"stem":1183,"description":1184,"icon":14,"links":14},"Fetch Data from Directus with Django","/tutorials/getting-started/fetch-data-from-directus-with-django","tutorials/1.getting-started/fetch-data-from-directus-with-django","Learn how to integrate Directus in your Django web application.",{"title":1186,"path":1187,"stem":1188,"description":1189,"icon":14,"links":14},"Fetch Data from Directus with Eleventy 3","/tutorials/getting-started/fetch-data-from-directus-with-eleventy-3","tutorials/1.getting-started/fetch-data-from-directus-with-eleventy-3","Learn how to integrate Directus in your 11ty web application.",{"title":1191,"path":1192,"stem":1193,"description":1194,"icon":14,"links":14},"Fetch Data from Directus with Flask","/tutorials/getting-started/fetch-data-from-directus-with-flask","tutorials/1.getting-started/fetch-data-from-directus-with-flask","Learn how to integrate Directus in your Flask web application.",{"title":1196,"path":1197,"stem":1198,"description":1199,"icon":14,"links":14},"Fetch Data from Directus with Flutter","/tutorials/getting-started/fetch-data-from-directus-with-flutter","tutorials/1.getting-started/fetch-data-from-directus-with-flutter","Learn how to integrate Directus in your Flutter app with Dart.",{"title":1201,"path":1202,"stem":1203,"description":1204,"icon":14,"links":14},"Fetch Data from Directus with Laravel","/tutorials/getting-started/fetch-data-from-directus-with-laravel","tutorials/1.getting-started/fetch-data-from-directus-with-laravel","Learn how to integrate Directus in your Laravel web application.",{"title":1206,"path":1207,"stem":1208,"description":1209,"icon":14,"links":14},"Fetch Data from Directus with Next.js","/tutorials/getting-started/fetch-data-from-directus-with-nextjs","tutorials/1.getting-started/fetch-data-from-directus-with-nextjs","Learn how to integrate Directus in your Next.js web application.",{"title":1211,"path":1212,"stem":1213,"description":1214,"icon":14,"links":14},"Fetch Data from Directus with Nuxt","/tutorials/getting-started/fetch-data-from-directus-with-nuxt","tutorials/1.getting-started/fetch-data-from-directus-with-nuxt","Learn how to integrate Directus in your Nuxt web application.",{"title":1216,"path":1217,"stem":1218,"description":1219,"icon":14,"links":14},"Fetch Data from Directus with SolidStart","/tutorials/getting-started/fetch-data-from-directus-with-solidstart","tutorials/1.getting-started/fetch-data-from-directus-with-solidstart","Learn how to integrate Directus in your SolidStart web application.",{"title":1221,"path":1222,"stem":1223,"description":1224,"icon":14,"links":14},"Fetch Data from Directus with Spring Boot","/tutorials/getting-started/fetch-data-from-directus-with-spring-boot","tutorials/1.getting-started/fetch-data-from-directus-with-spring-boot","Learn how to integrate Directus in your Spring Boot web application.",{"title":1226,"path":1227,"stem":1228,"description":1229,"icon":14,"links":14},"Fetch Data from Directus with SvelteKit","/tutorials/getting-started/fetch-data-from-directus-with-sveltekit","tutorials/1.getting-started/fetch-data-from-directus-with-sveltekit","Learn how to integrate Directus in your SvelteKit web application.",{"title":1231,"path":1232,"stem":1233,"description":1234,"icon":14,"links":14},"Implement Directus Auth with iOS","/tutorials/getting-started/implement-directus-auth-with-ios","tutorials/1.getting-started/implement-directus-auth-with-ios","Learn how to register, login, and protect content in your iOS app.",{"title":1236,"path":1237,"stem":1238,"description":1239,"icon":14,"links":14},"Implement Multilingual Content with Directus and SvelteKit","/tutorials/getting-started/implement-multilingual-content-with-directus-and-svelte-kit","tutorials/1.getting-started/implement-multilingual-content-with-directus-and-svelte-kit","Learn how to handle internationalization in your SvelteKit application.",{"title":1241,"path":1242,"stem":1243,"description":1244,"icon":14,"links":14},"Implementing Live Preview in Astro","/tutorials/getting-started/implementing-live-preview-in-astro","tutorials/1.getting-started/implementing-live-preview-in-astro","Learn how to setup Directus live preview with Astro.",{"title":1246,"path":1247,"stem":1248,"description":1249,"icon":14,"links":14},"Implementing Live Preview in Next.js","/tutorials/getting-started/implementing-live-preview-in-next-js","tutorials/1.getting-started/implementing-live-preview-in-next-js","Learn how to setup Directus live preview with Next.js.",{"title":1251,"path":1252,"stem":1253,"description":1254,"icon":14,"links":14},"Implementing Live Preview in Nuxt","/tutorials/getting-started/implementing-live-preview-in-nuxt","tutorials/1.getting-started/implementing-live-preview-in-nuxt","Learn how to setup Directus live preview with Nuxt.",{"title":1256,"path":1257,"stem":1258,"description":1259,"icon":14,"links":14},"Implementing Live Preview in React","/tutorials/getting-started/implementing-live-preview-in-react","tutorials/1.getting-started/implementing-live-preview-in-react","Learn how to setup Directus live preview with React.",{"title":1261,"path":1262,"stem":1263,"description":1264,"icon":14,"links":14},"Implementing Live Preview in SvelteKit","/tutorials/getting-started/implementing-live-preview-in-sveltekit","tutorials/1.getting-started/implementing-live-preview-in-sveltekit","Learn how to setup Directus live preview with SvelteKit.",{"title":1266,"path":1267,"stem":1268,"description":1269,"icon":14,"links":14},"Implementing Multilingual Content using Directus and Astro","/tutorials/getting-started/implementing-multilingual-content-using-directus-and-astro","tutorials/1.getting-started/implementing-multilingual-content-using-directus-and-astro","Learn how to access multilingual Directus content using Astro.",{"title":1271,"path":1272,"stem":1273,"description":1274,"icon":14,"links":14},"Implementing Multilingual Content using Directus and Next.js","/tutorials/getting-started/implementing-multilingual-content-using-directus-and-next","tutorials/1.getting-started/implementing-multilingual-content-using-directus-and-next","Learn how to access multilingual Directus content using Next.js.",{"title":1276,"path":1277,"stem":1278,"description":1279,"icon":14,"links":14},"Implementing Multilingual Content using Directus and Nuxt","/tutorials/getting-started/implementing-multilingual-content-using-directus-and-nuxt","tutorials/1.getting-started/implementing-multilingual-content-using-directus-and-nuxt","Learn how to access multilingual Directus content using Nuxt.",{"title":1281,"path":1282,"stem":1283,"description":1284,"icon":14,"links":14},"Implementing Multilingual Content using Directus and SvelteKit","/tutorials/getting-started/implementing-multilingual-content-using-directus-and-sveltekit","tutorials/1.getting-started/implementing-multilingual-content-using-directus-and-sveltekit","Learn how to access multilingual Directus content using SvelteKit.",{"title":1286,"path":1287,"stem":1288,"description":1289,"icon":14,"links":14},"Integrating the Directus Visual Editor with Next.js","/tutorials/getting-started/integrating-the-directus-visual-editor-with-nextjs","tutorials/1.getting-started/integrating-the-directus-visual-editor-with-nextjs","Learn how to integrate the Directus Visual Editor with Next.js.",{"title":1291,"path":1292,"stem":1293,"description":1294,"icon":14,"links":14},"Integrating the Directus Visual Editor with Nuxt","/tutorials/getting-started/integrating-the-directus-visual-editor-with-nuxt","tutorials/1.getting-started/integrating-the-directus-visual-editor-with-nuxt","Learn how to integrate the Directus Visual Editor with Nuxt.",{"title":1296,"path":1297,"stem":1298,"description":1299,"icon":14,"links":14},"Integrating the Directus Visual Editor with SvelteKit","/tutorials/getting-started/integrating-the-directus-visual-editor-with-sveltekit","tutorials/1.getting-started/integrating-the-directus-visual-editor-with-sveltekit","Learn how to integrate the Directus Visual Editor with SvelteKit.",{"title":1301,"path":1302,"stem":1303,"description":1304,"icon":14,"links":14},"Rendering Dynamic Blocks Using Astro","/tutorials/getting-started/rendering-dynamic-blocks-using-astro","tutorials/1.getting-started/rendering-dynamic-blocks-using-astro","Learn how to render dynamic blocks using Astro.",{"title":1306,"path":1307,"stem":1308,"description":1309,"icon":14,"links":14},"Rendering Dynamic Blocks Using Next.js","/tutorials/getting-started/rendering-dynamic-blocks-using-next","tutorials/1.getting-started/rendering-dynamic-blocks-using-next","Learn how to render dynamic blocks using Next.js.",{"title":1311,"path":1312,"stem":1313,"description":1314,"icon":14,"links":14},"Rendering Dynamic Blocks Using Nuxt","/tutorials/getting-started/rendering-dynamic-blocks-using-nuxt","tutorials/1.getting-started/rendering-dynamic-blocks-using-nuxt","Learn how to render dynamic blocks using Nuxt.",{"title":1316,"path":1317,"stem":1318,"description":1319,"icon":14,"links":14},"Rendering Dynamic Blocks Using SvelteKit","/tutorials/getting-started/rendering-dynamic-blocks-using-sveltekit","tutorials/1.getting-started/rendering-dynamic-blocks-using-sveltekit","Learn how to render dynamic blocks using SvelteKit.",{"title":1321,"path":1322,"stem":1323,"description":1324,"icon":14,"links":14},"Set Up Live Preview with Next.js","/tutorials/getting-started/set-up-live-preview-with-next-js","tutorials/1.getting-started/set-up-live-preview-with-next-js","Learn how to confgure Live Preview with Next.js' draft mode.",{"title":1326,"path":1327,"stem":1328,"description":1329,"icon":14,"links":14},"Set Up Live Preview with Nuxt","/tutorials/getting-started/set-up-live-preview-with-nuxt","tutorials/1.getting-started/set-up-live-preview-with-nuxt","Learn how to create a Nuxt preview plugin to configure Live Preview.",{"title":1331,"path":1332,"stem":1333,"description":1334,"icon":14,"links":14},"Submit Forms Using Directus and Next.js","/tutorials/getting-started/submit-forms-using-directus-and-nextjs","tutorials/1.getting-started/submit-forms-using-directus-and-nextjs","Learn how to submit forms using Directus and Next.js.",{"title":1336,"path":1337,"stem":1338,"description":1339,"icon":14,"links":14},"Submit Forms Using Directus and Nuxt","/tutorials/getting-started/submit-forms-using-directus-and-nuxt","tutorials/1.getting-started/submit-forms-using-directus-and-nuxt","Learn how to submit forms using Directus and Nuxt.",{"title":1341,"path":1342,"stem":1343,"description":1344,"icon":14,"links":14},"Submit Forms Using Directus and SvelteKit","/tutorials/getting-started/submit-forms-using-directus-and-sveltekit","tutorials/1.getting-started/submit-forms-using-directus-and-sveltekit","Learn how to submit forms using Directus and SvelteKit.",{"title":1346,"path":1347,"stem":1348,"description":1349,"icon":14,"links":14},"Using Authentication in Astro","/tutorials/getting-started/using-authentication-in-astro","tutorials/1.getting-started/using-authentication-in-astro","Learn how to setup Directus authentication with Astro.",{"title":1351,"path":1352,"stem":1353,"description":1354,"icon":14,"links":14},"Using Authentication in Next.js","/tutorials/getting-started/using-authentication-in-next-js","tutorials/1.getting-started/using-authentication-in-next-js","Learn how to setup Directus authentication with Next.js.",{"title":1356,"path":1357,"stem":1358,"description":1359,"icon":14,"links":14},"Using Authentication in Nuxt","/tutorials/getting-started/using-authentication-in-nuxt","tutorials/1.getting-started/using-authentication-in-nuxt","Learn how to setup Directus authentication with Nuxt.",{"title":1361,"path":1362,"stem":1363,"description":1364,"icon":14,"links":14},"Using Authentication in React","/tutorials/getting-started/using-authentication-in-react","tutorials/1.getting-started/using-authentication-in-react","Learn how to setup Directus authentication with React.",{"title":1366,"path":1367,"stem":1368,"description":1369,"icon":14,"links":14},"Using Authentication in SvelteKit","/tutorials/getting-started/using-authentication-in-sveltekit","tutorials/1.getting-started/using-authentication-in-sveltekit","Learn how to setup Directus authentication with SvelteKit.",{"title":145,"path":1371,"stem":1372,"children":1373,"description":24,"icon":14,"links":14},"/tutorials/projects","tutorials/2.projects/index",[1374,1375,1380,1385,1390,1395,1400,1405,1410,1415,1420,1425,1430,1435,1440,1445,1450,1455,1460,1465,1470,1475,1480,1485,1490,1495,1500,1505,1510,1515,1520,1525],{"title":145,"path":1371,"stem":1372,"description":24,"icon":14,"links":14},{"title":1376,"path":1377,"stem":1378,"description":1379,"icon":14,"links":14},"Build a Multi-User Chat with JavaScript and Directus Realtime","/tutorials/projects/build-a-multi-user-chat-with-javascript-and-directus-realtime","tutorials/2.projects/build-a-multi-user-chat-with-javascript-and-directus-realtime","Learn how to send and receive data over a realtime connection with JavaScript.",{"title":1381,"path":1382,"stem":1383,"description":1384,"icon":14,"links":14},"Build a Multi-User Chat with React and Directus Realtime","/tutorials/projects/build-a-multi-user-chat-with-react-and-directus-realtime","tutorials/2.projects/build-a-multi-user-chat-with-react-and-directus-realtime","Learn how to send and receive data over a realtime connection in React applications.",{"title":1386,"path":1387,"stem":1388,"description":1389,"icon":14,"links":14},"Build a Multi-User Chat with Vue.js and Directus Realtime","/tutorials/projects/build-a-multi-user-chat-with-vue-js-and-directus-realtime","tutorials/2.projects/build-a-multi-user-chat-with-vue-js-and-directus-realtime","Learn how to send and receive data over a realtime connection in a Vue.js application.",{"title":1391,"path":1392,"stem":1393,"description":1394,"icon":14,"links":14},"Build a Notebook Chrome Extension with Directus Auth","/tutorials/projects/build-a-notebook-chrome-extension-with-directus-auth","tutorials/2.projects/build-a-notebook-chrome-extension-with-directus-auth","Learn to build and integrate a Chrome Extension with Directus Auth.",{"title":1396,"path":1397,"stem":1398,"description":1399,"icon":14,"links":14},"Build a Realtime Chat App with Directus and Astro","/tutorials/projects/build-a-realtime-chat-app-using-directus-and-astro","tutorials/2.projects/build-a-realtime-chat-app-using-directus-and-astro","Learn how to setup Directus realtime with Astro.",{"title":1401,"path":1402,"stem":1403,"description":1404,"icon":14,"links":14},"Build a Realtime Chat App with Directus and Nuxt","/tutorials/projects/build-a-realtime-chat-app-using-directus-and-nuxt","tutorials/2.projects/build-a-realtime-chat-app-using-directus-and-nuxt","Learn how to setup Directus realtime with Nuxt.",{"title":1406,"path":1407,"stem":1408,"description":1409,"icon":14,"links":14},"Build a Realtime Chat App with Directus and Next.js","/tutorials/projects/build-a-realtime-chat-app-with-directus-and-next","tutorials/2.projects/build-a-realtime-chat-app-with-directus-and-next","Learn how to setup Directus realtime with Next.js.",{"title":1411,"path":1412,"stem":1413,"description":1414,"icon":14,"links":14},"Build a Realtime Chat App with Directus and SvelteKit","/tutorials/projects/build-a-realtime-chat-app-with-directus-and-sveltekit","tutorials/2.projects/build-a-realtime-chat-app-with-directus-and-sveltekit","Learn how to setup Directus realtime with SvelteKit.",{"title":1416,"path":1417,"stem":1418,"description":1419,"icon":14,"links":14},"Build a Testimonial Widget with SvelteKit and Directus","/tutorials/projects/build-a-testimonial-widget-with-sveltekit-and-directus","tutorials/2.projects/build-a-testimonial-widget-with-sveltekit-and-directus","Learn how to set up a testimonial widget using SvelteKit and Directus.",{"title":1421,"path":1422,"stem":1423,"description":1424,"icon":14,"links":14},"Build a User Feedback Widget with Vue.js","/tutorials/projects/build-a-user-feedback-widget-with-vue-js","tutorials/2.projects/build-a-user-feedback-widget-with-vue-js-","Learn how we built our docs feedback widget with Directus.",{"title":1426,"path":1427,"stem":1428,"description":1429,"icon":14,"links":14},"Build a Video Streaming App with SvelteKit and Directus","/tutorials/projects/build-a-video-streaming-app-with-sveltekit-and-directus","tutorials/2.projects/build-a-video-streaming-app-with-sveltekit-and-directus","Learn how to store and retrieve video metadata, and then build a streaming application.",{"title":1431,"path":1432,"stem":1433,"description":1434,"icon":14,"links":14},"Build an Ecommerce Platform with Next.js, Stripe, and Directus Automate","/tutorials/projects/build-an-ecommerce-platform-with-next-js-stripe-and-directus-automate","tutorials/2.projects/build-an-ecommerce-platform-with-next-js-stripe-and-directus-automate","Learn to integrate Stripe with Directus Automate to build an e-commerce website.",{"title":1436,"path":1437,"stem":1438,"description":1439,"icon":14,"links":14},"Build an Hotel Booking Platform with Next.js, Stripe, and Directus Automate","/tutorials/projects/build-an-hotel-booking-platform-with-next-js-stripe-and-directus-automate","tutorials/2.projects/build-an-hotel-booking-platform-with-next-js-stripe-and-directus-automate","Learn to build a hotel booking site with dynamic availability and payments via Stripe.",{"title":1441,"path":1442,"stem":1443,"description":1444,"icon":14,"links":14},"Build Directus Garden - A Passive Collaborative Event Booth Demo","/tutorials/projects/build-directus-garden-a-passive-collaborative-event-booth-demo","tutorials/2.projects/build-directus-garden-a-passive-collaborative-event-booth-demo","Learn how we built our engagement platform for live in-person events with P5.js.",{"title":1446,"path":1447,"stem":1448,"description":1449,"icon":14,"links":14},"Build Forms Dynamically using Directus and Astro","/tutorials/projects/build-forms-dynamically-using-directus-and-astro","tutorials/2.projects/build-forms-dynamically-using-directus-and-astro","Learn how to setup Directus fields with Astro.",{"title":1451,"path":1452,"stem":1453,"description":1454,"icon":14,"links":14},"Build Forms Dynamically using Directus and Next.js","/tutorials/projects/build-forms-dynamically-using-directus-and-next","tutorials/2.projects/build-forms-dynamically-using-directus-and-next","Learn how to setup Directus fields with Next.js.",{"title":1456,"path":1457,"stem":1458,"description":1459,"icon":14,"links":14},"Build Forms Dynamically using Directus and Nuxt","/tutorials/projects/build-forms-dynamically-using-directus-and-nuxt","tutorials/2.projects/build-forms-dynamically-using-directus-and-nuxt","Learn how to setup Directus fields with Nuxt.",{"title":1461,"path":1462,"stem":1463,"description":1464,"icon":14,"links":14},"Build Forms Dynamically using Directus and SvelteKit","/tutorials/projects/build-forms-dynamically-using-directus-and-sveltekit","tutorials/2.projects/build-forms-dynamically-using-directus-and-sveltekit","Learn how to setup Directus fields with SvelteKit.",{"title":1466,"path":1467,"stem":1468,"description":1469,"icon":14,"links":14},"Build the Leap Week Registration and Referral System","/tutorials/projects/build-the-leap-week-registration-and-referral-system","tutorials/2.projects/build-the-leap-week-registration-and-referral-system-","Learn how we built our referral-based ticketing and raffle system with AI-generated rabbitars.",{"title":1471,"path":1472,"stem":1473,"description":1474,"icon":14,"links":14},"Building AIVenture - An AI-Powered Game with Directus","/tutorials/projects/building-ai-venture-an-ai-powered-game-with-directus","tutorials/2.projects/building-ai-venture-an-ai-powered-game-with-directus","Learn the advanced techniques used with Directus Automate to build a game.",{"title":1476,"path":1477,"stem":1478,"description":1479,"icon":14,"links":14},"Create a CMS using Directus and Astro","/tutorials/projects/create-a-cms-using-directus-and-astro","tutorials/2.projects/create-a-cms-using-directus-and-astro","Learn how to create a CMS using Directus and Astro.",{"title":1481,"path":1482,"stem":1483,"description":1484,"icon":14,"links":14},"Create a CMS using Directus and Next.js","/tutorials/projects/create-a-cms-using-directus-and-nextjs","tutorials/2.projects/create-a-cms-using-directus-and-nextjs","Learn how to create a CMS using Directus and Next.js.",{"title":1486,"path":1487,"stem":1488,"description":1489,"icon":14,"links":14},"Create a CMS using Directus and Nuxt","/tutorials/projects/create-a-cms-using-directus-and-nuxt","tutorials/2.projects/create-a-cms-using-directus-and-nuxt","Learn how to create a CMS using Directus and Nuxt.",{"title":1491,"path":1492,"stem":1493,"description":1494,"icon":14,"links":14},"Create a CMS using Directus and SvelteKit","/tutorials/projects/create-a-cms-using-directus-and-sveltekit","tutorials/2.projects/create-a-cms-using-directus-and-sveltekit","Learn how to create a CMS using Directus and SvelteKit.",{"title":1496,"path":1497,"stem":1498,"description":1499,"icon":14,"links":14},"Create Dynamic Pages for a CMS using Directus and Astro","/tutorials/projects/create-dynamic-pages-for-a-cms-using-directus-and-astro","tutorials/2.projects/create-dynamic-pages-for-a-cms-using-directus-and-astro","Learn how to create dynamic pages you can use in your CMS using Directus and Astro.",{"title":1501,"path":1502,"stem":1503,"description":1504,"icon":14,"links":14},"Create Dynamic Pages for a CMS using Directus and Next.js","/tutorials/projects/create-dynamic-pages-for-a-cms-using-directus-and-nextjs","tutorials/2.projects/create-dynamic-pages-for-a-cms-using-directus-and-nextjs","Learn how to create dynamic pages you can use in your CMS using Directus and Next.js.",{"title":1506,"path":1507,"stem":1508,"description":1509,"icon":14,"links":14},"Create Dynamic Pages for a CMS using Directus and Nuxt","/tutorials/projects/create-dynamic-pages-for-a-cms-using-directus-and-nuxt","tutorials/2.projects/create-dynamic-pages-for-a-cms-using-directus-and-nuxt","Learn how to create dynamic pages you can use in your CMS using Directus and Nuxt.",{"title":1511,"path":1512,"stem":1513,"description":1514,"icon":14,"links":14},"Create Dynamic Pages for a CMS using Directus and SvelteKit","/tutorials/projects/create-dynamic-pages-for-a-cms-using-directus-and-sveltekit","tutorials/2.projects/create-dynamic-pages-for-a-cms-using-directus-and-sveltekit","Learn how to create dynamic pages you can use in your CMS using Directus and SvelteKit.",{"title":1516,"path":1517,"stem":1518,"description":1519,"icon":14,"links":14},"How I Built an AI Open Source Santa Roast App with Directus and Nuxt","/tutorials/projects/how-i-built-an-ai-open-source-santa-roast-app-with-directus-and-nuxt","tutorials/2.projects/how-i-built-an-ai-open-source-santa-roast-app-with-directus-and-nuxt","Bryant breaks down how he built an AI-powered app that roasts developers based on their GitHub contributions.",{"title":1521,"path":1522,"stem":1523,"description":1524,"icon":14,"links":14},"Integrate Directus with ESP32 Hardware Sensors","/tutorials/projects/integrate-directus-with-esp-32-hardware-sensors","tutorials/2.projects/integrate-directus-with-esp-32-hardware-sensors","Learn how to integrate Directus with IoT systems by reading and publishing sensor data.",{"title":1526,"path":1527,"stem":1528,"description":1529,"icon":14,"links":14},"Use Directus as a Baby Health Tracker with Owlet and OpsGenie","/tutorials/projects/use-directus-as-a-baby-health-tracker-with-owlet-and-ops-genie","tutorials/2.projects/use-directus-as-a-baby-health-tracker-with-owlet-and-ops-genie","Learn how to integrate Directus with hardware sensors and incident repsonse systems.",{"title":1531,"path":1532,"stem":1533,"children":1534,"description":24,"icon":14,"links":14},"Tips & Tricks","/tutorials/tips-and-tricks","tutorials/3.tips-and-tricks/index",[1535,1536,1541,1546,1551,1556,1561,1566,1571],{"title":1531,"path":1532,"stem":1533,"description":24,"icon":14,"links":14},{"title":1537,"path":1538,"stem":1539,"description":1540,"icon":14,"links":14},"Advanced Types with the Directus SDK","/tutorials/tips-and-tricks/advanced-types-with-the-directus-sdk","tutorials/3.tips-and-tricks/advanced-types-with-the-directus-sdk","Learn how to more-easily work with types and the Directus SDK.",{"title":1542,"path":1543,"stem":1544,"description":1545,"icon":14,"links":14},"Build a Monitoring Pipeline For Flows And Extensions","/tutorials/tips-and-tricks/build-a-monitoring-pipeline-for-flows-and-extensions","tutorials/3.tips-and-tricks/build-a-monitoring-pipeline-for-flows-and-extensions-","Learn how to set up complex pipelines to monitor automations and extensions.",{"title":1547,"path":1548,"stem":1549,"description":1550,"icon":14,"links":14},"Configure Okta as a Single Sign-On Provider","/tutorials/tips-and-tricks/configure-okta-as-a-single-sign-on-provider","tutorials/3.tips-and-tricks/configure-okta-as-a-single-sign-on-provider","Learn how to set up Okta SSO with the SAML authentication mechanism.",{"title":1552,"path":1553,"stem":1554,"description":1555,"icon":14,"links":14},"Implement Pagination and Infinite Scrolling in Next.js","/tutorials/tips-and-tricks/implement-pagination-and-infinite-scrolling-in-next-js","tutorials/3.tips-and-tricks/implement-pagination-and-infinite-scrolling-in-next-js-","Learn various techniques to load paginated data in your Next.js application.",{"title":1557,"path":1558,"stem":1559,"description":1560,"icon":14,"links":14},"Importing Files in Directus Automate","/tutorials/tips-and-tricks/importing-files-in-directus-automate","tutorials/3.tips-and-tricks/importing-files-in-directus-automate","Learn how to use the Request URL operation to import files in Directus Automate.",{"title":1562,"path":1563,"stem":1564,"description":1565,"icon":14,"links":14},"Preview Files in Live Preview with Google Docs Previews","/tutorials/tips-and-tricks/preview-files-in-live-preview-with-google-docs-previews","tutorials/3.tips-and-tricks/preview-files-in-live-preview-with-google-docs-previews","Learn how to use Google Gview to preview many file formats in Directus Editor.",{"title":1567,"path":1568,"stem":1569,"description":1570,"icon":14,"links":14},"Search Engine Optimization Best Practices","/tutorials/tips-and-tricks/search-engine-optimization-best-practices","tutorials/3.tips-and-tricks/search-engine-optimization-best-practices","Learn some best practices for enabling SEO in your projects using Directus.",{"title":1572,"path":1573,"stem":1574,"description":1575,"icon":14,"links":14},"Understanding Kubernetes","/tutorials/tips-and-tricks/understanding-kubernetes","tutorials/3.tips-and-tricks/understanding-kubernetes","Learn about key Kubernetes concepts and how they interact with each other.",{"title":1577,"path":1578,"stem":1579,"children":1580,"description":24,"icon":14,"links":14},"Migration","/tutorials/migration","tutorials/4.migration/index",[1581,1582,1587,1592,1597],{"title":1577,"path":1578,"stem":1579,"description":24,"icon":14,"links":14},{"title":1583,"path":1584,"stem":1585,"description":1586,"icon":14,"links":14},"Migrate from Notion to Directus","/tutorials/migration/migrate-from-notion-to-directus","tutorials/4.migration/migrate-from-notion-to-directus","Learn how to migrate data from Notion databases to Directus.",{"title":1588,"path":1589,"stem":1590,"description":1591,"icon":14,"links":14},"Migrate from Nuxt Content to Directus","/tutorials/migration/migrate-from-nuxt-content-to-directus","tutorials/4.migration/migrate-from-nuxt-content-to-directus","Learn how to move from a flat-file CMS to Directus.",{"title":1593,"path":1594,"stem":1595,"description":1596,"icon":14,"links":14},"Migrate from WordPress to Directus","/tutorials/migration/migrate-from-wordpress-to-directus","tutorials/4.migration/migrate-from-wordpress-to-directus","Learn how to migrate posts and images to Directus, with tips on plugins.",{"title":1598,"path":1599,"stem":1600,"description":1601,"icon":14,"links":14},"Promoting Changes Between Environments in Directus","/tutorials/migration/promoting-changes-between-environments-in-directus","tutorials/4.migration/promoting-changes-between-environments-in-directus","Learn the options to migrate schema and data between Directus projects.",{"title":372,"path":1603,"stem":1604,"children":1605,"description":1607,"icon":14,"links":14},"/tutorials/extensions","tutorials/5.extensions/index",[1606,1608,1613,1618,1623,1628,1633,1638,1643,1650,1657,1664,1669,1674,1679,1684,1689,1694,1699,1704,1709,1714],{"title":372,"path":1603,"stem":1604,"description":1607,"icon":14,"links":14},"All about extensions",{"title":1609,"path":1610,"stem":1611,"description":1612,"icon":14,"links":14},"Check Permissions in a Custom Endpoint","/tutorials/extensions/check-permissions-in-a-custom-endpoint","tutorials/5.extensions/check-permissions-in-a-custom-endpoint","Learn how to use internal Directus permissions when creating a custom endpoint.",{"title":1614,"path":1615,"stem":1616,"description":1617,"icon":14,"links":14},"Create Collection Items in Custom Panels","/tutorials/extensions/create-collection-items-in-custom-panels","tutorials/5.extensions/create-collection-items-in-custom-panels","Learn how to use built-in interfaces and composables to create new collections.",{"title":1619,"path":1620,"stem":1621,"description":1622,"icon":14,"links":14},"Create New Customers in Stripe in a Custom Hook","/tutorials/extensions/create-new-customers-in-stripe-in-a-custom-hook","tutorials/5.extensions/create-new-customers-in-stripe-in-a-custom-hook","Learn how to use the Stripe SDK to create data when actions occur in Directus.",{"title":1624,"path":1625,"stem":1626,"description":1627,"icon":14,"links":14},"Display External API Data From Vonage In Custom Panels","/tutorials/extensions/display-external-api-data-from-vonage-in-custom-panels","tutorials/5.extensions/display-external-api-data-from-vonage-in-custom-panels","Learn how to display records from external systems in Directus Insights.",{"title":1629,"path":1630,"stem":1631,"description":1632,"icon":14,"links":14},"Display External Weather API Data In Custom Panels","/tutorials/extensions/display-external-weather-api-data-in-custom-panels","tutorials/5.extensions/display-external-weather-api-data-in-custom-panels","Learn how to display external data in panels with a bundle and endpoint.",{"title":1634,"path":1635,"stem":1636,"description":1637,"icon":14,"links":14},"Format Dates in a Custom Display Extension","/tutorials/extensions/format-dates-in-a-custom-display-extension","tutorials/5.extensions/format-dates-in-a-custom-display-extension","Learn how to build a custom display to format data in Directus.",{"title":1639,"path":1640,"stem":1641,"description":1642,"icon":14,"links":14},"Implement Navigation in Multipage Custom Modules","/tutorials/extensions/implement-navigation-in-multipage-custom-modules","tutorials/5.extensions/implement-navigation-in-multipage-custom-modules","Learn how to navigate between multiple pages in module extensions.",{"title":1644,"path":1645,"stem":1646,"children":1647,"description":1649,"icon":14,"links":14},"Integrate Algolia Indexing with Custom Hooks","/tutorials/extensions/integrate-algolia-indexing-with-custom-hooks","tutorials/5.extensions/integrate-algolia-indexing-with-custom-hooks",[1648],{"title":1644,"path":1645,"stem":1646,"description":1649,"icon":14,"links":14},"Learn how to maintain an Algolia index when data is created, updated, and deleted.",{"title":1651,"path":1652,"stem":1653,"children":1654,"description":1656,"icon":14,"links":14},"Integrate Elasticsearch Indexing with Custom Hooks","/tutorials/extensions/integrate-elasticsearch-indexing-with-custom-hooks","tutorials/5.extensions/integrate-elasticsearch-indexing-with-custom-hooks",[1655],{"title":1651,"path":1652,"stem":1653,"description":1656,"icon":14,"links":14},"Learn how to maintain an Elasticsearch index when data is created, updated, and deleted.",{"title":1658,"path":1659,"stem":1660,"children":1661,"description":1663,"icon":14,"links":14},"Integrate Meilisearch Indexing with Custom Hooks","/tutorials/extensions/integrate-meilisearch-indexing-with-custom-hooks","tutorials/5.extensions/integrate-meilisearch-indexing-with-custom-hooks",[1662],{"title":1658,"path":1659,"stem":1660,"description":1663,"icon":14,"links":14},"Learn how to maintain an Meilisearch index when data is created, updated, and deleted.",{"title":1665,"path":1666,"stem":1667,"description":1668,"icon":14,"links":14},"Monitor and Error Track with Sentry in Custom Hooks","/tutorials/extensions/monitor-and-error-track-with-sentry-in-custom-hooks","tutorials/5.extensions/monitor-and-error-track-with-sentry-in-custom-hooks","Learn how to integrate Sentry error tracking in both your API and Data Studio.",{"title":1670,"path":1671,"stem":1672,"description":1673,"icon":14,"links":14},"Proxy an External API in a Custom Endpoint Extension","/tutorials/extensions/proxy-an-external-api-in-a-custom-endpoint-extension","tutorials/5.extensions/proxy-an-external-api-in-a-custom-endpoint-extension","Learn how to make external APIs available via Directus in a custom endpoint.",{"title":1675,"path":1676,"stem":1677,"description":1678,"icon":14,"links":14},"Read Collection Data in Custom Layouts","/tutorials/extensions/read-collection-data-in-custom-layouts","tutorials/5.extensions/read-collection-data-in-custom-layouts","Learn how to build your first layout with data from a collection.",{"title":1680,"path":1681,"stem":1682,"description":1683,"icon":14,"links":14},"Send SMS Messages with Twilio in Custom Operations","/tutorials/extensions/send-sms-messages-with-twilio-in-custom-operations","tutorials/5.extensions/send-sms-messages-with-twilio-in-custom-operations","Learn how to build a custom operation that uses the Twilio SDK.",{"title":1685,"path":1686,"stem":1687,"description":1688,"icon":14,"links":14},"Send SMS Messages with Twilio in Custom Panels","/tutorials/extensions/send-sms-messages-with-twilio-in-custom-panels","tutorials/5.extensions/send-sms-messages-with-twilio-in-custom-panels","Learn how to build a form inside a panel extension and use external APIs.",{"title":1690,"path":1691,"stem":1692,"description":1693,"icon":14,"links":14},"Summarize Relational Items in a Custom Display Extension","/tutorials/extensions/summarize-relational-items-in-a-custom-display-extension","tutorials/5.extensions/summarize-relational-items-in-a-custom-display-extension","Learn how to work with relational data in display extensions.",{"title":1695,"path":1696,"stem":1697,"description":1698,"icon":14,"links":14},"Understand Available Slots in Custom Modules","/tutorials/extensions/understand-available-slots-in-custom-modules","tutorials/5.extensions/understand-available-slots-in-custom-modules","Learn about all of the slots available in your custom modules.",{"title":1700,"path":1701,"stem":1702,"description":1703,"icon":14,"links":14},"Use Dynamic Values in Custom Email Templates","/tutorials/extensions/use-dynamic-values-in-custom-email-templates","tutorials/5.extensions/use-dynamic-values-in-custom-email-templates","Learn how to inject dynamic data into liquid templates.",{"title":1705,"path":1706,"stem":1707,"description":1708,"icon":14,"links":14},"Use npm Packages in Custom Operations","/tutorials/extensions/use-npm-packages-in-custom-operations","tutorials/5.extensions/use-npm-packages-in-custom-operations","Learn how to expose an npm package as an operation in Directus Automate.",{"title":1710,"path":1711,"stem":1712,"description":1713,"icon":14,"links":14},"Validate Phone Numbers with Twilio in a Custom Hook","/tutorials/extensions/validate-phone-numbers-with-twilio-in-a-custom-hook","tutorials/5.extensions/validate-phone-numbers-with-twilio-in-a-custom-hook","Learn how to prevent an item from saving if it has an invalid phone number.",{"title":1715,"path":1716,"stem":1717,"description":1718,"icon":14,"links":14},"Validating Third-Party JWTs in Directus (with Okta)","/tutorials/extensions/validating-third-party-jwts-in-directus","tutorials/5.extensions/validating-third-party-jwts-in-directus","Learn how to translate third part JWT's to Directus accountability",{"title":1720,"path":1721,"stem":1722,"children":1723,"description":1725,"icon":14,"links":14},"How to Deploy Directus","/tutorials/self-hosting","tutorials/6.self-hosting/index",[1724,1726,1731,1736,1741,1746,1751],{"title":1720,"path":1721,"stem":1722,"description":1725,"icon":14,"links":14},"Deploy Directus with Directus Cloud, self-host with Docker, or follow step-by-step guides for your preferred cloud provider.",{"title":1727,"path":1728,"stem":1729,"description":1730,"icon":14,"links":14},"Deploy Directus to an Ubuntu Server","/tutorials/self-hosting/deploy-directus-to-an-ubuntu-server","tutorials/6.self-hosting/deploy-directus-to-an-ubuntu-server","Learn how to deploy Directus on a Docker container on an Ubuntu server.",{"title":1732,"path":1733,"stem":1734,"description":1735,"icon":14,"links":14},"Deploy Directus to AWS EC2","/tutorials/self-hosting/deploy-directus-to-aws-ec2","tutorials/6.self-hosting/deploy-directus-to-aws-ec2","Learn how to deploy a Directus to AWS EC2, with a RDS database and a S3 storage bucket.",{"title":1737,"path":1738,"stem":1739,"description":1740,"icon":14,"links":14},"Deploy Directus to Azure Web Apps","/tutorials/self-hosting/deploy-directus-to-azure-web-apps","tutorials/6.self-hosting/deploy-directus-to-azure-web-apps","Learn how to deploy Directus on a Docker container on Azure.",{"title":1742,"path":1743,"stem":1744,"description":1745,"icon":14,"links":14},"Deploy Directus to Digital Ocean","/tutorials/self-hosting/deploy-directus-to-digital-ocean","tutorials/6.self-hosting/deploy-directus-to-digital-ocean","Learn how to deploy Directus on the Digital Ocean App Platform.",{"title":1747,"path":1748,"stem":1749,"description":1750,"icon":14,"links":14},"Deploy Directus to Google Cloud Platform","/tutorials/self-hosting/deploy-directus-to-google-cloud-platform","tutorials/6.self-hosting/deploy-directus-to-google-cloud-platform","Learn how to deploy Directus on GCP with a Cloud SQL database and Cloud Storage Bucket.",{"title":1752,"path":1753,"stem":1754,"description":1755,"icon":14,"links":14},"Deploy Directus to Railway","/tutorials/self-hosting/deploy-directus-to-railway","tutorials/6.self-hosting/deploy-directus-to-railway","Deploy Directus on Railway using the official one-click templates (blank instance or CMS template) with PostgreSQL, Redis, and S3-compatible storage.",{"title":1757,"path":1758,"stem":1759,"children":1760,"description":24,"icon":14,"links":14},"Workflows","/tutorials/workflows","tutorials/7.workflows/index",[1761,1762,1767,1772,1777,1782,1787,1792,1797,1802,1807,1812,1817,1822,1827],{"title":1757,"path":1758,"stem":1759,"description":24,"icon":14,"links":14},{"title":1763,"path":1764,"stem":1765,"description":1766,"icon":14,"links":14},"Build Content Approval Workflows with Custom Permissions","/tutorials/workflows/build-content-approval-workflows-with-custom-permissions","tutorials/7.workflows/build-content-approval-workflows-with-custom-permissions","Learn how to configure roles and permissions for complex automations.",{"title":1768,"path":1769,"stem":1770,"description":1771,"icon":14,"links":14},"Combine Live Preview and Content Versioning with Next.js","/tutorials/workflows/combine-live-preview-and-content-versioning-with-next-js","tutorials/7.workflows/combine-live-preview-and-content-versioning-with-next-js","Learn how to set up Live Preview with different content versions in your Next.js application.",{"title":1773,"path":1774,"stem":1775,"description":1776,"icon":14,"links":14},"Create GitHub Issues with Directus Automate","/tutorials/workflows/create-github-issues-with-directus-automate","tutorials/7.workflows/create-github-issues-with-directus-automate","Learn how to integrate GitHub with Directus Automate to create new issues.",{"title":1778,"path":1779,"stem":1780,"description":1781,"icon":14,"links":14},"Detect High-Risk Phone Numbers with Vonage and Directus Automate","/tutorials/workflows/detect-high-risk-phone-numbers-with-vonage-and-directus-automate","tutorials/7.workflows/detect-high-risk-phone-numbers-with-vonage-and-directus-automate","Learn how to integrate Vonage's Number Insights API with Directus Automate to validate numbers.",{"title":1783,"path":1784,"stem":1785,"description":1786,"icon":14,"links":14},"Enrich User Data with Clearbit and Directus Automate","/tutorials/workflows/enrich-user-data-with-clearbit-and-directus-automate","tutorials/7.workflows/enrich-user-data-with-clearbit-and-directus-automate","Learn how to integrate Clearbit data enrichment with Directus Automate.",{"title":1788,"path":1789,"stem":1790,"description":1791,"icon":14,"links":14},"Generate Images with DALL•E and Directus Automate","/tutorials/workflows/generate-images-with-dall-e-and-directus-automate","tutorials/7.workflows/generate-images-with-dall-e-and-directus-automate","Learn how to integrate OpenAI's Dall•E models with Directus Automate.",{"title":1793,"path":1794,"stem":1795,"description":1796,"icon":14,"links":14},"Generate Social Posts with GPT-4 and Directus Automate","/tutorials/workflows/generate-social-posts-with-gpt-4-and-directus-automate","tutorials/7.workflows/generate-social-posts-with-gpt-4-and-directus-automate","Learn how to integrate OpenAI's GPT-4 model with Directus Automate.",{"title":1798,"path":1799,"stem":1800,"description":1801,"icon":14,"links":14},"Generate Transcripts with Deepgram and Directus Automate","/tutorials/workflows/generate-transcripts-with-deepgram-and-directus-automate","tutorials/7.workflows/generate-transcripts-with-deepgram-and-directus-automate","Learn how to integrate Deepgram's Speech-to-Text API with Directus Automate.",{"title":1803,"path":1804,"stem":1805,"description":1806,"icon":14,"links":14},"Integrating Multilingual Content with Directus and Crowdin","/tutorials/workflows/integrating-multilingual-content-with-directus-and-crowdin","tutorials/7.workflows/integrating-multilingual-content-with-directus-and-crowdin","Learn how to localize content in Directus using Crowdin's connector with Directus.",{"title":1808,"path":1809,"stem":1810,"description":1811,"icon":14,"links":14},"Invincible AI content workflows with Inngest and Directus","/tutorials/workflows/invincible-ai-content-workflows-with-inngest-and-directus","tutorials/7.workflows/invincible-ai-content-workflows-with-inngest-and-directus","Learn how to configure integration Directus and Inngest to build durable workflows for any scale.",{"title":1813,"path":1814,"stem":1815,"description":1816,"icon":14,"links":14},"Schedule Future Content with Directus Automate","/tutorials/workflows/schedule-future-content-with-directus-automate","tutorials/7.workflows/schedule-future-content-with-directus-automate","Learn how to set content to be scheduled on a future date with Directs Automate.",{"title":1818,"path":1819,"stem":1820,"description":1821,"icon":14,"links":14},"Tag Images with Clarifai and Directus Automate","/tutorials/workflows/tag-images-with-clarifai-and-directus-automate","tutorials/7.workflows/tag-images-with-clarifai-and-directus-automate","Learn how to integrate Clarifai's image recognition APIs with Directus Automate.",{"title":1823,"path":1824,"stem":1825,"description":1826,"icon":14,"links":14},"Trigger Netlify Site Builds with Directus Automate","/tutorials/workflows/trigger-netlify-site-builds-with-directus-automate","tutorials/7.workflows/trigger-netlify-site-builds-with-directus-automate","Learn how to trigger new Netlify website builds through Directus Automate.",{"title":1828,"path":1829,"stem":1830,"description":1831,"icon":14,"links":14},"Trigger Vercel Site Builds with Directus Automate","/tutorials/workflows/trigger-vercel-site-builds-with-directus-automate","tutorials/7.workflows/trigger-vercel-site-builds-with-directus-automate","Learn how to trigger new Vercel website builds through Directus Automate.",{"id":1833,"icon":1834,"content":1835,"link":1836},"812bf73d-ebfb-4246-9538-937a09a0c795","connected_tv","Learn more about our native MCP","https://directus.io/mcp",{"id":1838,"title":914,"authors":14,"body":1839,"description":917,"extension":3260,"headline":907,"icon":14,"links":14,"meta":3261,"navigation":2667,"path":915,"rawbody":3262,"seo":3263,"stem":916,"technologies":14,"__hash__":3264},"content/guides/11.ai/1.assistant/1.setup.md",{"type":1840,"value":1841,"toc":3242},"minimark",[1842,1846,1850,1881,1889,1897,1901,1904,2038,2042,2144,2148,2151,2161,2174,2180,2182,2192,2262,2266,2269,2351,2365,2369,2605,2609,2615,2623,2626,2942,2945,2949,2952,2968,2976,2982,2986,2994,2999,3042,3046,3061,3064,3092,3095,3134,3140,3143,3174,3180,3187,3196,3204,3208,3238],[1843,1844,1845],"p",{},"AI Assistant requires an API key from a supported AI provider. This page covers the administrator setup process.",[1847,1848,1123],"h2",{"id":1849},"requirements",[1851,1852,1853,1857,1860,1868],"ul",{},[1854,1855,1856],"li",{},"Administrator access to your Directus instance",[1854,1858,1859],{},"API key from at least one supported provider: OpenAI, Anthropic, or Google (see below)",[1854,1861,1862,1863,1867],{},"Users must have ",[1864,1865,1866],"strong",{},"App access"," - Public (non-authenticated) or API-only users cannot use AI Assistant",[1854,1869,1870,1871,1875,1876,1880],{},"AI Assistant can be ",[1872,1873,1874],"a",{"href":348},"disabled at the infrastructure level"," using the ",[1877,1878,1879],"code",{},"AI_ENABLED"," environment variable",[1843,1882,1883,1884,1888],{},"Alternatively, you can use an ",[1872,1885,1887],{"href":1886},"#openai-compatible-providers","OpenAI-compatible provider"," like Ollama or LM Studio for self-hosted models.",[1890,1891,1894],"callout",{"color":1892,"icon":1893},"info","material-symbols:info",[1843,1895,1896],{},"Note that all users of AI Assistant will share a single API key from your configured provider. Usage limits and costs will be shared across all users. See your provider's dashboard for monitoring usage details and costs.",[1847,1898,1900],{"id":1899},"get-an-api-key","Get an API Key",[1843,1902,1903],{},"You'll need an API key from at least one provider. Choose based on which models you want to use.",[1905,1906,1908,1963,1999],"accordion",{"type":1907},"single",[1909,1910,1913,1916,1954],"accordion-item",{"icon":1911,"label":1912},"i-simple-icons-openai","OpenAI",[1843,1914,1915],{},"OpenAI provides GPT-5 models (Nano, Mini, Standard).",[1917,1918,1919,1929,1942,1948,1951],"ol",{},[1854,1920,1921,1922,1928],{},"Go to ",[1872,1923,1927],{"href":1924,"rel":1925},"https://platform.openai.com/",[1926],"nofollow","platform.openai.com"," and sign in or create an account",[1854,1930,1931,1932,1935,1936,1941],{},"Navigate to ",[1864,1933,1934],{},"API Keys"," in the left sidebar (or go directly to ",[1872,1937,1940],{"href":1938,"rel":1939},"https://platform.openai.com/api-keys",[1926],"platform.openai.com/api-keys",")",[1854,1943,1944,1945],{},"Click ",[1864,1946,1947],{},"Create new secret key",[1854,1949,1950],{},"Give it a name like \"Directus AI Assistant\"",[1854,1952,1953],{},"Copy the key immediately - you won't be able to see it again",[1890,1955,1956],{"color":1892,"icon":1893},[1843,1957,1958,1959,1962],{},"OpenAI requires a payment method and has usage-based pricing. Set spending limits in ",[1864,1960,1961],{},"Settings → Limits"," to control costs.",[1909,1964,1967,1970,1994],{"icon":1965,"label":1966},"i-simple-icons-anthropic","Anthropic",[1843,1968,1969],{},"Anthropic provides Claude models (Haiku 4.5, Sonnet 4.5, Opus 4.5).",[1917,1971,1972,1979,1984,1989,1991],{},[1854,1973,1921,1974,1928],{},[1872,1975,1978],{"href":1976,"rel":1977},"https://console.anthropic.com/",[1926],"console.anthropic.com",[1854,1980,1931,1981,1983],{},[1864,1982,1934],{}," in the settings",[1854,1985,1944,1986],{},[1864,1987,1988],{},"Create Key",[1854,1990,1950],{},[1854,1992,1993],{},"Copy the key immediately",[1890,1995,1996],{"color":1892,"icon":1893},[1843,1997,1998],{},"Anthropic requires a payment method and has usage-based pricing. Monitor usage in the Console dashboard.",[1909,2000,2003,2006,2033],{"icon":2001,"label":2002},"i-simple-icons-googlegemini","Google AI",[1843,2004,2005],{},"Google provides Gemini models (2.5 Flash, 2.5 Pro, 3 Flash Preview, 3 Pro Preview).",[1917,2007,2008,2016,2022,2027,2030],{},[1854,2009,1921,2010,2015],{},[1872,2011,2014],{"href":2012,"rel":2013},"https://aistudio.google.com/",[1926],"aistudio.google.com"," and sign in with your Google account",[1854,2017,1944,2018,2021],{},[1864,2019,2020],{},"Get API Key"," in the left sidebar",[1854,2023,1944,2024],{},[1864,2025,2026],{},"Create API Key",[1854,2028,2029],{},"Select or create a Google Cloud project",[1854,2031,2032],{},"Copy the generated API key",[1890,2034,2035],{"color":1892,"icon":1893},[1843,2036,2037],{},"Google AI Studio offers a free tier with rate limits. For production use, consider enabling billing in Google Cloud Console to increase quotas.",[1847,2039,2041],{"id":2040},"configure-providers-in-directus","Configure Providers in Directus",[2043,2044,2046,2051,2057,2064,2068,2071,2091,2097,2101,2108,2116,2119,2130,2134],"steps",{"level":2045},"3",[2047,2048,2050],"h3",{"id":2049},"navigate-to-ai-settings","Navigate to AI Settings",[1843,2052,1921,2053,2056],{},[1864,2054,2055],{},"Settings → AI"," in the Directus admin panel.",[1843,2058,2059],{},[2060,2061],"img",{"alt":2062,"src":2063},"AI Settings page in Directus","/img/ai-settings-ai-chat.png",[2047,2065,2067],{"id":2066},"enter-your-api-keys","Enter Your API Keys",[1843,2069,2070],{},"Add your API key for one or more providers:",[1851,2072,2073,2079,2085],{},[1854,2074,2075,2078],{},[1864,2076,2077],{},"OpenAI API Key"," - Enables GPT-4 and GPT-5 models",[1854,2080,2081,2084],{},[1864,2082,2083],{},"Anthropic API Key"," - Enables Claude models",[1854,2086,2087,2090],{},[1864,2088,2089],{},"Google API Key"," - Enables Gemini models",[1890,2092,2094],{"color":1892,"icon":2093},"material-symbols:security",[1843,2095,2096],{},"API keys are encrypted at rest in the database and masked in the UI.",[2047,2098,2100],{"id":2099},"configure-allowed-models","Configure Allowed Models",[1843,2102,2103,2104,2107],{},"For each provider, you can restrict which models are available to users. Use the ",[1864,2105,2106],{},"Allowed Models"," dropdown next to each API key field to select the models users can choose from.",[1851,2109,2110,2113],{},[1854,2111,2112],{},"If no models are selected, no models from that provider will be available",[1854,2114,2115],{},"You can add custom model IDs by typing them and pressing Enter (useful when new models are released)",[1843,2117,2118],{},"This is useful for:",[1851,2120,2121,2124,2127],{},[1854,2122,2123],{},"Controlling costs by limiting access to expensive models",[1854,2125,2126],{},"Ensuring compliance by only allowing approved models",[1854,2128,2129],{},"Simplifying the user experience by reducing model choices",[2047,2131,2133],{"id":2132},"save-settings","Save Settings",[1843,2135,1944,2136,2139,2140,2143],{},[1864,2137,2138],{},"Save"," to apply your changes. AI Assistant is now available to all users with ",[1872,2141,1866],{"href":2142},"/guides/auth/access-control#studio-users",".",[1847,2145,2147],{"id":2146},"openai-compatible-providers","OpenAI-Compatible Providers",[1843,2149,2150],{},"In addition to the built-in providers, Directus supports any OpenAI-compatible API endpoint. This allows you to use self-hosted models, alternative providers, or private deployments.",[1890,2152,2155],{"color":2153,"icon":2154},"warning","material-symbols:warning",[1843,2156,2157,2160],{},[1864,2158,2159],{},"For best results, use built-in cloud providers."," Local models vary significantly in their tool-calling capabilities and may produce inconsistent results. If using OpenAI-compatible providers, we recommend cloud-hosted frontier models over locally-run models on personal hardware.",[1890,2162,2163],{"color":1892,"icon":1893},[1843,2164,2165,2168,2169,2173],{},[1864,2166,2167],{},"File attachments are not supported with OpenAI-compatible providers."," ",[1872,2170,2172],{"href":2171},"/guides/ai/assistant/usage#files","File uploads"," require a built-in provider (OpenAI, Anthropic, or Google). The file attachment buttons are hidden when an OpenAI-compatible model is selected.",[1843,2175,2176],{},[2060,2177],{"alt":2178,"src":2179},"OpenAI Compatible Provider Settings","/img/ai-settings-openai-compat.png",[2047,2181,175],{"id":335},[1843,2183,2184,2185,2187,2188,2191],{},"In ",[1864,2186,2055],{},", scroll to the ",[1864,2189,2190],{},"OpenAI-Compatible"," section and configure:",[2193,2194,2195,2208],"table",{},[2196,2197,2198],"thead",{},[2199,2200,2201,2205],"tr",{},[2202,2203,2204],"th",{},"Field",[2202,2206,2207],{},"Description",[2209,2210,2211,2222,2232,2242,2252],"tbody",{},[2199,2212,2213,2219],{},[2214,2215,2216],"td",{},[1864,2217,2218],{},"Provider Name",[2214,2220,2221],{},"Display name shown in the model selector (e.g., \"Ollama\", \"LM Studio\")",[2199,2223,2224,2229],{},[2214,2225,2226],{},[1864,2227,2228],{},"Base URL",[2214,2230,2231],{},"The API endpoint URL (required). Must be OpenAI-compatible.",[2199,2233,2234,2239],{},[2214,2235,2236],{},[1864,2237,2238],{},"API Key",[2214,2240,2241],{},"Authentication key if required by your provider",[2199,2243,2244,2249],{},[2214,2245,2246],{},[1864,2247,2248],{},"Custom Headers",[2214,2250,2251],{},"Additional HTTP headers for authentication or configuration",[2199,2253,2254,2259],{},[2214,2255,2256],{},[1864,2257,2258],{},"Models",[2214,2260,2261],{},"List of models available from this provider",[2047,2263,2265],{"id":2264},"model-configuration","Model Configuration",[1843,2267,2268],{},"For each model, you can specify:",[2193,2270,2271,2279],{},[2196,2272,2273],{},[2199,2274,2275,2277],{},[2202,2276,2204],{},[2202,2278,2207],{},[2209,2280,2281,2291,2301,2311,2321,2331,2341],{},[2199,2282,2283,2288],{},[2214,2284,2285],{},[1864,2286,2287],{},"Model ID",[2214,2289,2290],{},"The model identifier used in API requests",[2199,2292,2293,2298],{},[2214,2294,2295],{},[1864,2296,2297],{},"Display Name",[2214,2299,2300],{},"Human-readable name shown in the UI",[2199,2302,2303,2308],{},[2214,2304,2305],{},[1864,2306,2307],{},"Context Window",[2214,2309,2310],{},"Maximum input tokens (default: 128,000)",[2199,2312,2313,2318],{},[2214,2314,2315],{},[1864,2316,2317],{},"Max Output",[2214,2319,2320],{},"Maximum output tokens (default: 16,000)",[2199,2322,2323,2328],{},[2214,2324,2325],{},[1864,2326,2327],{},"Supports Attachments",[2214,2329,2330],{},"Whether the model can process images/files",[2199,2332,2333,2338],{},[2214,2334,2335],{},[1864,2336,2337],{},"Supports Reasoning",[2214,2339,2340],{},"Whether the model has chain-of-thought capabilities",[2199,2342,2343,2348],{},[2214,2344,2345],{},[1864,2346,2347],{},"Provider Options",[2214,2349,2350],{},"JSON object for model-specific parameters",[1890,2352,2353],{"color":1892,"icon":1893},[1843,2354,2355,2356,2358,2359,2364],{},"The ",[1864,2357,2347],{}," field allows you to pass provider-specific parameters to the AI SDK. This is useful for enabling features like extended thinking or custom sampling parameters. See the ",[1872,2360,2363],{"href":2361,"rel":2362},"https://sdk.vercel.ai/providers/openai-compatible",[1926],"Vercel AI SDK documentation"," for details.",[2047,2366,2368],{"id":2367},"example-configurations","Example Configurations",[1905,2370,2371,2458,2534],{"type":1907},[1909,2372,2375,2382,2397,2402,2441,2449],{"icon":2373,"label":2374},"i-simple-icons-ollama","Ollama",[1843,2376,2377,2381],{},[1872,2378,2374],{"href":2379,"rel":2380},"https://ollama.ai/",[1926]," lets you run open-source models locally.",[1917,2383,2384,2390],{},[1854,2385,2386,2387],{},"Install Ollama and pull a model: ",[1877,2388,2389],{},"ollama pull gpt-oss:20b",[1854,2391,2392,2393,2396],{},"Ollama runs on ",[1877,2394,2395],{},"http://localhost:11434"," by default",[1843,2398,2399],{},[1864,2400,2401],{},"Directus Configuration:",[1851,2403,2404,2411,2418,2426],{},[1854,2405,2406,2408,2409],{},[1864,2407,2218],{},": ",[1877,2410,2374],{},[1854,2412,2413,2408,2415],{},[1864,2414,2228],{},[1877,2416,2417],{},"http://localhost:11434/v1",[1854,2419,2420,2408,2422,2425],{},[1864,2421,2238],{},[1877,2423,2424],{},"ollama"," (required by the OpenAI SDK but ignored by Ollama)",[1854,2427,2428,2430,2431,2434,2435,2434,2438,1941],{},[1864,2429,2258],{},": Add your pulled models (e.g., ",[1877,2432,2433],{},"gpt-oss:20b",", ",[1877,2436,2437],{},"gpt-oss:120b",[1877,2439,2440],{},"qwen3:8b",[1890,2442,2443],{"color":1892,"icon":1893},[1843,2444,2445,2446],{},"You can copy an existing model to an OpenAI-compatible name if needed: ",[1877,2447,2448],{},"ollama cp gpt-oss:20b gpt-4",[1843,2450,2451,2452,2457],{},"See ",[1872,2453,2456],{"href":2454,"rel":2455},"https://docs.ollama.com/api/openai-compatibility",[1926],"Ollama OpenAI compatibility docs"," for supported endpoints and features.",[1909,2459,2462,2470,2481,2485,2510,2526],{"icon":2460,"label":2461},"i-simple-icons-microsoftazure","Azure OpenAI",[1843,2463,2464,2469],{},[1872,2465,2468],{"href":2466,"rel":2467},"https://azure.microsoft.com/en-us/products/ai-services/openai-service",[1926],"Azure OpenAI Service"," provides OpenAI models through Microsoft Azure.",[1917,2471,2472,2475,2478],{},[1854,2473,2474],{},"Create an Azure OpenAI resource in the Azure portal",[1854,2476,2477],{},"Deploy a model (e.g., GPT-4, GPT-4o)",[1854,2479,2480],{},"Get your endpoint and API key from the Develop tab in your resource",[1843,2482,2483],{},[1864,2484,2401],{},[1851,2486,2487,2493,2500,2505],{},[1854,2488,2489,2408,2491],{},[1864,2490,2218],{},[1877,2492,2461],{},[1854,2494,2495,2408,2497],{},[1864,2496,2228],{},[1877,2498,2499],{},"https://YOUR-RESOURCE.openai.azure.com/openai/v1",[1854,2501,2502,2504],{},[1864,2503,2238],{},": Your Azure OpenAI API key",[1854,2506,2507,2509],{},[1864,2508,2258],{},": Add your deployed model names",[1890,2511,2512],{"color":1892,"icon":1893},[1843,2513,2514,2515,2518,2519,2521,2522,2525],{},"The v1 API (August 2025+) no longer requires an ",[1877,2516,2517],{},"api-version"," header. If using an older API version, add ",[1877,2520,2517],{}," as a custom header (e.g., ",[1877,2523,2524],{},"2024-10-21",").",[1843,2527,2451,2528,2533],{},[1872,2529,2532],{"href":2530,"rel":2531},"https://learn.microsoft.com/en-us/azure/ai-services/openai/",[1926],"Azure OpenAI documentation"," for setup details.",[1909,2535,2538,2545,2558,2562,2597],{"icon":2536,"label":2537},"simple-icons:mistralai","Mistral AI",[1843,2539,2540,2544],{},[1872,2541,2537],{"href":2542,"rel":2543},"https://mistral.ai/",[1926]," provides high-performance open and commercial models.",[1917,2546,2547,2555],{},[1854,2548,2549,2550],{},"Create an account at ",[1872,2551,2554],{"href":2552,"rel":2553},"https://console.mistral.ai/",[1926],"console.mistral.ai",[1854,2556,2557],{},"Generate an API key",[1843,2559,2560],{},[1864,2561,2401],{},[1851,2563,2564,2571,2578,2583],{},[1854,2565,2566,2408,2568],{},[1864,2567,2218],{},[1877,2569,2570],{},"Mistral",[1854,2572,2573,2408,2575],{},[1864,2574,2228],{},[1877,2576,2577],{},"https://api.mistral.ai/v1",[1854,2579,2580,2582],{},[1864,2581,2238],{},": Your Mistral API key",[1854,2584,2585,2587,2588,2434,2591,2434,2594],{},[1864,2586,2258],{},": Add models like ",[1877,2589,2590],{},"mistral-large-latest",[1877,2592,2593],{},"mistral-small-latest",[1877,2595,2596],{},"codestral-latest",[1843,2598,2451,2599,2604],{},[1872,2600,2603],{"href":2601,"rel":2602},"https://docs.mistral.ai/",[1926],"Mistral AI documentation"," for available models and pricing.",[1847,2606,2608],{"id":2607},"custom-system-prompt","Custom System Prompt",[1843,2610,2611,2612,2143],{},"Optionally customize how the AI assistant behaves in ",[1864,2613,2614],{},"Settings → AI → Custom System Prompt",[1843,2616,2355,2617,2622],{},[1872,2618,2621],{"href":2619,"rel":2620},"https://github.com/directus/directus/blob/main/api/src/ai/assistant/constants/system-prompt.ts",[1926],"default system prompt"," provides the AI with helpful instructions on how to interact with Directus and is tuned to provide good results.",[1843,2624,2625],{},"If you choose to customize the system prompt, it's recommended to use the following template as a starting point:",[1905,2627,2628],{"type":1907},[1909,2629,2632],{"icon":2630,"label":2631},"material-symbols:code","View Default System Prompt",[2633,2634,2638],"pre",{"className":2635,"code":2636,"language":2637,"meta":24,"style":24},"language-xml shiki shiki-themes github-light github-light github-dark","\u003Cbehavior_instructions>\nYou are **Directus Assistant**, a Directus CMS expert with access to a Directus instance through specialized tools\n\n## Communication Style\n\n- **Be concise**: Users prefer short, direct responses. One-line confirmations: \"Created collection 'products'\"\n- **Match the audience**: Technical for developers, plain language for content editors\n- **NEVER guess**: If not at least 99% about field values or user intent, ask for clarification\n\n## Tool Usage Patterns\n\n### Discovery First\n\n1. Understand the user's task and what they need to achieve.\n2. Discover schema if needed for task - **schema()** with no params → lightweight collection list or **schema({ keys: [\"products\", \"categories\"] })** → full field/relation details\n3. Use other tools as needed to achieve the user's task.\n\n### Content Items\n\n- Use `fields` whenever possible to fetch only the exact fields you need\n- Use `filter` and `limit` to control the number of fetched items unless you absolutely need larger datasets\n- When presenting repeated structured data with 4+ items, use markdown tables for better readability\n\n### Schema & Data Changes\n\n- **Confirm before modifying any schema**: Collections, fields, relations always need approval from the user.\n- **Check namespace conflicts**: Collection folders and regular collections share namespace. Collection folders are distinct from file folders.\n\n### Safety Rules\n\n- **Deletions require confirmation**: ALWAYS ask before deleting anything\n- **Warn on bulk operations**: Alert when affecting many items (\"This updates 500 items\")\n- **Avoid duplicates**: Never create duplicates if you can't modify existing items\n- **Use semantic HTML**: No classes, IDs, or inline styles in content fields (unless explicitly asked for by the user)\n- **Permission errors**: Report immediately, don't retry\n\n### Behavior Rules\n\n- Call tools immediately without explanatory text\n- Use parallel tool calls when possible\n- If you don't have access to a certain tool, ask the user to grant you access to the tool from the chat settings.\n- If there are unused tools in context but task is simple, suggest disabling unused tools (once per conversation)\n\n## Error Handling\n\n- Auto-retry once for clear errors (\"field X required\")\n- Stop after 2 failures, consult user\n- If tool unavailable, suggest enabling in chat settings\n\u003C/behavior_instructions>\n","xml",[1877,2639,2640,2656,2662,2669,2675,2680,2686,2692,2698,2703,2709,2714,2720,2725,2731,2737,2743,2748,2754,2759,2765,2771,2777,2782,2795,2800,2806,2812,2817,2823,2828,2834,2840,2846,2852,2858,2863,2869,2874,2880,2886,2892,2898,2903,2909,2914,2920,2926,2932],{"__ignoreMap":24},[2641,2642,2645,2649,2653],"span",{"class":2643,"line":2644},"line",1,[2641,2646,2648],{"class":2647},"sxrX7","\u003C",[2641,2650,2652],{"class":2651},"sovSZ","behavior_instructions",[2641,2654,2655],{"class":2647},">\n",[2641,2657,2659],{"class":2643,"line":2658},2,[2641,2660,2661],{"class":2647},"You are **Directus Assistant**, a Directus CMS expert with access to a Directus instance through specialized tools\n",[2641,2663,2665],{"class":2643,"line":2664},3,[2641,2666,2668],{"emptyLinePlaceholder":2667},true,"\n",[2641,2670,2672],{"class":2643,"line":2671},4,[2641,2673,2674],{"class":2647},"## Communication Style\n",[2641,2676,2678],{"class":2643,"line":2677},5,[2641,2679,2668],{"emptyLinePlaceholder":2667},[2641,2681,2683],{"class":2643,"line":2682},6,[2641,2684,2685],{"class":2647},"- **Be concise**: Users prefer short, direct responses. One-line confirmations: \"Created collection 'products'\"\n",[2641,2687,2689],{"class":2643,"line":2688},7,[2641,2690,2691],{"class":2647},"- **Match the audience**: Technical for developers, plain language for content editors\n",[2641,2693,2695],{"class":2643,"line":2694},8,[2641,2696,2697],{"class":2647},"- **NEVER guess**: If not at least 99% about field values or user intent, ask for clarification\n",[2641,2699,2701],{"class":2643,"line":2700},9,[2641,2702,2668],{"emptyLinePlaceholder":2667},[2641,2704,2706],{"class":2643,"line":2705},10,[2641,2707,2708],{"class":2647},"## Tool Usage Patterns\n",[2641,2710,2712],{"class":2643,"line":2711},11,[2641,2713,2668],{"emptyLinePlaceholder":2667},[2641,2715,2717],{"class":2643,"line":2716},12,[2641,2718,2719],{"class":2647},"### Discovery First\n",[2641,2721,2723],{"class":2643,"line":2722},13,[2641,2724,2668],{"emptyLinePlaceholder":2667},[2641,2726,2728],{"class":2643,"line":2727},14,[2641,2729,2730],{"class":2647},"1. Understand the user's task and what they need to achieve.\n",[2641,2732,2734],{"class":2643,"line":2733},15,[2641,2735,2736],{"class":2647},"2. Discover schema if needed for task - **schema()** with no params → lightweight collection list or **schema({ keys: [\"products\", \"categories\"] })** → full field/relation details\n",[2641,2738,2740],{"class":2643,"line":2739},16,[2641,2741,2742],{"class":2647},"3. Use other tools as needed to achieve the user's task.\n",[2641,2744,2746],{"class":2643,"line":2745},17,[2641,2747,2668],{"emptyLinePlaceholder":2667},[2641,2749,2751],{"class":2643,"line":2750},18,[2641,2752,2753],{"class":2647},"### Content Items\n",[2641,2755,2757],{"class":2643,"line":2756},19,[2641,2758,2668],{"emptyLinePlaceholder":2667},[2641,2760,2762],{"class":2643,"line":2761},20,[2641,2763,2764],{"class":2647},"- Use `fields` whenever possible to fetch only the exact fields you need\n",[2641,2766,2768],{"class":2643,"line":2767},21,[2641,2769,2770],{"class":2647},"- Use `filter` and `limit` to control the number of fetched items unless you absolutely need larger datasets\n",[2641,2772,2774],{"class":2643,"line":2773},22,[2641,2775,2776],{"class":2647},"- When presenting repeated structured data with 4+ items, use markdown tables for better readability\n",[2641,2778,2780],{"class":2643,"line":2779},23,[2641,2781,2668],{"emptyLinePlaceholder":2667},[2641,2783,2785,2788,2792],{"class":2643,"line":2784},24,[2641,2786,2787],{"class":2647},"### Schema ",[2641,2789,2791],{"class":2790},"sPrNH","&",[2641,2793,2794],{"class":2647}," Data Changes\n",[2641,2796,2798],{"class":2643,"line":2797},25,[2641,2799,2668],{"emptyLinePlaceholder":2667},[2641,2801,2803],{"class":2643,"line":2802},26,[2641,2804,2805],{"class":2647},"- **Confirm before modifying any schema**: Collections, fields, relations always need approval from the user.\n",[2641,2807,2809],{"class":2643,"line":2808},27,[2641,2810,2811],{"class":2647},"- **Check namespace conflicts**: Collection folders and regular collections share namespace. Collection folders are distinct from file folders.\n",[2641,2813,2815],{"class":2643,"line":2814},28,[2641,2816,2668],{"emptyLinePlaceholder":2667},[2641,2818,2820],{"class":2643,"line":2819},29,[2641,2821,2822],{"class":2647},"### Safety Rules\n",[2641,2824,2826],{"class":2643,"line":2825},30,[2641,2827,2668],{"emptyLinePlaceholder":2667},[2641,2829,2831],{"class":2643,"line":2830},31,[2641,2832,2833],{"class":2647},"- **Deletions require confirmation**: ALWAYS ask before deleting anything\n",[2641,2835,2837],{"class":2643,"line":2836},32,[2641,2838,2839],{"class":2647},"- **Warn on bulk operations**: Alert when affecting many items (\"This updates 500 items\")\n",[2641,2841,2843],{"class":2643,"line":2842},33,[2641,2844,2845],{"class":2647},"- **Avoid duplicates**: Never create duplicates if you can't modify existing items\n",[2641,2847,2849],{"class":2643,"line":2848},34,[2641,2850,2851],{"class":2647},"- **Use semantic HTML**: No classes, IDs, or inline styles in content fields (unless explicitly asked for by the user)\n",[2641,2853,2855],{"class":2643,"line":2854},35,[2641,2856,2857],{"class":2647},"- **Permission errors**: Report immediately, don't retry\n",[2641,2859,2861],{"class":2643,"line":2860},36,[2641,2862,2668],{"emptyLinePlaceholder":2667},[2641,2864,2866],{"class":2643,"line":2865},37,[2641,2867,2868],{"class":2647},"### Behavior Rules\n",[2641,2870,2872],{"class":2643,"line":2871},38,[2641,2873,2668],{"emptyLinePlaceholder":2667},[2641,2875,2877],{"class":2643,"line":2876},39,[2641,2878,2879],{"class":2647},"- Call tools immediately without explanatory text\n",[2641,2881,2883],{"class":2643,"line":2882},40,[2641,2884,2885],{"class":2647},"- Use parallel tool calls when possible\n",[2641,2887,2889],{"class":2643,"line":2888},41,[2641,2890,2891],{"class":2647},"- If you don't have access to a certain tool, ask the user to grant you access to the tool from the chat settings.\n",[2641,2893,2895],{"class":2643,"line":2894},42,[2641,2896,2897],{"class":2647},"- If there are unused tools in context but task is simple, suggest disabling unused tools (once per conversation)\n",[2641,2899,2901],{"class":2643,"line":2900},43,[2641,2902,2668],{"emptyLinePlaceholder":2667},[2641,2904,2906],{"class":2643,"line":2905},44,[2641,2907,2908],{"class":2647},"## Error Handling\n",[2641,2910,2912],{"class":2643,"line":2911},45,[2641,2913,2668],{"emptyLinePlaceholder":2667},[2641,2915,2917],{"class":2643,"line":2916},46,[2641,2918,2919],{"class":2647},"- Auto-retry once for clear errors (\"field X required\")\n",[2641,2921,2923],{"class":2643,"line":2922},47,[2641,2924,2925],{"class":2647},"- Stop after 2 failures, consult user\n",[2641,2927,2929],{"class":2643,"line":2928},48,[2641,2930,2931],{"class":2647},"- If tool unavailable, suggest enabling in chat settings\n",[2641,2933,2935,2938,2940],{"class":2643,"line":2934},49,[2641,2936,2937],{"class":2647},"\u003C/",[2641,2939,2652],{"class":2651},[2641,2941,2655],{"class":2647},[1843,2943,2944],{},"Leave blank to use the default behavior.",[1847,2946,2948],{"id":2947},"prompts-collection","Prompts Collection",[1843,2950,2951],{},"Enable reusable prompts in AI Assistant by configuring a prompts collection:",[1917,2953,2954,2959,2965],{},[1854,2955,1921,2956],{},[1864,2957,2958],{},"Settings → AI → Model Context Protocol",[1854,2960,2961,2962],{},"Find ",[1864,2963,2964],{},"AI Prompts Collection",[1854,2966,2967],{},"Either generate a new collection or select an existing one",[1890,2969,2970],{"color":1892,"icon":1893},[1843,2971,2972,2973,2975],{},"This is the same collection used by the ",[1872,2974,938],{"href":960},". Prompts created here are available in both AI Assistant and external MCP clients. This also requires MCP to be enabled.",[1843,2977,2978,2979,2143],{},"For details on creating prompts with variables, see ",[1872,2980,2981],{"href":960},"MCP Prompts",[1847,2983,2985],{"id":2984},"managing-costs","Managing Costs",[1890,2987,2988],{"color":2153,"icon":2154},[1843,2989,2990,2993],{},[1864,2991,2992],{},"AI Assistant uses your own AI provider API keys."," Every message and tool call costs money. Be mindful of usage, especially with larger models. You are responsible for the costs of your usage.",[1843,2995,2996],{},[1864,2997,2998],{},"Tips for controlling costs:",[1851,3000,3001,3004,3011,3014,3035],{},[1854,3002,3003],{},"Use faster, cheaper models (GPT-5 Nano, Claude Haiku 4.5, Gemini 2.5 Flash) for simple tasks",[1854,3005,3006,3007,3010],{},"Use ",[1872,3008,2106],{"href":3009},"#configure-allowed-models"," to restrict access to expensive models",[1854,3012,3013],{},"Disable unused tools - disabled tools are not loaded into context, reducing token usage",[1854,3015,3016,3017],{},"Set spending limits in your provider dashboard:\n",[1851,3018,3019,3025,3030],{},[1854,3020,3021],{},[1872,3022,1912],{"href":3023,"rel":3024},"https://platform.openai.com/settings/organization/limits",[1926],[1854,3026,3027],{},[1872,3028,1966],{"href":1976,"rel":3029},[1926],[1854,3031,3032],{},[1872,3033,2002],{"href":2012,"rel":3034},[1926],[1854,3036,3037,3038,3041],{},"Consider self-hosted models via ",[1872,3039,3040],{"href":1886},"OpenAI-compatible providers"," for cost control",[1847,3043,3045],{"id":3044},"telemetry","Telemetry",[1843,3047,3048,3049,3054,3055,3060],{},"Directus can send AI Assistant traces to ",[1872,3050,3053],{"href":3051,"rel":3052},"https://langfuse.com",[1926],"Langfuse"," or ",[1872,3056,3059],{"href":3057,"rel":3058},"https://braintrust.dev",[1926],"Braintrust"," for observability — monitor usage, latency, token costs, and full request/response content.",[1843,3062,3063],{},"Set the following environment variables to enable telemetry:",[2633,3065,3069],{"className":3066,"code":3067,"language":3068,"meta":24,"style":24},"language-ini shiki shiki-themes github-light github-light github-dark","AI_TELEMETRY_ENABLED=true\nAI_TELEMETRY_PROVIDER=langfuse # or braintrust\n","ini",[1877,3070,3071,3080],{"__ignoreMap":24},[2641,3072,3073,3077],{"class":2643,"line":2644},[2641,3074,3076],{"class":3075},"s8jYJ","AI_TELEMETRY_ENABLED",[2641,3078,3079],{"class":2647},"=true\n",[2641,3081,3082,3085,3088],{"class":2643,"line":2658},[2641,3083,3084],{"class":3075},"AI_TELEMETRY_PROVIDER",[2641,3086,3087],{"class":2647},"=langfuse ",[2641,3089,3091],{"class":3090},"sCsY4","# or braintrust\n",[2047,3093,3053],{"id":3094},"langfuse",[2633,3096,3098],{"className":3066,"code":3097,"language":3068,"meta":24,"style":24},"AI_TELEMETRY_PROVIDER=langfuse\nLANGFUSE_SECRET_KEY=sk-lf-...\nLANGFUSE_PUBLIC_KEY=pk-lf-...\nLANGFUSE_BASE_URL=https://cloud.langfuse.com # optional, default shown\n",[1877,3099,3100,3107,3115,3123],{"__ignoreMap":24},[2641,3101,3102,3104],{"class":2643,"line":2644},[2641,3103,3084],{"class":3075},[2641,3105,3106],{"class":2647},"=langfuse\n",[2641,3108,3109,3112],{"class":2643,"line":2658},[2641,3110,3111],{"class":3075},"LANGFUSE_SECRET_KEY",[2641,3113,3114],{"class":2647},"=sk-lf-...\n",[2641,3116,3117,3120],{"class":2643,"line":2664},[2641,3118,3119],{"class":3075},"LANGFUSE_PUBLIC_KEY",[2641,3121,3122],{"class":2647},"=pk-lf-...\n",[2641,3124,3125,3128,3131],{"class":2643,"line":2671},[2641,3126,3127],{"class":3075},"LANGFUSE_BASE_URL",[2641,3129,3130],{"class":2647},"=https://cloud.langfuse.com ",[2641,3132,3133],{"class":3090},"# optional, default shown\n",[1843,3135,3136],{},[2060,3137],{"alt":3138,"src":3139},"Langfuse trace dashboard showing AI Assistant requests","/img/ai-telemetry-langfuse.png",[2047,3141,3059],{"id":3142},"braintrust",[2633,3144,3146],{"className":3066,"code":3145,"language":3068,"meta":24,"style":24},"AI_TELEMETRY_PROVIDER=braintrust\nBRAINTRUST_API_KEY=sk-...\nBRAINTRUST_PROJECT_NAME=my-project # optional\n",[1877,3147,3148,3155,3163],{"__ignoreMap":24},[2641,3149,3150,3152],{"class":2643,"line":2644},[2641,3151,3084],{"class":3075},[2641,3153,3154],{"class":2647},"=braintrust\n",[2641,3156,3157,3160],{"class":2643,"line":2658},[2641,3158,3159],{"class":3075},"BRAINTRUST_API_KEY",[2641,3161,3162],{"class":2647},"=sk-...\n",[2641,3164,3165,3168,3171],{"class":2643,"line":2664},[2641,3166,3167],{"class":3075},"BRAINTRUST_PROJECT_NAME",[2641,3169,3170],{"class":2647},"=my-project ",[2641,3172,3173],{"class":3090},"# optional\n",[1843,3175,3176],{},[2060,3177],{"alt":3178,"src":3179},"Braintrust trace dashboard showing AI Assistant requests","/img/ai-telemetry-braintrust.png",[1843,3181,3182,3183,3186],{},"Optionally enable ",[1877,3184,3185],{},"AI_TELEMETRY_RECORD_IO=true"," to include full prompt inputs and AI responses in traces.",[1890,3188,3189],{"color":2153,"icon":2154},[1843,3190,3191,3192,3195],{},"Enabling ",[1877,3193,3194],{},"AI_TELEMETRY_RECORD_IO"," will send the full content of user messages and AI responses to your telemetry provider. Only enable this if your provider meets your data privacy requirements.",[1843,3197,3198,3199,3203],{},"See the ",[1872,3200,3202],{"href":3201},"/configuration/ai#telemetry","AI Configuration"," reference for all available variables.",[1847,3205,3207],{"id":3206},"next-steps","Next Steps",[3209,3210,3211,3219,3226,3233],"card-group",{},[3212,3213,3216],"card",{"icon":3214,"title":3215,"to":920},"material-symbols:chat","User Guide",[1843,3217,3218],{},"Learn how users interact with AI Assistant.",[3212,3220,3223],{"icon":3221,"title":3222,"to":925},"material-symbols:construction","Available Tools",[1843,3224,3225],{},"See what actions the AI can perform.",[3212,3227,3230],{"icon":3228,"title":3229,"to":930},"material-symbols:lightbulb","Tips & Best Practices",[1843,3231,3232],{},"Get the most out of AI Assistant.",[3212,3234,3235],{"icon":2093,"title":894,"to":934},[1843,3236,3237],{},"Access control and data protection.",[3239,3240,3241],"style",{},"html pre.shiki code .sxrX7, html code.shiki .sxrX7{--shiki-light:#24292E;--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sovSZ, html code.shiki .sovSZ{--shiki-light:#22863A;--shiki-default:#22863A;--shiki-dark:#85E89D}html pre.shiki code .sPrNH, html code.shiki .sPrNH{--shiki-light:#B31D28;--shiki-light-font-style:italic;--shiki-default:#B31D28;--shiki-default-font-style:italic;--shiki-dark:#FDAEB7;--shiki-dark-font-style:italic}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .s8jYJ, html code.shiki .s8jYJ{--shiki-light:#D73A49;--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .sCsY4, html code.shiki .sCsY4{--shiki-light:#6A737D;--shiki-default:#6A737D;--shiki-dark:#6A737D}",{"title":24,"searchDepth":2644,"depth":2658,"links":3243},[3244,3245,3246,3247,3252,3253,3254,3255,3259],{"id":1849,"depth":2658,"text":1123},{"id":1899,"depth":2658,"text":1900},{"id":2040,"depth":2658,"text":2041},{"id":2146,"depth":2658,"text":2147,"children":3248},[3249,3250,3251],{"id":335,"depth":2664,"text":175},{"id":2264,"depth":2664,"text":2265},{"id":2367,"depth":2664,"text":2368},{"id":2607,"depth":2658,"text":2608},{"id":2947,"depth":2658,"text":2948},{"id":2984,"depth":2658,"text":2985},{"id":3044,"depth":2658,"text":3045,"children":3256},[3257,3258],{"id":3094,"depth":2664,"text":3053},{"id":3142,"depth":2664,"text":3059},{"id":3206,"depth":2658,"text":3207},"md",{},"---\ntitle: Setup\ndescription: Configure AI Assistant by adding your AI provider API keys and customizing assistant behavior.\nheadline: AI Assistant\n---\n\nAI Assistant requires an API key from a supported AI provider. This page covers the administrator setup process.\n\n## Requirements\n\n- Administrator access to your Directus instance\n- API key from at least one supported provider: OpenAI, Anthropic, or Google (see below)\n- Users must have **App access** - Public (non-authenticated) or API-only users cannot use AI Assistant\n- AI Assistant can be [disabled at the infrastructure level](/configuration/ai) using the `AI_ENABLED` environment variable\n\nAlternatively, you can use an [OpenAI-compatible provider](#openai-compatible-providers) like Ollama or LM Studio for self-hosted models.\n\n::callout{icon=\"material-symbols:info\" color=\"info\"}\nNote that all users of AI Assistant will share a single API key from your configured provider. Usage limits and costs will be shared across all users. See your provider's dashboard for monitoring usage details and costs.\n::\n\n## Get an API Key\n\nYou'll need an API key from at least one provider. Choose based on which models you want to use.\n\n::accordion{type=\"single\"}\n\n:::accordion-item{label=\"OpenAI\" icon=\"i-simple-icons-openai\"}\n\nOpenAI provides GPT-5 models (Nano, Mini, Standard).\n\n1. Go to [platform.openai.com](https://platform.openai.com/) and sign in or create an account\n2. Navigate to **API Keys** in the left sidebar (or go directly to [platform.openai.com/api-keys](https://platform.openai.com/api-keys))\n3. Click **Create new secret key**\n4. Give it a name like \"Directus AI Assistant\"\n5. Copy the key immediately - you won't be able to see it again\n\n::callout{icon=\"material-symbols:info\" color=\"info\"}\nOpenAI requires a payment method and has usage-based pricing. Set spending limits in **Settings → Limits** to control costs.\n::\n\n:::\n\n:::accordion-item{label=\"Anthropic\" icon=\"i-simple-icons-anthropic\"}\n\nAnthropic provides Claude models (Haiku 4.5, Sonnet 4.5, Opus 4.5).\n\n1. Go to [console.anthropic.com](https://console.anthropic.com/) and sign in or create an account\n2. Navigate to **API Keys** in the settings\n3. Click **Create Key**\n4. Give it a name like \"Directus AI Assistant\"\n5. Copy the key immediately\n\n::callout{icon=\"material-symbols:info\" color=\"info\"}\nAnthropic requires a payment method and has usage-based pricing. Monitor usage in the Console dashboard.\n::\n\n:::\n\n:::accordion-item{label=\"Google AI\" icon=\"i-simple-icons-googlegemini\"}\n\nGoogle provides Gemini models (2.5 Flash, 2.5 Pro, 3 Flash Preview, 3 Pro Preview).\n\n1. Go to [aistudio.google.com](https://aistudio.google.com/) and sign in with your Google account\n2. Click **Get API Key** in the left sidebar\n3. Click **Create API Key**\n4. Select or create a Google Cloud project\n5. Copy the generated API key\n\n::callout{icon=\"material-symbols:info\" color=\"info\"}\nGoogle AI Studio offers a free tier with rate limits. For production use, consider enabling billing in Google Cloud Console to increase quotas.\n::\n\n:::\n\n::\n\n## Configure Providers in Directus\n\n::steps{level=\"3\"}\n\n### Navigate to AI Settings\n\nGo to **Settings → AI** in the Directus admin panel.\n\n![AI Settings page in Directus](/img/ai-settings-ai-chat.png)\n\n### Enter Your API Keys\n\nAdd your API key for one or more providers:\n\n- **OpenAI API Key** - Enables GPT-4 and GPT-5 models\n- **Anthropic API Key** - Enables Claude models\n- **Google API Key** - Enables Gemini models\n\n::callout{icon=\"material-symbols:security\" color=\"info\"}\nAPI keys are encrypted at rest in the database and masked in the UI.\n::\n\n### Configure Allowed Models\n\nFor each provider, you can restrict which models are available to users. Use the **Allowed Models** dropdown next to each API key field to select the models users can choose from.\n\n- If no models are selected, no models from that provider will be available\n- You can add custom model IDs by typing them and pressing Enter (useful when new models are released)\n\nThis is useful for:\n- Controlling costs by limiting access to expensive models\n- Ensuring compliance by only allowing approved models\n- Simplifying the user experience by reducing model choices\n\n### Save Settings\n\nClick **Save** to apply your changes. AI Assistant is now available to all users with [App access](/guides/auth/access-control#studio-users).\n\n::\n\n## OpenAI-Compatible Providers\n\nIn addition to the built-in providers, Directus supports any OpenAI-compatible API endpoint. This allows you to use self-hosted models, alternative providers, or private deployments.\n\n::callout{icon=\"material-symbols:warning\" color=\"warning\"}\n**For best results, use built-in cloud providers.** Local models vary significantly in their tool-calling capabilities and may produce inconsistent results. If using OpenAI-compatible providers, we recommend cloud-hosted frontier models over locally-run models on personal hardware.\n::\n\n::callout{icon=\"material-symbols:info\" color=\"info\"}\n**File attachments are not supported with OpenAI-compatible providers.** [File uploads](/guides/ai/assistant/usage#files) require a built-in provider (OpenAI, Anthropic, or Google). The file attachment buttons are hidden when an OpenAI-compatible model is selected.\n::\n\n![OpenAI Compatible Provider Settings](/img/ai-settings-openai-compat.png)\n\n### Configuration\n\nIn **Settings → AI**, scroll to the **OpenAI-Compatible** section and configure:\n\n| Field | Description |\n| ----- | ----------- |\n| **Provider Name** | Display name shown in the model selector (e.g., \"Ollama\", \"LM Studio\") |\n| **Base URL** | The API endpoint URL (required). Must be OpenAI-compatible. |\n| **API Key** | Authentication key if required by your provider |\n| **Custom Headers** | Additional HTTP headers for authentication or configuration |\n| **Models** | List of models available from this provider |\n\n### Model Configuration\n\nFor each model, you can specify:\n\n| Field | Description |\n| ----- | ----------- |\n| **Model ID** | The model identifier used in API requests |\n| **Display Name** | Human-readable name shown in the UI |\n| **Context Window** | Maximum input tokens (default: 128,000) |\n| **Max Output** | Maximum output tokens (default: 16,000) |\n| **Supports Attachments** | Whether the model can process images/files |\n| **Supports Reasoning** | Whether the model has chain-of-thought capabilities |\n| **Provider Options** | JSON object for model-specific parameters |\n\n::callout{icon=\"material-symbols:info\" color=\"info\"}\nThe **Provider Options** field allows you to pass provider-specific parameters to the AI SDK. This is useful for enabling features like extended thinking or custom sampling parameters. See the [Vercel AI SDK documentation](https://sdk.vercel.ai/providers/openai-compatible) for details.\n::\n\n### Example Configurations\n\n::accordion{type=\"single\"}\n\n:::accordion-item{label=\"Ollama\" icon=\"i-simple-icons-ollama\"}\n\n[Ollama](https://ollama.ai/) lets you run open-source models locally.\n\n1. Install Ollama and pull a model: `ollama pull gpt-oss:20b`\n2. Ollama runs on `http://localhost:11434` by default\n\n**Directus Configuration:**\n- **Provider Name**: `Ollama`\n- **Base URL**: `http://localhost:11434/v1`\n- **API Key**: `ollama` (required by the OpenAI SDK but ignored by Ollama)\n- **Models**: Add your pulled models (e.g., `gpt-oss:20b`, `gpt-oss:120b`, `qwen3:8b`)\n\n::callout{icon=\"material-symbols:info\" color=\"info\"}\nYou can copy an existing model to an OpenAI-compatible name if needed: `ollama cp gpt-oss:20b gpt-4`\n::\n\nSee [Ollama OpenAI compatibility docs](https://docs.ollama.com/api/openai-compatibility) for supported endpoints and features.\n\n:::\n\n\n:::accordion-item{label=\"Azure OpenAI\" icon=\"i-simple-icons-microsoftazure\"}\n\n[Azure OpenAI Service](https://azure.microsoft.com/en-us/products/ai-services/openai-service) provides OpenAI models through Microsoft Azure.\n\n1. Create an Azure OpenAI resource in the Azure portal\n2. Deploy a model (e.g., GPT-4, GPT-4o)\n3. Get your endpoint and API key from the Develop tab in your resource\n\n**Directus Configuration:**\n- **Provider Name**: `Azure OpenAI`\n- **Base URL**: `https://YOUR-RESOURCE.openai.azure.com/openai/v1`\n- **API Key**: Your Azure OpenAI API key\n- **Models**: Add your deployed model names\n\n::callout{icon=\"material-symbols:info\" color=\"info\"}\nThe v1 API (August 2025+) no longer requires an `api-version` header. If using an older API version, add `api-version` as a custom header (e.g., `2024-10-21`).\n::\n\nSee [Azure OpenAI documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/) for setup details.\n\n:::\n\n:::accordion-item{label=\"Mistral AI\" icon=\"simple-icons:mistralai\"}\n\n[Mistral AI](https://mistral.ai/) provides high-performance open and commercial models.\n\n1. Create an account at [console.mistral.ai](https://console.mistral.ai/)\n2. Generate an API key\n\n**Directus Configuration:**\n- **Provider Name**: `Mistral`\n- **Base URL**: `https://api.mistral.ai/v1`\n- **API Key**: Your Mistral API key\n- **Models**: Add models like `mistral-large-latest`, `mistral-small-latest`, `codestral-latest`\n\nSee [Mistral AI documentation](https://docs.mistral.ai/) for available models and pricing.\n\n:::\n\n::\n\n## Custom System Prompt\n\nOptionally customize how the AI assistant behaves in **Settings → AI → Custom System Prompt**.\n\nThe [default system prompt](https://github.com/directus/directus/blob/main/api/src/ai/assistant/constants/system-prompt.ts) provides the AI with helpful instructions on how to interact with Directus and is tuned to provide good results.\n\nIf you choose to customize the system prompt, it's recommended to use the following template as a starting point:\n\n::accordion{type=\"single\"}\n\n:::accordion-item{label=\"View Default System Prompt\" icon=\"material-symbols:code\"}\n\n```xml\n\u003Cbehavior_instructions>\nYou are **Directus Assistant**, a Directus CMS expert with access to a Directus instance through specialized tools\n\n## Communication Style\n\n- **Be concise**: Users prefer short, direct responses. One-line confirmations: \"Created collection 'products'\"\n- **Match the audience**: Technical for developers, plain language for content editors\n- **NEVER guess**: If not at least 99% about field values or user intent, ask for clarification\n\n## Tool Usage Patterns\n\n### Discovery First\n\n1. Understand the user's task and what they need to achieve.\n2. Discover schema if needed for task - **schema()** with no params → lightweight collection list or **schema({ keys: [\"products\", \"categories\"] })** → full field/relation details\n3. Use other tools as needed to achieve the user's task.\n\n### Content Items\n\n- Use `fields` whenever possible to fetch only the exact fields you need\n- Use `filter` and `limit` to control the number of fetched items unless you absolutely need larger datasets\n- When presenting repeated structured data with 4+ items, use markdown tables for better readability\n\n### Schema & Data Changes\n\n- **Confirm before modifying any schema**: Collections, fields, relations always need approval from the user.\n- **Check namespace conflicts**: Collection folders and regular collections share namespace. Collection folders are distinct from file folders.\n\n### Safety Rules\n\n- **Deletions require confirmation**: ALWAYS ask before deleting anything\n- **Warn on bulk operations**: Alert when affecting many items (\"This updates 500 items\")\n- **Avoid duplicates**: Never create duplicates if you can't modify existing items\n- **Use semantic HTML**: No classes, IDs, or inline styles in content fields (unless explicitly asked for by the user)\n- **Permission errors**: Report immediately, don't retry\n\n### Behavior Rules\n\n- Call tools immediately without explanatory text\n- Use parallel tool calls when possible\n- If you don't have access to a certain tool, ask the user to grant you access to the tool from the chat settings.\n- If there are unused tools in context but task is simple, suggest disabling unused tools (once per conversation)\n\n## Error Handling\n\n- Auto-retry once for clear errors (\"field X required\")\n- Stop after 2 failures, consult user\n- If tool unavailable, suggest enabling in chat settings\n\u003C/behavior_instructions>\n```\n\n:::\n\n::\n\nLeave blank to use the default behavior.\n\n## Prompts Collection\n\nEnable reusable prompts in AI Assistant by configuring a prompts collection:\n\n1. Go to **Settings → AI → Model Context Protocol**\n2. Find **AI Prompts Collection**\n3. Either generate a new collection or select an existing one\n\n::callout{icon=\"material-symbols:info\" color=\"info\"}\nThis is the same collection used by the [MCP Server](/guides/ai/mcp/prompts). Prompts created here are available in both AI Assistant and external MCP clients. This also requires MCP to be enabled.\n::\n\nFor details on creating prompts with variables, see [MCP Prompts](/guides/ai/mcp/prompts).\n\n## Managing Costs\n\n::callout{icon=\"material-symbols:warning\" color=\"warning\"}\n**AI Assistant uses your own AI provider API keys.** Every message and tool call costs money. Be mindful of usage, especially with larger models. You are responsible for the costs of your usage.\n::\n\n**Tips for controlling costs:**\n- Use faster, cheaper models (GPT-5 Nano, Claude Haiku 4.5, Gemini 2.5 Flash) for simple tasks\n- Use [Allowed Models](#configure-allowed-models) to restrict access to expensive models\n- Disable unused tools - disabled tools are not loaded into context, reducing token usage\n- Set spending limits in your provider dashboard:\n  - [OpenAI](https://platform.openai.com/settings/organization/limits)\n  - [Anthropic](https://console.anthropic.com/)\n  - [Google AI](https://aistudio.google.com/)\n- Consider self-hosted models via [OpenAI-compatible providers](#openai-compatible-providers) for cost control\n\n## Telemetry\n\nDirectus can send AI Assistant traces to [Langfuse](https://langfuse.com) or [Braintrust](https://braintrust.dev) for observability — monitor usage, latency, token costs, and full request/response content.\n\nSet the following environment variables to enable telemetry:\n\n```ini\nAI_TELEMETRY_ENABLED=true\nAI_TELEMETRY_PROVIDER=langfuse # or braintrust\n```\n\n### Langfuse\n\n```ini\nAI_TELEMETRY_PROVIDER=langfuse\nLANGFUSE_SECRET_KEY=sk-lf-...\nLANGFUSE_PUBLIC_KEY=pk-lf-...\nLANGFUSE_BASE_URL=https://cloud.langfuse.com # optional, default shown\n```\n\n![Langfuse trace dashboard showing AI Assistant requests](/img/ai-telemetry-langfuse.png)\n\n### Braintrust\n\n```ini\nAI_TELEMETRY_PROVIDER=braintrust\nBRAINTRUST_API_KEY=sk-...\nBRAINTRUST_PROJECT_NAME=my-project # optional\n```\n\n![Braintrust trace dashboard showing AI Assistant requests](/img/ai-telemetry-braintrust.png)\n\nOptionally enable `AI_TELEMETRY_RECORD_IO=true` to include full prompt inputs and AI responses in traces.\n\n::callout{icon=\"material-symbols:warning\" color=\"warning\"}\nEnabling `AI_TELEMETRY_RECORD_IO` will send the full content of user messages and AI responses to your telemetry provider. Only enable this if your provider meets your data privacy requirements.\n::\n\nSee the [AI Configuration](/configuration/ai#telemetry) reference for all available variables.\n\n## Next Steps\n\n::card-group\n\n:::card{title=\"User Guide\" icon=\"material-symbols:chat\" to=\"/guides/ai/assistant/usage\"}\nLearn how users interact with AI Assistant.\n:::\n\n:::card{title=\"Available Tools\" icon=\"material-symbols:construction\" to=\"/guides/ai/assistant/tools\"}\nSee what actions the AI can perform.\n:::\n\n:::card{title=\"Tips & Best Practices\" icon=\"material-symbols:lightbulb\" to=\"/guides/ai/assistant/tips\"}\nGet the most out of AI Assistant.\n:::\n\n:::card{title=\"Security\" icon=\"material-symbols:security\" to=\"/guides/ai/assistant/security\"}\nAccess control and data protection.\n:::\n\n::\n",{"title":914,"description":917},"RDv14ti84eeGu5A8Djpdkm7Jc1VNosVWJkhufVkAzaA",[3266,3267],{"title":230,"path":908,"stem":909,"description":912,"children":-1},{"title":919,"path":920,"stem":921,"description":922,"children":-1},1775246944261]