You are now ready to begin creating an agent in VideoDB Director!
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"VideoDB Documentation","colors":{"primary":"#ec601c","light":"#f5f5f5","dark":"#1a1a1a"},"logo":{"light":"https://mintcdn.com/videodb/GgiJu8HrYcTvfnRD/logo/light.svg?fit=max\u0026auto=format\u0026n=GgiJu8HrYcTvfnRD\u0026q=85\u0026s=613ed1f657ca517349000e89cf435607","dark":"https://mintcdn.com/videodb/GgiJu8HrYcTvfnRD/logo/dark.svg?fit=max\u0026auto=format\u0026n=GgiJu8HrYcTvfnRD\u0026q=85\u0026s=c517cf520b7cc14475457829efb77cb9"},"favicon":{"light":"https://mintcdn.com/videodb/GgiJu8HrYcTvfnRD/favicon.svg?fit=max\u0026auto=format\u0026n=GgiJu8HrYcTvfnRD\u0026q=85\u0026s=ce0221086f37460c2ae7d5c49fc01926","dark":"https://mintcdn.com/videodb/GgiJu8HrYcTvfnRD/favicon.svg?fit=max\u0026auto=format\u0026n=GgiJu8HrYcTvfnRD\u0026q=85\u0026s=ce0221086f37460c2ae7d5c49fc01926"},"api":{"playground":{"display":"interactive"},"examples":{"languages":["bash","javascript","php","go","java","ruby","powershell","swift","csharp","dotnet","typescript","c","c++","kotlin"]},"mdx":{"auth":{"method":"key","name":"x-access-token"},"server":"https://api.videodb.io"}},"navbar":{"links":[],"primary":{"type":"button","label":"Get API Key","href":"https://console.videodb.io/auth?utm_source=docs_videodb_io\u0026utm_medium=docs_link\u0026utm_campaign=console_auth\u0026utm_content=docs_link\u0026id=docs"}},"footer":{"socials":{"x":"https://x.com/videodb_io","github":"https://github.com/video-db","linkedin":"https://www.linkedin.com/company/videodb","discord":"https://discord.com/invite/py9P639jGz"}},"seo":{"metatags":{"canonical":"https://docs.videodb.io"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","latex":true},"integrations":{"ga4":{"measurementId":"G-JSXFX7121R"}},"errors":{"404":{"redirect":false,"title":"SCENE NOT FOUND"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"videodb","hasAudioNarration":false,"actualSubdomain":"videodb","customDomains":["docs.videodb.io"],"gitSource":{"type":"github","owner":"video-db","repo":"videodb-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af4a898bf76e62f8d451b2b","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API Reference","count":348},{"language":"default","tag":"Documentation","count":91},{"language":"default","tag":"Examples \u0026 Tutorials","count":51},{"language":"default","tag":"RTStream","count":31},{"language":"default","tag":"Understand","count":18},{"language":"default","tag":"Act","count":17},{"language":"default","tag":"Automate","count":17},{"language":"default","tag":"Capture","count":15},{"language":"default","tag":"Collections","count":14},{"language":"default","tag":"Videos","count":13}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"community-love.css","content":".community-love-testimonials{display:contents;--community-testimonial-card-bg: #efefef;--community-testimonial-card-hover-bg: #cbcbcb;--community-testimonial-card-border: rgba(0, 0, 0, 0.05);--community-testimonial-card-hover-border: rgba(0, 0, 0, 0.12);--community-testimonial-card-hover-shadow: 0 12px 32px rgba(0, 0, 0, 0.12);--community-testimonial-name-color: #000000;--community-testimonial-byline-color: #615c5a;--community-testimonial-body-color: #000000;--community-testimonial-platform-color: #000000}.dark .community-love-testimonials,[data-theme=\"dark\"] .community-love-testimonials,[data-color-mode=\"dark\"] .community-love-testimonials{--community-testimonial-card-bg: #151515;--community-testimonial-card-hover-bg: #1e1e1e;--community-testimonial-card-border: rgba(255, 255, 255, 0.05);--community-testimonial-card-hover-border: rgba(255, 255, 255, 0.16);--community-testimonial-card-hover-shadow: 0 12px 32px rgba(0, 0, 0, 0.28);--community-testimonial-name-color: #f7f7f7;--community-testimonial-byline-color: rgba(255, 255, 255, 0.45);--community-testimonial-body-color: rgba(255, 255, 255, 0.88);--community-testimonial-platform-color: #ffffff}html[data-current-path$=\"/community-love\"],html[data-current-path$=\"/community-love\"] body{overscroll-behavior-y:none}html[data-current-path$=\"/community-love\"] #body-content,html[data-current-path$=\"/community-love\"] #content-area,html[data-current-path$=\"/community-love\"] #content,html[data-current-path$=\"/community-love\"] mdx-content{min-height:auto!important}html[data-current-path$=\"/community-love\"] #footer,html[data-current-path$=\"/community-love\"] footer{margin-bottom:0!important;padding-bottom:0!important}"}],"page":{"pagePath":"pages/build-with-agents/director/setup-director","slug":"/pages/build-with-agents/director/setup-director","pageMetadata":{"title":"Setup Director","description":"Install and configure the Director framework locally to build custom video agents and workflows for your applications.","keywords":["director-local-setup","self-hosted","github-deployment","local-installation"],"icon":"settings","href":"/pages/build-with-agents/director/setup-director"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Install and configure the Director framework locally to build custom video agents and workflows for your applications.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.strong,{children:`Clone the repository:`})}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Begin by cloning the `,_jsx(_components.strong,{children:`Director`}),` repository and navigating to the project directory:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`git`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` clone`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://github.com/video-db/Director.git`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`cd`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Director`})]}),`\n`]})})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.strong,{children:`Run the setup script:`})}),`\n`]}),`\n`,_jsx(_components.p,{children:`Execute the setup script to install all necessary dependencies:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`./setup.sh`})}),`\n`]})})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.strong,{children:`Run the Application`})}),`\n`]}),`\n`,_jsx(_components.p,{children:`You can start both the backend and frontend servers with:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`make`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` run`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`If you want to run them separately:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Backend only:`}),` make run-be (Runs at `,_jsx(_components.a,{href:`http://127.0.0.1:8000`,children:`http://127.0.0.1:8000`}),`)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Frontend only:`}),` make run-fe (Runs at `,_jsx(_components.a,{href:`http://127.0.0.1:8080`,children:`http://127.0.0.1:8080`}),`)`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`You are now ready to begin creating an agent in VideoDB Director!`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Setup Director","description":"Install and configure the Director framework locally to build custom video agents and workflows for your applications.","keywords":["director-local-setup","self-hosted","github-deployment","local-installation"],"icon":"settings","href":"/pages/build-with-agents/director/setup-director"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/videodb/1183f1a3c2dbd858/console-utm-forwarding.js"],"subdomain":"videodb","siteName":"VideoDB Documentation","title":"Setup Director - VideoDB Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-02T19:56:00.856Z","originalFileLocation":"pages/build-with-agents/director/setup-director.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Install and configure the Director framework locally to build custom video agents and workflows for your applications.\">\u003cmeta data-mint-head name=\"application-name\" content=\"VideoDB Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/videodb/m2QHSzY3st6NzBBu/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/videodb/m2QHSzY3st6NzBBu/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/videodb/m2QHSzY3st6NzBBu/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/videodb/m2QHSzY3st6NzBBu/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/videodb/m2QHSzY3st6NzBBu/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/videodb/m2QHSzY3st6NzBBu/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/videodb/m2QHSzY3st6NzBBu/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/videodb/m2QHSzY3st6NzBBu/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/videodb/m2QHSzY3st6NzBBu/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Setup Director - VideoDB Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Install and configure the Director framework locally to build custom video agents and workflows for your applications.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"VideoDB Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.videodb.io/pages/build-with-agents/director/setup-director\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://videodb.mintlify.site/_mintlify/api/og/v2?division=Director+Framework\u0026amp;title=Setup+Director\u0026amp;description=Install+and+configure+the+Director+framework+locally+to+build+custom+video+agents+and+workflows+for+your+applications.\u0026amp;theme=2920d5ecda04d88f90eeaa00\u0026amp;signature=72e28cd91212de56d0a55af8df71b1e93014e166799a2dc4ba85ff9887f86950\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Setup Director - VideoDB Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Install and configure the Director framework locally to build custom video agents and workflows for your applications.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://videodb.mintlify.site/_mintlify/api/og/v2?division=Director+Framework\u0026amp;title=Setup+Director\u0026amp;description=Install+and+configure+the+Director+framework+locally+to+build+custom+video+agents+and+workflows+for+your+applications.\u0026amp;theme=2920d5ecda04d88f90eeaa00\u0026amp;signature=72e28cd91212de56d0a55af8df71b1e93014e166799a2dc4ba85ff9887f86950\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/videodb/m2QHSzY3st6NzBBu/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"VideoDB Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ec601c\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.videodb.io/pages/build-with-agents/director/setup-director\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/pages/build-with-agents/director/setup-director.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.videodb.io/#organization\",\"name\":\"VideoDB Documentation\",\"url\":\"https://docs.videodb.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/videodb/GgiJu8HrYcTvfnRD/logo/light.svg?fit=max\u0026auto=format\u0026n=GgiJu8HrYcTvfnRD\u0026q=85\u0026s=613ed1f657ca517349000e89cf435607\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.videodb.io#website\",\"name\":\"VideoDB Documentation\",\"url\":\"https://docs.videodb.io\",\"publisher\":{\"@id\":\"https://docs.videodb.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.videodb.io/pages/build-with-agents/director/setup-director#webpage\",\"url\":\"https://docs.videodb.io/pages/build-with-agents/director/setup-director\",\"name\":\"Setup Director\",\"description\":\"Install and configure the Director framework locally to build custom video agents and workflows for your applications.\",\"dateModified\":\"2026-07-02T19:56:00.856Z\",\"isPartOf\":{\"@id\":\"https://docs.videodb.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.videodb.io/pages/build-with-agents/director/setup-director#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.videodb.io/pages/build-with-agents/director/setup-director#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Open Source Frameworks\",\"item\":\"https://docs.videodb.io/pages/community/open-source/llamaindex-retriever\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Director Framework\",\"item\":\"https://docs.videodb.io/pages/build-with-agents/director\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Setup Director\",\"item\":\"https://docs.videodb.io/pages/build-with-agents/director/setup-director\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.videodb.io/pages/build-with-agents/director/setup-director#article\",\"headline\":\"Setup Director\",\"name\":\"Setup Director\",\"description\":\"Install and configure the Director framework locally to build custom video agents and workflows for your applications.\",\"url\":\"https://docs.videodb.io/pages/build-with-agents/director/setup-director\",\"mainEntityOfPage\":{\"@id\":\"https://docs.videodb.io/pages/build-with-agents/director/setup-director#webpage\"},\"dateModified\":\"2026-07-02T19:56:00.856Z\",\"keywords\":\"director-local-setup, self-hosted, github-deployment, local-installation\",\"publisher\":{\"@id\":\"https://docs.videodb.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.videodb.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"VideoDB Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"VideoDB Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/pages/build-with-agents/director/setup-director.md","siteName":"VideoDB Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","groups":[{"group":"Start Here","pages":[{"title":"Welcome to VideoDB","icon":"door-open","href":""},{"title":"Quickstart","icon":"rocket","href":"/pages/getting-started/quickstart"},{"group":"SDK Installation","icon":"arrow-down-to-bracket","pages":[{"title":"Python SDK","icon":"code","href":"/pages/getting-started/python"},{"title":"Node.js SDK","icon":"code","href":"/pages/getting-started/node"},{"title":"Node.js SDK Migration","sidebarTitle":"Node.js SDK v0.2.0 Migration","icon":"code","href":"/pages/getting-started/node-migration"}]},{"title":"AI Agent Skills","icon":"robot","href":"/pages/getting-started/agent-skills"},{"title":"Core Concepts in 5 Minutes","icon":"lightbulb","href":"/pages/getting-started/core-concepts-in-5-min"}]},{"group":"Core Concepts","pages":[{"title":"Core Concepts Overview","icon":"book-open","href":"/pages/core-concepts/overview"},{"title":"Data Model","icon":"database","href":"/pages/core-concepts/data-model"},{"title":"Indexes \u0026 Search","icon":"search","href":"/pages/core-concepts/indexes-and-search"},{"title":"Supported Languages","icon":"languages","href":"/pages/core-concepts/supported-languages"},{"title":"Sandbox Compute","icon":"cpu","href":"/pages/core-concepts/sandbox-compute"},{"title":"Sandbox Models","icon":"brain-circuit","href":"/pages/core-concepts/sandbox-models"},{"title":"Events \u0026 Real-time","icon":"zap","href":"/pages/core-concepts/events-and-realtime"},{"title":"Programmable Editing","icon":"film","href":"/pages/core-concepts/programmable-editing"},{"title":"Security \u0026 Privacy","icon":"lock","href":"/pages/core-concepts/security-privacy"}]},{"group":"Ingest","pages":[{"group":"Files and Collections","pages":[{"title":"Upload Video","icon":"upload","href":"/pages/ingest/files-and-collections/upload-video"},{"title":"Create Collection","icon":"folder-plus","href":"/pages/ingest/files-and-collections/create-collection"},{"title":"Collection Patterns","icon":"folders","href":"/pages/ingest/files-and-collections/collection-patterns"}]},{"group":"Live Streams","pages":[{"title":"RTSP Ingest","icon":"signal","href":"/pages/ingest/live-streams/rtsp-ingest"},{"title":"Understand \u0026 Index RTStreams","icon":"eye","href":"/pages/ingest/live-streams/rtstream-understand-index"},{"title":"Real-time APIs","icon":"radio","href":"/pages/ingest/live-streams/realtime-apis"},{"title":"Stream Lifecycle","icon":"activity","href":"/pages/ingest/live-streams/stream-lifecycle"}]},{"group":"Capture SDKs","pages":[{"title":"Capture SDK Overview","icon":"camera","href":"/pages/ingest/capture-sdks/overview"},{"title":"Real-time Context","icon":"clock","href":"/pages/ingest/capture-sdks/realtime-context"},{"title":"Storage \u0026 Search","icon":"hard-drive","href":"/pages/ingest/capture-sdks/storage-and-search"},{"title":"Privacy Controls","icon":"shield","href":"/pages/ingest/capture-sdks/privacy-controls"}]},{"group":"Transcoding","pages":[{"title":"When to Transcode","icon":"settings","href":"/pages/ingest/transcoding/when-to-transcode"},{"title":"Output Formats","icon":"file-output","href":"/pages/ingest/transcoding/output-formats"}]}]},{"group":"Understand","pages":[{"group":"Understanding \u0026 Indexing Pipelines","pages":[{"group":"Understanding","icon":"eye","pages":[{"title":"Understanding Artifacts","icon":"boxes","href":"/pages/understand/indexing-pipelines/understanding-artifacts"},{"title":"Analyzer Outputs","icon":"braces","href":"/pages/understand/indexing-pipelines/analyzer-outputs"}]},{"group":"Indexing","icon":"database","pages":[{"title":"Create an Index","icon":"layers","href":"/pages/understand/indexing-pipelines/create-an-index"},{"title":"Index Fields","icon":"copy","href":"/pages/understand/indexing-pipelines/multiple-indexes"},{"title":"View Indexes","icon":"list","href":"/pages/understand/indexing-pipelines/view-indexes"}]}]},{"group":"Search and Retrieval","pages":[{"title":"Search and Retrieval","icon":"search","href":"/pages/understand/search-and-retrieval/natural-language-query"},{"title":"Intelligent Search","icon":"wand-magic-sparkles","href":"/pages/understand/search-and-retrieval/intelligent-search"},{"title":"Results, Evidence, and Returned Fields","icon":"clock","href":"/pages/understand/search-and-retrieval/timestamps-clips-streams"},{"title":"Search Patterns and Results","icon":"folder-search","href":"/pages/understand/search-and-retrieval/collection-search"}]},{"group":"Legacy Indexing \u0026 Search","pages":[{"title":"Indexes \u0026 Search","icon":"search","href":"/pages/understand/legacy-indexing-search/indexes-and-search"},{"title":"Create an Index","icon":"layers","href":"/pages/understand/legacy-indexing-search/create-an-index"},{"title":"Frame Processing Primitives","icon":"eye","href":"/pages/understand/legacy-indexing-search/multimodal-indexing"},{"title":"Multiple Indexes","icon":"copy","href":"/pages/understand/legacy-indexing-search/multiple-indexes"},{"title":"Natural Language Query","icon":"search","href":"/pages/understand/legacy-indexing-search/natural-language-query"},{"title":"Timestamps, Clips, Streams","icon":"clock","href":"/pages/understand/legacy-indexing-search/timestamps-clips-streams"},{"title":"Collection Search","icon":"folder-search","href":"/pages/understand/legacy-indexing-search/collection-search"}]},{"group":"Quality and Evaluation","pages":[{"title":"Accuracy Tips","icon":"check","href":"/pages/understand/quality-and-evaluation/accuracy-tips"},{"title":"Latency and Cost","icon":"gauge","href":"/pages/understand/quality-and-evaluation/latency-and-cost"}]}]},{"group":"Act","pages":[{"group":"Programmable Editing","pages":[{"title":"Timeline Architecture","icon":"film","href":"/pages/act/programmable-editing/timeline-architecture"},{"title":"Track Layering","icon":"layers","href":"/pages/act/programmable-editing/track-layering"},{"title":"Audio Asset Layering","icon":"volume-2","href":"/pages/act/programmable-editing/audio-asset-layering"},{"title":"Image Asset","icon":"image","href":"/pages/act/programmable-editing/image-asset"},{"title":"Aspect Ratio Control","icon":"expand","href":"/pages/act/programmable-editing/aspect-ratio-control"},{"title":"Trimming Vs Timing","icon":"scissors","href":"/pages/act/programmable-editing/trimming-vs-timing"},{"title":"Clip Parameters","icon":"settings","href":"/pages/act/programmable-editing/clip-parameters"},{"title":"Filters and Transitions","icon":"wand","href":"/pages/act/programmable-editing/filters-and-transitions"},{"title":"Caption Asset","icon":"captions","href":"/pages/act/programmable-editing/caption-asset"},{"title":"Text Asset","icon":"type","href":"/pages/act/programmable-editing/text-asset"}]},{"group":"Live Action","pages":[{"title":"Event Detection Patterns","icon":"zap","href":"/pages/act/live-action/event-detection-patterns"},{"title":"Alerts and Callbacks","icon":"bell","href":"/pages/act/live-action/alerts-and-callbacks"},{"title":"Webhooks and Reliability","icon":"webhook","href":"/pages/act/live-action/webhooks-and-reliability"}]},{"group":"Generative Media","pages":[{"title":"Generative Media Overview","icon":"wand","href":"/pages/act/generative-media/index"},{"title":"Translation and Dubbing","icon":"languages","href":"/pages/act/generative-media/translation-and-dubbing"}]},{"group":"Output and Delivery","pages":[{"title":"Streams and Exports","icon":"download","href":"/pages/act/output-and-delivery/streams-and-exports"},{"title":"Publishing Patterns","icon":"share","href":"/pages/act/output-and-delivery/publishing-patterns"}]}]},{"group":"Automate","pages":[{"title":"Integrations Overview","icon":"workflow","href":"/pages/automate/integrations-overview"},{"group":"n8n Workflows","pages":[{"title":"n8n Workflows","icon":"workflow","href":"/pages/automate/n8n/index"},{"title":"Meeting Intelligence Workflow","icon":"dot","href":"/pages/automate/n8n/n8n-workflow-meeting-intelligence"},{"title":"Meeting Summaries Workflow","icon":"dot","href":"/pages/automate/n8n/n8n-workflow-meeting-summaries"},{"title":"Video Dubbing Workflow","icon":"dot","href":"/pages/automate/n8n/n8n-workflow-dubbing"},{"title":"Subtitle Generation Workflow","icon":"dot","href":"/pages/automate/n8n/n8n-workflow-subtitle-generation"},{"title":"YouTube to Notion Workflow","icon":"dot","href":"/pages/automate/n8n/n8n-workflow-youtube-notion"},{"title":"HubSpot CRM Sync Workflow","icon":"dot","href":"/pages/automate/n8n/n8n-workflow-hubspot-crm"},{"title":"Interview Evaluation Workflow","icon":"dot","href":"/pages/automate/n8n/n8n-workflow-interview-evaluation"}]},{"group":"Zapier Workflows","pages":[{"title":"Zapier Workflows","icon":"zap","href":"/pages/automate/zapier/index"},{"title":"YouTube Summaries to Notion","icon":"dot","href":"/pages/automate/zapier/zapier-workflow-youtube-summaries"},{"title":"Video Highlights to Notion","icon":"dot","href":"/pages/automate/zapier/zapier-workflow-video-highlights"},{"title":"Subtitle Generation","icon":"dot","href":"/pages/automate/zapier/zapier-workflow-subtitle-generation"},{"title":"Video Dubbing to Google Drive","icon":"dot","href":"/pages/automate/zapier/zapier-workflow-dubbing-drive"},{"title":"Profanity Detection to Slack","icon":"dot","href":"/pages/automate/zapier/zapier-workflow-profanity-detection"},{"title":"GenAI Video to YouTube","icon":"dot","href":"/pages/automate/zapier/zapier-workflow-notion-to-youtube"},{"title":"Video Q\u0026A Support","icon":"dot","href":"/pages/automate/zapier/zapier-workflow-video-qa"}]}]},{"group":"MCP Server","pages":[{"title":"MCP Server","icon":"server","href":"/pages/mcp/index"},{"title":"Connect the MCP Server","icon":"plug","href":"/pages/mcp/connect"},{"title":"MCP Tools Reference","icon":"wrench","href":"/pages/mcp/tools"},{"title":"MCP Workflows","icon":"route","href":"/pages/mcp/workflows"},{"title":"MCP Authentication and Privacy","icon":"shield-check","href":"/pages/mcp/auth-and-privacy"},{"title":"Local MCP Server (Director)","icon":"terminal","href":"/pages/mcp/local-server"}]},{"group":"Open Source Frameworks","pages":[{"title":"LlamaIndex Retriever","icon":"github","href":"/pages/community/open-source/llamaindex-retriever"},{"group":"Director Framework","pages":[{"title":"Director Framework","description":"Director is your agentic framework for video tasks - think of it as ChatGPT for videos.","icon":"wand","href":"/pages/build-with-agents/director/index"},{"title":"Setup Director","icon":"settings","href":"/pages/build-with-agents/director/setup-director"},{"title":"Create Custom Agent","description":"Learn how to design, develop, and integrate custom agents into the Director framework with best practices for architecture, communication, and error handling.","icon":"plus","href":"/pages/build-with-agents/director/create-custom-agent"}]}]}]},{"tab":"Examples \u0026 Tutorials","pages":[{"title":"Examples \u0026 Tutorials","href":"/examples-and-tutorials"}]},{"tab":"Research Lab","href":"https://labs.videodb.io"},{"tab":"Community \u0026 Resources","pages":[{"title":"Community \u0026 Resources","href":"/pages/community/about-us"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]}]},"basePath":"","title":"Setup Director - VideoDB Documentation","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":[],"chunks":[]}