[{"data":1,"prerenderedAt":695},["ShallowReactive",2],{"navigation":3,"\u002Fdocs\u002Fgetting-started\u002Finstallation":81,"\u002Fdocs\u002Fgetting-started\u002Finstallation-surround":690},[4,77],{"title":5,"_path":6,"children":7,"icon":76},"Docs","\u002Fdocs",[8,23,41,51,63,69],{"title":9,"_path":10,"children":11},"Getting Started","\u002Fdocs\u002Fgetting-started",[12,14,17,20],{"title":13,"_path":10},"Introduction to Datafuse",{"title":15,"_path":16},"Installation Guide","\u002Fdocs\u002Fgetting-started\u002Finstallation",{"title":18,"_path":19},"5-Minute Quickstart","\u002Fdocs\u002Fgetting-started\u002Fquickstart",{"title":21,"_path":22},"5-Minute Quickstart with curl","\u002Fdocs\u002Fgetting-started\u002Fcurl",{"title":24,"_path":25,"children":26},"Core Concepts","\u002Fdocs\u002Fcore-concepts",[27,29,32,35,38],{"title":28,"_path":25},"Conceptual Landscape",{"title":30,"_path":31},"Adding Custom Integrations","\u002Fdocs\u002Fcore-concepts\u002Fcustom-integrations",{"title":33,"_path":34},"Managed Authentication","\u002Fdocs\u002Fcore-concepts\u002Fauthentication",{"title":36,"_path":37},"Bi-Directional Triggers","\u002Fdocs\u002Fcore-concepts\u002Ftriggers",{"title":39,"_path":40},"Observability & Auditing","\u002Fdocs\u002Fcore-concepts\u002Fobservability",{"title":42,"_path":43,"children":44},"Model Context Protocol","\u002Fdocs\u002Fmcp",[45,48],{"title":46,"_path":47},"Introduction to MCP","\u002Fdocs\u002Fmcp\u002Fintroduction",{"title":49,"_path":50},"Operating MCP Servers","\u002Fdocs\u002Fmcp\u002Fmcp-servers",{"title":52,"_path":53,"children":54},"Client SDKs","\u002Fdocs\u002Fsdks",[55,57,60],{"title":56,"_path":53},"Client Overview",{"title":58,"_path":59},"Python Client Guide","\u002Fdocs\u002Fsdks\u002Fpython",{"title":61,"_path":62},"TypeScript Client Guide","\u002Fdocs\u002Fsdks\u002Ftypescript",{"title":64,"_path":65,"children":66},"Self-Hosting & VPC","\u002Fdocs\u002Fself-hosting",[67],{"title":68,"_path":65},"Self-Hosting Guide",{"title":70,"_path":71,"children":72},"Comparisons","\u002Fdocs\u002Fcomparisons",[73],{"title":74,"_path":75},"Datafuse vs. Composio","\u002Fdocs\u002Fcomparisons\u002Fcomposio","i-heroicons-book-open",{"title":78,"_path":79,"icon":80},"Pricing","\u002Fpricing","i-heroicons-credit-card",{"_path":16,"_dir":82,"_draft":83,"_partial":83,"_locale":84,"title":15,"description":85,"body":86,"_type":684,"_id":685,"_source":686,"_file":687,"_stem":688,"_extension":689},"getting-started",false,"","Set up your environment and install the Datafuse unified SDKs for Python and TypeScript.",{"type":87,"children":88,"toc":670},"root",[89,97,101,108,113,158,161,167,196,203,235,241,246,274,280,285,321,324,330,335,340,345,443,448,453,485,488,494,499,512,566,596,599,605,610,664],{"type":90,"tag":91,"props":92,"children":93},"element","p",{},[94],{"type":95,"value":96},"text","Connecting your application to the Datafuse Active Integration network requires installing our lightweight client SDK. Datafuse provides first-class support for both Node.js\u002FTypeScript and Python environments.",{"type":90,"tag":98,"props":99,"children":100},"hr",{},[],{"type":90,"tag":102,"props":103,"children":105},"h2",{"id":104},"prerequisites",[106],{"type":95,"value":107},"Prerequisites",{"type":90,"tag":91,"props":109,"children":110},{},[111],{"type":95,"value":112},"Before installing the SDK, ensure you have:",{"type":90,"tag":114,"props":115,"children":116},"ul",{},[117,123,153],{"type":90,"tag":118,"props":119,"children":120},"li",{},[121],{"type":95,"value":122},"A Datafuse developer account.",{"type":90,"tag":118,"props":124,"children":125},{},[126,128,134,136,143,145,151],{"type":95,"value":127},"An active ",{"type":90,"tag":129,"props":130,"children":131},"strong",{},[132],{"type":95,"value":133},"API Key",{"type":95,"value":135}," (e.g. ",{"type":90,"tag":137,"props":138,"children":140},"code",{"className":139},[],[141],{"type":95,"value":142},"df_live_...",{"type":95,"value":144}," or ",{"type":90,"tag":137,"props":146,"children":148},{"className":147},[],[149],{"type":95,"value":150},"df_test_...",{"type":95,"value":152},"), which you can fetch from your developer dashboard.",{"type":90,"tag":118,"props":154,"children":155},{},[156],{"type":95,"value":157},"Node.js (version 18 or higher) or Python (version 3.8 or higher) installed in your workspace.",{"type":90,"tag":98,"props":159,"children":160},{},[],{"type":90,"tag":102,"props":162,"children":164},{"id":163},"_1-python-sdk-installation",[165],{"type":95,"value":166},"1. Python SDK Installation",{"type":90,"tag":91,"props":168,"children":169},{},[170,172,178,180,186,188,194],{"type":95,"value":171},"For Python-based AI agent setups (supporting LangChain, LlamaIndex, CrewAI, AutoGen, and custom LLM loops), install our unified SDK via ",{"type":90,"tag":137,"props":173,"children":175},{"className":174},[],[176],{"type":95,"value":177},"pip",{"type":95,"value":179},", ",{"type":90,"tag":137,"props":181,"children":183},{"className":182},[],[184],{"type":95,"value":185},"poetry",{"type":95,"value":187},", or ",{"type":90,"tag":137,"props":189,"children":191},{"className":190},[],[192],{"type":95,"value":193},"uv",{"type":95,"value":195},".",{"type":90,"tag":197,"props":198,"children":200},"h3",{"id":199},"core-package",[201],{"type":95,"value":202},"Core Package",{"type":90,"tag":204,"props":205,"children":209},"pre",{"className":206,"code":207,"language":208,"meta":84,"style":84},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","pip install datafuse\n","bash",[210],{"type":90,"tag":137,"props":211,"children":212},{"__ignoreMap":84},[213],{"type":90,"tag":214,"props":215,"children":218},"span",{"class":216,"line":217},"line",1,[219,224,230],{"type":90,"tag":214,"props":220,"children":222},{"style":221},"--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B",[223],{"type":95,"value":177},{"type":90,"tag":214,"props":225,"children":227},{"style":226},"--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D",[228],{"type":95,"value":229}," install",{"type":90,"tag":214,"props":231,"children":232},{"style":226},[233],{"type":95,"value":234}," datafuse\n",{"type":90,"tag":197,"props":236,"children":238},{"id":237},"from-local-source-for-developers",[239],{"type":95,"value":240},"From Local Source (For Developers)",{"type":90,"tag":91,"props":242,"children":243},{},[244],{"type":95,"value":245},"If you are developing locally inside the Datafuse monorepo and want to link the development SDK directly:",{"type":90,"tag":204,"props":247,"children":249},{"className":206,"code":248,"language":208,"meta":84,"style":84},"pip install -e sdks\u002Fpython\n",[250],{"type":90,"tag":137,"props":251,"children":252},{"__ignoreMap":84},[253],{"type":90,"tag":214,"props":254,"children":255},{"class":216,"line":217},[256,260,264,269],{"type":90,"tag":214,"props":257,"children":258},{"style":221},[259],{"type":95,"value":177},{"type":90,"tag":214,"props":261,"children":262},{"style":226},[263],{"type":95,"value":229},{"type":90,"tag":214,"props":265,"children":266},{"style":226},[267],{"type":95,"value":268}," -e",{"type":90,"tag":214,"props":270,"children":271},{"style":226},[272],{"type":95,"value":273}," sdks\u002Fpython\n",{"type":90,"tag":197,"props":275,"children":277},{"id":276},"quick-verification",[278],{"type":95,"value":279},"Quick Verification",{"type":90,"tag":91,"props":281,"children":282},{},[283],{"type":95,"value":284},"Verify that the Python client can be imported without errors:",{"type":90,"tag":204,"props":286,"children":288},{"className":206,"code":287,"language":208,"meta":84,"style":84},"python -c \"import datafuse; print('Python SDK successfully installed!')\"\n",[289],{"type":90,"tag":137,"props":290,"children":291},{"__ignoreMap":84},[292],{"type":90,"tag":214,"props":293,"children":294},{"class":216,"line":217},[295,300,305,311,316],{"type":90,"tag":214,"props":296,"children":297},{"style":221},[298],{"type":95,"value":299},"python",{"type":90,"tag":214,"props":301,"children":302},{"style":226},[303],{"type":95,"value":304}," -c",{"type":90,"tag":214,"props":306,"children":308},{"style":307},"--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF",[309],{"type":95,"value":310}," \"",{"type":90,"tag":214,"props":312,"children":313},{"style":226},[314],{"type":95,"value":315},"import datafuse; print('Python SDK successfully installed!')",{"type":90,"tag":214,"props":317,"children":318},{"style":307},[319],{"type":95,"value":320},"\"\n",{"type":90,"tag":98,"props":322,"children":323},{},[],{"type":90,"tag":102,"props":325,"children":327},{"id":326},"_2-typescript-sdk-installation",[328],{"type":95,"value":329},"2. TypeScript SDK Installation",{"type":90,"tag":91,"props":331,"children":332},{},[333],{"type":95,"value":334},"For Node.js, Next.js, Cloudflare Workers, or Vercel AI SDK setups, install the TypeScript client package.",{"type":90,"tag":197,"props":336,"children":338},{"id":337},"core-package-1",[339],{"type":95,"value":202},{"type":90,"tag":91,"props":341,"children":342},{},[343],{"type":95,"value":344},"Install the client using your preferred JS package manager:",{"type":90,"tag":346,"props":347,"children":348},"code-group",{},[349,373,397,420],{"type":90,"tag":204,"props":350,"children":353},{"className":206,"code":351,"filename":352,"language":208,"meta":84,"style":84},"npm install @datafuse\u002Fsdk\n","npm",[354],{"type":90,"tag":137,"props":355,"children":356},{"__ignoreMap":84},[357],{"type":90,"tag":214,"props":358,"children":359},{"class":216,"line":217},[360,364,368],{"type":90,"tag":214,"props":361,"children":362},{"style":221},[363],{"type":95,"value":352},{"type":90,"tag":214,"props":365,"children":366},{"style":226},[367],{"type":95,"value":229},{"type":90,"tag":214,"props":369,"children":370},{"style":226},[371],{"type":95,"value":372}," @datafuse\u002Fsdk\n",{"type":90,"tag":204,"props":374,"children":377},{"className":206,"code":375,"filename":376,"language":208,"meta":84,"style":84},"pnpm add @datafuse\u002Fsdk\n","pnpm",[378],{"type":90,"tag":137,"props":379,"children":380},{"__ignoreMap":84},[381],{"type":90,"tag":214,"props":382,"children":383},{"class":216,"line":217},[384,388,393],{"type":90,"tag":214,"props":385,"children":386},{"style":221},[387],{"type":95,"value":376},{"type":90,"tag":214,"props":389,"children":390},{"style":226},[391],{"type":95,"value":392}," add",{"type":90,"tag":214,"props":394,"children":395},{"style":226},[396],{"type":95,"value":372},{"type":90,"tag":204,"props":398,"children":401},{"className":206,"code":399,"filename":400,"language":208,"meta":84,"style":84},"yarn add @datafuse\u002Fsdk\n","yarn",[402],{"type":90,"tag":137,"props":403,"children":404},{"__ignoreMap":84},[405],{"type":90,"tag":214,"props":406,"children":407},{"class":216,"line":217},[408,412,416],{"type":90,"tag":214,"props":409,"children":410},{"style":221},[411],{"type":95,"value":400},{"type":90,"tag":214,"props":413,"children":414},{"style":226},[415],{"type":95,"value":392},{"type":90,"tag":214,"props":417,"children":418},{"style":226},[419],{"type":95,"value":372},{"type":90,"tag":204,"props":421,"children":424},{"className":206,"code":422,"filename":423,"language":208,"meta":84,"style":84},"bun add @datafuse\u002Fsdk\n","bun",[425],{"type":90,"tag":137,"props":426,"children":427},{"__ignoreMap":84},[428],{"type":90,"tag":214,"props":429,"children":430},{"class":216,"line":217},[431,435,439],{"type":90,"tag":214,"props":432,"children":433},{"style":221},[434],{"type":95,"value":423},{"type":90,"tag":214,"props":436,"children":437},{"style":226},[438],{"type":95,"value":392},{"type":90,"tag":214,"props":440,"children":441},{"style":226},[442],{"type":95,"value":372},{"type":90,"tag":197,"props":444,"children":446},{"id":445},"quick-verification-1",[447],{"type":95,"value":279},{"type":90,"tag":91,"props":449,"children":450},{},[451],{"type":95,"value":452},"Check that the JS\u002FTS dependency has successfully registered in your workspace:",{"type":90,"tag":204,"props":454,"children":456},{"className":206,"code":455,"language":208,"meta":84,"style":84},"node -e \"const { Datafuse } = require('@datafuse\u002Fsdk'); console.log('TypeScript SDK successfully installed!');\"\n",[457],{"type":90,"tag":137,"props":458,"children":459},{"__ignoreMap":84},[460],{"type":90,"tag":214,"props":461,"children":462},{"class":216,"line":217},[463,468,472,476,481],{"type":90,"tag":214,"props":464,"children":465},{"style":221},[466],{"type":95,"value":467},"node",{"type":90,"tag":214,"props":469,"children":470},{"style":226},[471],{"type":95,"value":268},{"type":90,"tag":214,"props":473,"children":474},{"style":307},[475],{"type":95,"value":310},{"type":90,"tag":214,"props":477,"children":478},{"style":226},[479],{"type":95,"value":480},"const { Datafuse } = require('@datafuse\u002Fsdk'); console.log('TypeScript SDK successfully installed!');",{"type":90,"tag":214,"props":482,"children":483},{"style":307},[484],{"type":95,"value":320},{"type":90,"tag":98,"props":486,"children":487},{},[],{"type":90,"tag":102,"props":489,"children":491},{"id":490},"environment-configuration",[492],{"type":95,"value":493},"Environment Configuration",{"type":90,"tag":91,"props":495,"children":496},{},[497],{"type":95,"value":498},"Datafuse clients automatically look for standard environment variables to initialize credentials, keeping your secrets out of source control.",{"type":90,"tag":91,"props":500,"children":501},{},[502,504,510],{"type":95,"value":503},"Configure the following variables in your local ",{"type":90,"tag":137,"props":505,"children":507},{"className":506},[],[508],{"type":95,"value":509},".env",{"type":95,"value":511}," file:",{"type":90,"tag":204,"props":513,"children":517},{"className":514,"code":515,"language":516,"meta":84,"style":84},"language-env shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","# Primary API Key from your Datafuse developer console\nDATAFUSE_API_KEY=df_live_your_secret_key_here\n\n# Base API Server Endpoint (defaults to https:\u002F\u002Fapi.datafuse.xyz)\nDATAFUSE_API_URL=https:\u002F\u002Fapi.datafuse.xyz\n","env",[518],{"type":90,"tag":137,"props":519,"children":520},{"__ignoreMap":84},[521,529,538,548,557],{"type":90,"tag":214,"props":522,"children":523},{"class":216,"line":217},[524],{"type":90,"tag":214,"props":525,"children":526},{},[527],{"type":95,"value":528},"# Primary API Key from your Datafuse developer console\n",{"type":90,"tag":214,"props":530,"children":532},{"class":216,"line":531},2,[533],{"type":90,"tag":214,"props":534,"children":535},{},[536],{"type":95,"value":537},"DATAFUSE_API_KEY=df_live_your_secret_key_here\n",{"type":90,"tag":214,"props":539,"children":541},{"class":216,"line":540},3,[542],{"type":90,"tag":214,"props":543,"children":545},{"emptyLinePlaceholder":544},true,[546],{"type":95,"value":547},"\n",{"type":90,"tag":214,"props":549,"children":551},{"class":216,"line":550},4,[552],{"type":90,"tag":214,"props":553,"children":554},{},[555],{"type":95,"value":556},"# Base API Server Endpoint (defaults to https:\u002F\u002Fapi.datafuse.xyz)\n",{"type":90,"tag":214,"props":558,"children":560},{"class":216,"line":559},5,[561],{"type":90,"tag":214,"props":562,"children":563},{},[564],{"type":95,"value":565},"DATAFUSE_API_URL=https:\u002F\u002Fapi.datafuse.xyz\n",{"type":90,"tag":567,"props":568,"children":569},"blockquote",{},[570],{"type":90,"tag":91,"props":571,"children":572},{},[573,578,580,586,588,594],{"type":90,"tag":214,"props":574,"children":575},{},[576],{"type":95,"value":577},"!TIP",{"type":95,"value":579},"\nIf you are running Datafuse inside a private self-hosted VPC, change ",{"type":90,"tag":137,"props":581,"children":583},{"className":582},[],[584],{"type":95,"value":585},"DATAFUSE_API_URL",{"type":95,"value":587}," to point to your secure internal load balancer (e.g. ",{"type":90,"tag":137,"props":589,"children":591},{"className":590},[],[592],{"type":95,"value":593},"http:\u002F\u002Fdatafuse-gateway.internal",{"type":95,"value":595},").",{"type":90,"tag":98,"props":597,"children":598},{},[],{"type":90,"tag":102,"props":600,"children":602},{"id":601},"next-steps",[603],{"type":95,"value":604},"Next Steps",{"type":90,"tag":91,"props":606,"children":607},{},[608],{"type":95,"value":609},"Now that the SDK is successfully installed:",{"type":90,"tag":114,"props":611,"children":612},{},[613,628,641],{"type":90,"tag":118,"props":614,"children":615},{},[616,618,626],{"type":95,"value":617},"Follow the ",{"type":90,"tag":129,"props":619,"children":620},{},[621],{"type":90,"tag":622,"props":623,"children":624},"a",{"href":19},[625],{"type":95,"value":18},{"type":95,"value":627}," to list integrations, resolve tools, and invoke a tool.",{"type":90,"tag":118,"props":629,"children":630},{},[631,633,640],{"type":95,"value":632},"Prefer the terminal? Use the ",{"type":90,"tag":129,"props":634,"children":635},{},[636],{"type":90,"tag":622,"props":637,"children":638},{"href":22},[639],{"type":95,"value":21},{"type":95,"value":195},{"type":90,"tag":118,"props":642,"children":643},{},[644,646,654,655,663],{"type":95,"value":645},"Explore our ",{"type":90,"tag":129,"props":647,"children":648},{},[649],{"type":90,"tag":622,"props":650,"children":651},{"href":62},[652],{"type":95,"value":653},"TypeScript client guide",{"type":95,"value":144},{"type":90,"tag":129,"props":656,"children":657},{},[658],{"type":90,"tag":622,"props":659,"children":660},{"href":59},[661],{"type":95,"value":662},"Python client guide",{"type":95,"value":195},{"type":90,"tag":665,"props":666,"children":667},"style",{},[668],{"type":95,"value":669},"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);}",{"title":84,"searchDepth":531,"depth":531,"links":671},[672,673,678,682,683],{"id":104,"depth":531,"text":107},{"id":163,"depth":531,"text":166,"children":674},[675,676,677],{"id":199,"depth":540,"text":202},{"id":237,"depth":540,"text":240},{"id":276,"depth":540,"text":279},{"id":326,"depth":531,"text":329,"children":679},[680,681],{"id":337,"depth":540,"text":202},{"id":445,"depth":540,"text":279},{"id":490,"depth":531,"text":493},{"id":601,"depth":531,"text":604},"markdown","content:1.docs:1.getting-started:2.installation.md","content","1.docs\u002F1.getting-started\u002F2.installation.md","1.docs\u002F1.getting-started\u002F2.installation","md",[691,693],{"_path":10,"title":13,"description":692},"The active integration studio and secure tool-routing middleware for AI agents.",{"_path":19,"title":18,"description":694},"Use the v1 integration API from Python or TypeScript to resolve tools and invoke them.",1780069615245]