Get an API key, make your first call, and find the endpoints for your app type
Every app you publish in Dify doubles as a REST API, and so do your knowledge bases. You call the same app your end users interact with, from your own backend, with an API key.
Call the API from your backend only. A key embedded in frontend code or a client app can be extracted and abused.
For an app, create an API key from inside the app itself. The key is scoped to that one app, and one key serves all your end users.
Your calls tell people apart with a per-person user value. See End User Identity for details.
For knowledge bases, go to Knowledge and click Service API in the top-right corner.A knowledge API key is broader: it can reach every knowledge base visible to the account that created the key, so treat it with extra care. See Knowledge API for details.
Every request carries the key as a Bearer token. The base URL is your deployment’s API endpoint, such as https://api.example.com/v1; you can copy it from the app’s API access page.The fastest first call needs no code: open Get App Info, click Try it, paste your key into the Authorization field, and press Send. It works for every app type.The same call from a terminal:
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Dify Enterprise Docs","colors":{"primary":"#0060FF","light":"#688FE8","dark":"#0034FF"},"logo":{"light":"https://assets-docs.dify.ai/2025/05/d05cfc6ebe48f725d171dc71c64a5d16.svg","dark":"https://assets-docs.dify.ai/2025/05/c51f1cda47c1d9a4a162d7736f6e4c53.svg"},"favicon":"https://mintcdn.com/dify-enterprise-docs/zvhvyUvEpyoIONBf/logo/dify-logo.png?fit=max\u0026auto=format\u0026n=zvhvyUvEpyoIONBf\u0026q=85\u0026s=e0afd8349b7a272ad12280680a53043c","navbar":{"links":[{"href":"mailto:support@dify.ai","label":"Support"}]},"footer":{"socials":{"x":"https://x.com/dify_ai","github":"https://github.com/langgenius/dify","linkedin":"https://www.linkedin.com/company/langgenius"}},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"en/3.13.x/deploy/checklist"},{"language":"zh","href":"zh/3.13.x/deploy/checklist"},{"language":"ja","href":"ja/3.13.x/deploy/checklist"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"dify-enterprise-docs","hasAudioNarration":false,"actualSubdomain":"dify-enterprise-docs","customDomains":["enterprise-docs.dify.ai"],"gitSource":{"type":"github","owner":"langgenius","repo":"dify-enterprise-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"b23b91b8-bf61-4fb0-bbf3-d55d66c55095","liveDeploymentHistoryId":"6ae4489fc0a5d590d24bfa62","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4489fc0a5d590d24bfa62"},"entitlements":{},"buildId":"6ae4489fc0a5d590d24bfa62","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"en","tag":"Developer Resources","count":1947},{"language":"ja","tag":"開発者リソース","count":1947},{"language":"zh","tag":"开发者资源","count":1947},{"language":"en","tag":"Use","count":1401},{"language":"ja","tag":"使い方","count":1401},{"language":"zh","tag":"使用","count":1401},{"language":"en","tag":"Workspace API","count":1353},{"language":"ja","tag":"Workspace API","count":1353},{"language":"zh","tag":"Workspace API","count":1353},{"language":"en","tag":"Knowledge APIs","count":639},{"language":"ja","tag":"ナレッジ API","count":639},{"language":"zh","tag":"知识库 API","count":639},{"language":"en","tag":"Orchestrate","count":620},{"language":"ja","tag":"オーケストレーション","count":620},{"language":"zh","tag":"编排","count":620},{"language":"en","tag":"App APIs","count":545},{"language":"ja","tag":"アプリ API","count":545},{"language":"zh","tag":"应用 API","count":545},{"language":"en","tag":"Workflow \u0026 Chatflow","count":533},{"language":"ja","tag":"ワークフローとチャットフロー","count":533},{"language":"zh","tag":"工作流与对话流","count":533},{"language":"en","tag":"Deploy","count":530},{"language":"ja","tag":"デプロイ","count":530},{"language":"zh","tag":"部署","count":530},{"language":"en","tag":"Plugins","count":524},{"language":"ja","tag":"プラグイン開発","count":522},{"language":"zh","tag":"插件开发","count":522},{"language":"ja","tag":"管理","count":470},{"language":"zh","tag":"管理","count":470},{"language":"en","tag":"Administer","count":420}],"searchSettings":{"maxResults":12}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"body{text-autospace:normal}html[data-current-path=\"/\"] .nav-tabs{display:none}"}],"page":{"pagePath":"en/3.12.x/develop/api/guides/get-started","slug":"/en/3.12.x/develop/api/guides/get-started","pageMetadata":{"title":"Get Started with the Dify API","sidebarTitle":"Get Started","description":"Get an API key, make your first call, and find the endpoints for your app type","href":"/en/3.12.x/develop/api/guides/get-started"},"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: \"Get an API key, make your first call, and find the endpoints for your app type\"\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,Heading,Info,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Every app you publish in Dify doubles as a REST API, and so do your knowledge bases. You call the same app your end users interact with, from your own backend, with an API key.`}),`\n`,_jsx(Heading,{level:`2`,id:`get-an-api-key`,children:`Get an API Key`}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Call the API from your backend only. A key embedded in frontend code or a client app can be extracted and abused.`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`\n`,_jsx(_components.p,{children:`For an app, create an API key from inside the app itself. The key is scoped to that one app, and one key serves all your end users.`}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[`Your calls tell people apart with a per-person `,_jsx(_components.code,{children:`user`}),` value. See `,_jsx(_components.a,{href:`/en/3.12.x/develop/api/guides/end-user-identity`,children:`End User Identity`}),` for details.`]})}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsxs(_components.p,{children:[`For knowledge bases, go to `,_jsx(_components.strong,{children:`Knowledge`}),` and click `,_jsx(_components.strong,{children:`Service API`}),` in the top-right corner.`]}),`\n`,_jsxs(_components.p,{children:[`A knowledge API key is broader: it can reach every knowledge base visible to the account that created the key, so treat it with extra care. See `,_jsx(_components.a,{href:`/en/3.12.x/develop/api/guides/knowledge`,children:`Knowledge API`}),` for details.`]}),`\n`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`make-your-first-call`,children:`Make Your First Call`}),`\n`,_jsxs(_components.p,{children:[`Every request carries the key as a Bearer token. The base URL is your deployment’s API endpoint, such as `,_jsx(_components.code,{children:`https://api.example.com/v1`}),`; you can copy it from the app’s API access page.`]}),`\n`,_jsxs(_components.p,{children:[`The fastest first call needs no code: open `,_jsx(_components.a,{href:`/en/3.12.x/develop/api/applications/get-app-info`,children:`Get App Info`}),`, click `,_jsx(_components.strong,{children:`Try it`}),`, paste your key into the `,_jsx(_components.strong,{children:`Authorization`}),` field, and press `,_jsx(_components.strong,{children:`Send`}),`. It works for every app type.`]}),`\n`,_jsx(_components.p,{children:`The same call from a terminal:`}),`\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:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.example.com/v1/info`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$DIFY_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`A response like this confirms the key works and shows which app it belongs to:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`json`,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:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`7`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"My Chat App\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"A helpful assistant\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"tags\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"assistant\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"mode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"chat\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"author_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Dify Team\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Using a knowledge API key? Its endpoints are a separate family: start with `,_jsx(_components.a,{href:`/en/3.12.x/develop/api/knowledge-bases/list-knowledge-bases`,children:`List Knowledge Bases`}),` instead.`]}),`\n`,_jsx(Heading,{level:`2`,id:`find-your-app-type’s-endpoints`,children:`Find Your App Type’s Endpoints`}),`\n`,_jsx(_components.p,{children:`See each app type’s own overview page for its full API surface:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/en/3.12.x/develop/api/guides/chatflow`,children:`Chatflow`}),` (`,_jsx(_components.code,{children:`advanced-chat`}),`)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/en/3.12.x/develop/api/guides/workflow`,children:`Workflow`}),` (`,_jsx(_components.code,{children:`workflow`}),`)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/en/3.12.x/develop/api/guides/agent`,children:`New Agent`}),` (`,_jsx(_components.code,{children:`agent`}),`)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/en/3.12.x/develop/api/guides/chat`,children:`Chatbot and Agent`}),` (`,_jsx(_components.code,{children:`chat`}),`, `,_jsx(_components.code,{children:`agent-chat`}),`)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/en/3.12.x/develop/api/guides/completion`,children:`Text Generator`}),` (`,_jsx(_components.code,{children:`completion`}),`)`]}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/en/3.12.x/develop/api/guides/knowledge`,children:`Knowledge`})}),`\n`]})]})}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":"Get Started with the Dify API","sidebarTitle":"Get Started","description":"Get an API key, make your first call, and find the endpoints for your app type","href":"/en/3.12.x/develop/api/guides/get-started"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Get an API Key","slug":"get-an-api-key","depth":2,"children":[]},{"title":"Make Your First Call","slug":"make-your-first-call","depth":2,"children":[]},{"title":"Find Your App Type’s Endpoints","slug":"find-your-app-type’s-endpoints","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"dify-enterprise-docs","siteName":"Dify Enterprise Docs","title":"Get Started with the Dify API - Dify Enterprise Docs","navMaps":{"firstHrefInVersion":{"3.13.x":{"href":"/en/3.13.x/develop/api/guides/get-started","matchLevel":1},"3.12.x":{"href":"/en/3.12.x/develop/api/guides/get-started","matchLevel":0},"3.11.x":{"href":"/en/3.11.x/develop/api/guides/get-started","matchLevel":1},"3.10.x":{"href":"/en/3.10.x/develop/api/guides/get-started","matchLevel":1},"3.9.x":{"href":"/en/3.9.x/develop/api/guides/get-started","matchLevel":1},"3.8.x":{"href":"/en/3.8.x/develop/api/guides/get-started","matchLevel":1},"3.7.x":{"href":"/en/3.7.x/develop/api/guides/get-started","matchLevel":1},"3.6.x":{"href":"/en/3.6.x/develop/api/guides/get-started","matchLevel":1},"3.5.x":{"href":"/en/3.5.x/develop/api/guides/get-started","matchLevel":1},"3.4.x":{"href":"/en/3.4.x/develop/api/guides/get-started","matchLevel":1},"3.3.x":{"href":"/en/3.3.x/develop/api/guides/get-started","matchLevel":1},"3.2.x":{"href":"/en/3.2.x/develop/api/guides/get-started","matchLevel":1},"3.1.x":{"href":"/en/3.1.x/develop/api/guides/get-started","matchLevel":1},"3.0.x":{"href":"/en/3.0.x/develop/api/guides/get-started","matchLevel":1},"2.8.x":{"href":"/en/2.8.x/develop/api/guides/get-started","matchLevel":1},"2.7.x":{"href":"/en/2.7.x/develop/api/guides/get-started","matchLevel":1},"2.6.x":{"href":"/en/2.6.x/develop/api/guides/get-started","matchLevel":1},"2.5.x":{"href":"/en/2.5.x/develop/api/guides/get-started","matchLevel":1}},"firstHrefInLanguage":{"en":{"href":"/en/3.12.x/develop/api/guides/get-started","matchLevel":0},"zh":{"href":"/zh/3.12.x/develop/api/guides/get-started","matchLevel":1},"ja":{"href":"/ja/3.12.x/develop/api/guides/get-started","matchLevel":1}}},"lastModified":"2026-08-21T02:12:04.046Z","originalFileLocation":"en/3.12.x/develop/api/guides/get-started.mdx","locale":"en"},"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=\"Get an API key, make your first call, and find the endpoints for your app type\">\u003cmeta data-mint-head name=\"application-name\" content=\"Dify Enterprise Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dify-enterprise-docs/0-RXGeruZhgwpkgZ/_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/dify-enterprise-docs/0-RXGeruZhgwpkgZ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dify-enterprise-docs/0-RXGeruZhgwpkgZ/_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/dify-enterprise-docs/0-RXGeruZhgwpkgZ/_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/dify-enterprise-docs/0-RXGeruZhgwpkgZ/_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/dify-enterprise-docs/0-RXGeruZhgwpkgZ/_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/dify-enterprise-docs/0-RXGeruZhgwpkgZ/_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/dify-enterprise-docs/0-RXGeruZhgwpkgZ/_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/dify-enterprise-docs/0-RXGeruZhgwpkgZ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Started with the Dify API - Dify Enterprise Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get an API key, make your first call, and find the endpoints for your app type\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Dify Enterprise Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://enterprise-docs.dify.ai/en/3.12.x/develop/api/guides/get-started\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://dify-enterprise-docs.mintlify.app/_mintlify/api/og/v2?division=Guides\u0026amp;title=Get+Started+with+the+Dify+API\u0026amp;description=Get+an+API+key%2C+make+your+first+call%2C+and+find+the+endpoints+for+your+app+type\u0026amp;theme=fc270d2c96587e5833522f0e\u0026amp;signature=f114b9eca63e321fa2b5a8ce7729040ae50261b0d3163b94bcff77ac1af9d418\">\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=\"Get Started with the Dify API - Dify Enterprise Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get an API key, make your first call, and find the endpoints for your app type\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dify-enterprise-docs.mintlify.app/_mintlify/api/og/v2?division=Guides\u0026amp;title=Get+Started+with+the+Dify+API\u0026amp;description=Get+an+API+key%2C+make+your+first+call%2C+and+find+the+endpoints+for+your+app+type\u0026amp;theme=fc270d2c96587e5833522f0e\u0026amp;signature=f114b9eca63e321fa2b5a8ce7729040ae50261b0d3163b94bcff77ac1af9d418\">\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/dify-enterprise-docs/0-RXGeruZhgwpkgZ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Dify Enterprise Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0060FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://enterprise-docs.dify.ai/en/3.12.x/develop/api/guides/get-started\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/3.12.x/develop/api/guides/get-started.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://enterprise-docs.dify.ai/en/3.12.x/develop/api/guides/get-started\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://enterprise-docs.dify.ai/zh/3.12.x/develop/api/guides/get-started\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ja\" href=\"https://enterprise-docs.dify.ai/ja/3.12.x/develop/api/guides/get-started\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://enterprise-docs.dify.ai/en/3.12.x/develop/api/guides/get-started\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://enterprise-docs.dify.ai/#organization\",\"name\":\"Dify Enterprise Docs\",\"url\":\"https://enterprise-docs.dify.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://assets-docs.dify.ai/2025/05/d05cfc6ebe48f725d171dc71c64a5d16.svg\"}},{\"@type\":\"WebSite\",\"@id\":\"https://enterprise-docs.dify.ai#website\",\"name\":\"Dify Enterprise Docs\",\"url\":\"https://enterprise-docs.dify.ai\",\"publisher\":{\"@id\":\"https://enterprise-docs.dify.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://enterprise-docs.dify.ai/en/3.12.x/develop/api/guides/get-started#webpage\",\"url\":\"https://enterprise-docs.dify.ai/en/3.12.x/develop/api/guides/get-started\",\"name\":\"Get Started with the Dify API\",\"description\":\"Get an API key, make your first call, and find the endpoints for your app type\",\"dateModified\":\"2026-08-21T02:12:04.046Z\",\"isPartOf\":{\"@id\":\"https://enterprise-docs.dify.ai#website\"},\"breadcrumb\":{\"@id\":\"https://enterprise-docs.dify.ai/en/3.12.x/develop/api/guides/get-started#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://enterprise-docs.dify.ai/en/3.12.x/develop/api/guides/get-started#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Dify Enterprise Docs\",\"item\":\"https://enterprise-docs.dify.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Started with the Dify API\",\"item\":\"https://enterprise-docs.dify.ai/en/3.12.x/develop/api/guides/get-started\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://enterprise-docs.dify.ai/en/3.12.x/develop/api/guides/get-started#article\",\"headline\":\"Get Started with the Dify API\",\"name\":\"Get Started with the Dify API\",\"description\":\"Get an API key, make your first call, and find the endpoints for your app type\",\"url\":\"https://enterprise-docs.dify.ai/en/3.12.x/develop/api/guides/get-started\",\"mainEntityOfPage\":{\"@id\":\"https://enterprise-docs.dify.ai/en/3.12.x/develop/api/guides/get-started#webpage\"},\"dateModified\":\"2026-08-21T02:12:04.046Z\",\"publisher\":{\"@id\":\"https://enterprise-docs.dify.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://enterprise-docs.dify.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Dify Enterprise Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Dify Enterprise Docs","nav":{"global":null,"languages":[{"language":"en","default":true,"versions":[{"version":"3.13.x","tag":"LTS","pages":[{"title":"3.13.x","href":"/en/3.13.x/develop/api/guides/get-started"}]},{"version":"3.12.x","tabs":[{"tab":"Deploy","pages":[{"title":"Deploy","href":"/en/3.12.x/deploy/checklist"}]},{"tab":"Administer","pages":[{"title":"Administer","href":"/en/3.12.x/administer/workspace-management"}]},{"tab":"Use","pages":[{"title":"Use","href":"/en/3.12.x/use/build/workflow-chatflow"}]},{"tab":"Developer Resources","menu":[{"item":"Workspace API","groups":[{"group":"Guides","icon":"book-open","pages":[{"title":"Get Started with the Dify API","sidebarTitle":"Get Started","href":"/en/3.12.x/develop/api/guides/get-started"},{"group":"API Overviews","expanded":true,"pages":[{"title":"Chatflow App API","sidebarTitle":"Chatflow","description":"API for Chatflow apps, covering chat messages, workflow-level streaming, conversation management, and Human Input pauses","href":"/en/3.12.x/develop/api/guides/chatflow"},{"title":"Workflow App API","sidebarTitle":"Workflow","href":"/en/3.12.x/develop/api/guides/workflow"},{"title":"New Agent API","sidebarTitle":"New Agent","tag":"Beta","href":"/en/3.12.x/develop/api/guides/agent"},{"title":"Knowledge API","sidebarTitle":"Knowledge","href":"/en/3.12.x/develop/api/guides/knowledge"},{"title":"Chat App API","sidebarTitle":"Chatbot and Agent","href":"/en/3.12.x/develop/api/guides/chat"},{"title":"Completion App API","sidebarTitle":"Text Generator","href":"/en/3.12.x/develop/api/guides/completion"}]},{"title":"Consume Streaming Responses","sidebarTitle":"SSE Streaming","href":"/en/3.12.x/develop/api/guides/streaming"},{"title":"Human Input API Integration Flow","sidebarTitle":"Human Input Flow","href":"/en/3.12.x/develop/api/guides/human-input-flow"},{"title":"End User Identity","sidebarTitle":"End User Identity","href":"/en/3.12.x/develop/api/guides/end-user-identity"},{"title":"Handle Errors and Rate Limits","sidebarTitle":"Errors \u0026 Rate Limits","href":"/en/3.12.x/develop/api/guides/errors"}]},{"group":"App APIs","icon":"code","pages":[{"group":"Chat Messages","pages":[{"title":"Send Chat Message","deprecated":null,"version":null,"sidebarTitle":"Send Chat Message","openapi":"/en/3.12.x/develop/api/openapi_service.json post /chat-messages","href":"/en/3.12.x/develop/api/chat-messages/send-chat-message"},{"title":"Stop Chat Message Generation","deprecated":null,"version":null,"sidebarTitle":"Stop Chat Message Generation","openapi":"/en/3.12.x/develop/api/openapi_service.json post /chat-messages/{task_id}/stop","href":"/en/3.12.x/develop/api/chat-messages/stop-chat-message-generation"},{"title":"Get Next Suggested Questions","deprecated":null,"version":null,"sidebarTitle":"Get Next Suggested Questions","openapi":"/en/3.12.x/develop/api/openapi_service.json get /messages/{message_id}/suggested","href":"/en/3.12.x/develop/api/chat-messages/get-next-suggested-questions"}]},{"group":"Completion Messages","pages":[{"title":"Send Completion Message","deprecated":null,"version":null,"sidebarTitle":"Send Completion Message","openapi":"/en/3.12.x/develop/api/openapi_service.json post /completion-messages","href":"/en/3.12.x/develop/api/completion-messages/send-completion-message"},{"title":"Stop Completion Message Generation","deprecated":null,"version":null,"sidebarTitle":"Stop Completion Message Generation","openapi":"/en/3.12.x/develop/api/openapi_service.json post /completion-messages/{task_id}/stop","href":"/en/3.12.x/develop/api/completion-messages/stop-completion-message-generation"}]},{"group":"Workflow Runs","pages":[{"title":"Run Workflow","deprecated":null,"version":null,"sidebarTitle":"Run Workflow","openapi":"/en/3.12.x/develop/api/openapi_service.json post /workflows/run","href":"/en/3.12.x/develop/api/workflow-runs/run-workflow"},{"title":"Run Workflow by ID","deprecated":null,"version":null,"sidebarTitle":"Run Workflow by ID","openapi":"/en/3.12.x/develop/api/openapi_service.json post /workflows/{workflow_id}/run","href":"/en/3.12.x/develop/api/workflow-runs/run-workflow-by-id"},{"title":"Stop Workflow Task","deprecated":null,"version":null,"sidebarTitle":"Stop Workflow Task","openapi":"/en/3.12.x/develop/api/openapi_service.json post /workflows/tasks/{task_id}/stop","href":"/en/3.12.x/develop/api/workflow-runs/stop-workflow-task"},{"title":"Get Workflow Run Detail","deprecated":null,"version":null,"sidebarTitle":"Get Workflow Run Detail","openapi":"/en/3.12.x/develop/api/openapi_service.json get /workflows/run/{workflow_run_id}","href":"/en/3.12.x/develop/api/workflow-runs/get-workflow-run-detail"},{"title":"List Workflow Logs","deprecated":null,"version":null,"sidebarTitle":"List Workflow Logs","openapi":"/en/3.12.x/develop/api/openapi_service.json get /workflows/logs","href":"/en/3.12.x/develop/api/workflow-runs/list-workflow-logs"},{"title":"Stream Workflow Events","deprecated":null,"version":null,"sidebarTitle":"Stream Workflow Events","openapi":"/en/3.12.x/develop/api/openapi_service.json get /workflow/{workflow_run_id}/events","href":"/en/3.12.x/develop/api/workflow-runs/stream-workflow-events"}]},{"group":"Conversations","pages":[{"title":"List Conversations","deprecated":null,"version":null,"sidebarTitle":"List Conversations","openapi":"/en/3.12.x/develop/api/openapi_service.json get /conversations","href":"/en/3.12.x/develop/api/conversations/list-conversations"},{"title":"List Conversation Messages","deprecated":null,"version":null,"sidebarTitle":"List Conversation Messages","openapi":"/en/3.12.x/develop/api/openapi_service.json get /messages","href":"/en/3.12.x/develop/api/conversations/list-conversation-messages"},{"title":"List Conversation Variables","deprecated":null,"version":null,"sidebarTitle":"List Conversation Variables","openapi":"/en/3.12.x/develop/api/openapi_service.json get /conversations/{conversation_id}/variables","href":"/en/3.12.x/develop/api/conversations/list-conversation-variables"},{"title":"Rename Conversation","deprecated":null,"version":null,"sidebarTitle":"Rename Conversation","openapi":"/en/3.12.x/develop/api/openapi_service.json post /conversations/{conversation_id}/name","href":"/en/3.12.x/develop/api/conversations/rename-conversation"},{"title":"Update Conversation Variable","deprecated":null,"version":null,"sidebarTitle":"Update Conversation Variable","openapi":"/en/3.12.x/develop/api/openapi_service.json put /conversations/{conversation_id}/variables/{variable_id}","href":"/en/3.12.x/develop/api/conversations/update-conversation-variable"},{"title":"Delete Conversation","deprecated":null,"version":null,"sidebarTitle":"Delete Conversation","openapi":"/en/3.12.x/develop/api/openapi_service.json delete /conversations/{conversation_id}","href":"/en/3.12.x/develop/api/conversations/delete-conversation"}]},{"group":"Files","pages":[{"title":"Upload File","deprecated":null,"version":null,"sidebarTitle":"Upload File","openapi":"/en/3.12.x/develop/api/openapi_service.json post /files/upload","href":"/en/3.12.x/develop/api/files/upload-file"},{"title":"Download File","deprecated":null,"version":null,"sidebarTitle":"Download File","openapi":"/en/3.12.x/develop/api/openapi_service.json get /files/{file_id}/preview","href":"/en/3.12.x/develop/api/files/download-file"}]},{"group":"Audio","pages":[{"title":"Convert Audio to Text","deprecated":null,"version":null,"sidebarTitle":"Convert Audio to Text","openapi":"/en/3.12.x/develop/api/openapi_service.json post /audio-to-text","href":"/en/3.12.x/develop/api/audio/convert-audio-to-text"},{"title":"Convert Text to Audio","deprecated":null,"version":null,"sidebarTitle":"Convert Text to Audio","openapi":"/en/3.12.x/develop/api/openapi_service.json post /text-to-audio","href":"/en/3.12.x/develop/api/audio/convert-text-to-audio"}]},{"group":"Applications","pages":[{"title":"Get App Info","deprecated":null,"version":null,"sidebarTitle":"Get App Info","openapi":"/en/3.12.x/develop/api/openapi_service.json get /info","href":"/en/3.12.x/develop/api/applications/get-app-info"},{"title":"Get App Parameters","deprecated":null,"version":null,"sidebarTitle":"Get App Parameters","openapi":"/en/3.12.x/develop/api/openapi_service.json get /parameters","href":"/en/3.12.x/develop/api/applications/get-app-parameters"},{"title":"Get App Meta","deprecated":null,"version":null,"sidebarTitle":"Get App Meta","openapi":"/en/3.12.x/develop/api/openapi_service.json get /meta","href":"/en/3.12.x/develop/api/applications/get-app-meta"},{"title":"Get App WebApp Settings","deprecated":null,"version":null,"sidebarTitle":"Get App WebApp Settings","openapi":"/en/3.12.x/develop/api/openapi_service.json get /site","href":"/en/3.12.x/develop/api/applications/get-app-webapp-settings"}]},{"group":"Feedback","pages":[{"title":"Submit Message Feedback","deprecated":null,"version":null,"sidebarTitle":"Submit Message Feedback","openapi":"/en/3.12.x/develop/api/openapi_service.json post /messages/{message_id}/feedbacks","href":"/en/3.12.x/develop/api/feedback/submit-message-feedback"},{"title":"List App Feedbacks","deprecated":null,"version":null,"sidebarTitle":"List App Feedbacks","openapi":"/en/3.12.x/develop/api/openapi_service.json get /app/feedbacks","href":"/en/3.12.x/develop/api/feedback/list-app-feedbacks"}]},{"group":"Annotations","pages":[{"title":"Create Annotation","deprecated":null,"version":null,"sidebarTitle":"Create Annotation","openapi":"/en/3.12.x/develop/api/openapi_service.json post /apps/annotations","href":"/en/3.12.x/develop/api/annotations/create-annotation"},{"title":"List Annotations","deprecated":null,"version":null,"sidebarTitle":"List Annotations","openapi":"/en/3.12.x/develop/api/openapi_service.json get /apps/annotations","href":"/en/3.12.x/develop/api/annotations/list-annotations"},{"title":"Update Annotation","deprecated":null,"version":null,"sidebarTitle":"Update Annotation","openapi":"/en/3.12.x/develop/api/openapi_service.json put /apps/annotations/{annotation_id}","href":"/en/3.12.x/develop/api/annotations/update-annotation"},{"title":"Delete Annotation","deprecated":null,"version":null,"sidebarTitle":"Delete Annotation","openapi":"/en/3.12.x/develop/api/openapi_service.json delete /apps/annotations/{annotation_id}","href":"/en/3.12.x/develop/api/annotations/delete-annotation"},{"title":"Configure Annotation Reply","deprecated":null,"version":null,"sidebarTitle":"Configure Annotation Reply","openapi":"/en/3.12.x/develop/api/openapi_service.json post /apps/annotation-reply/{action}","href":"/en/3.12.x/develop/api/annotations/configure-annotation-reply"},{"title":"Get Annotation Reply Job Status","deprecated":null,"version":null,"sidebarTitle":"Get Annotation Reply Job Status","openapi":"/en/3.12.x/develop/api/openapi_service.json get /apps/annotation-reply/{action}/status/{job_id}","href":"/en/3.12.x/develop/api/annotations/get-annotation-reply-job-status"}]},{"group":"End Users","pages":[{"title":"Get End User Info","deprecated":null,"version":null,"sidebarTitle":"Get End User Info","openapi":"/en/3.12.x/develop/api/openapi_service.json get /end-users/{end_user_id}","href":"/en/3.12.x/develop/api/end-users/get-end-user-info"}]},{"group":"Human Input","pages":[{"title":"Get Human Input Form","deprecated":null,"version":null,"sidebarTitle":"Get Human Input Form","openapi":"/en/3.12.x/develop/api/openapi_service.json get /form/human_input/{form_token}","href":"/en/3.12.x/develop/api/human-input/get-human-input-form"},{"title":"Submit Human Input Form","deprecated":null,"version":null,"sidebarTitle":"Submit Human Input Form","openapi":"/en/3.12.x/develop/api/openapi_service.json post /form/human_input/{form_token}","href":"/en/3.12.x/develop/api/human-input/submit-human-input-form"}]}]},{"group":"Knowledge APIs","icon":"database","pages":[{"group":"Knowledge Bases","pages":[{"title":"Create an Empty Knowledge Base","deprecated":null,"version":null,"sidebarTitle":"Create an Empty Knowledge Base","openapi":"/en/3.12.x/develop/api/openapi_service.json post /datasets","href":"/en/3.12.x/develop/api/knowledge-bases/create-an-empty-knowledge-base"},{"title":"List Knowledge Bases","deprecated":null,"version":null,"sidebarTitle":"List Knowledge Bases","openapi":"/en/3.12.x/develop/api/openapi_service.json get /datasets","href":"/en/3.12.x/develop/api/knowledge-bases/list-knowledge-bases"},{"title":"Get Knowledge Base","deprecated":null,"version":null,"sidebarTitle":"Get Knowledge Base","openapi":"/en/3.12.x/develop/api/openapi_service.json get /datasets/{dataset_id}","href":"/en/3.12.x/develop/api/knowledge-bases/get-knowledge-base"},{"title":"Update Knowledge Base","deprecated":null,"version":null,"sidebarTitle":"Update Knowledge Base","openapi":"/en/3.12.x/develop/api/openapi_service.json patch /datasets/{dataset_id}","href":"/en/3.12.x/develop/api/knowledge-bases/update-knowledge-base"},{"title":"Delete Knowledge Base","deprecated":null,"version":null,"sidebarTitle":"Delete Knowledge Base","openapi":"/en/3.12.x/develop/api/openapi_service.json delete /datasets/{dataset_id}","href":"/en/3.12.x/develop/api/knowledge-bases/delete-knowledge-base"},{"title":"Retrieve Chunks from a Knowledge Base / Test Retrieval","deprecated":null,"version":null,"sidebarTitle":"Retrieve Chunks from a Knowledge Base / Test Retrieval","openapi":"/en/3.12.x/develop/api/openapi_service.json post /datasets/{dataset_id}/retrieve","href":"/en/3.12.x/develop/api/knowledge-bases/retrieve-chunks-from-a-knowledge-base-test-retrieval"}]},{"group":"Documents","pages":[{"title":"Create Document by Text","deprecated":null,"version":null,"sidebarTitle":"Create Document by Text","openapi":"/en/3.12.x/develop/api/openapi_service.json post /datasets/{dataset_id}/document/create-by-text","href":"/en/3.12.x/develop/api/documents/create-document-by-text"},{"title":"Create Document by File","deprecated":null,"version":null,"sidebarTitle":"Create Document by File","openapi":"/en/3.12.x/develop/api/openapi_service.json post /datasets/{dataset_id}/document/create-by-file","href":"/en/3.12.x/develop/api/documents/create-document-by-file"},{"title":"List Documents","deprecated":null,"version":null,"sidebarTitle":"List Documents","openapi":"/en/3.12.x/develop/api/openapi_service.json get /datasets/{dataset_id}/documents","href":"/en/3.12.x/develop/api/documents/list-documents"},{"title":"Get Document","deprecated":null,"version":null,"sidebarTitle":"Get Document","openapi":"/en/3.12.x/develop/api/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}","href":"/en/3.12.x/develop/api/documents/get-document"},{"title":"Delete Document","deprecated":null,"version":null,"sidebarTitle":"Delete Document","openapi":"/en/3.12.x/develop/api/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}","href":"/en/3.12.x/develop/api/documents/delete-document"},{"title":"Update Document","deprecated":null,"version":null,"sidebarTitle":"Update Document","openapi":"/en/3.12.x/develop/api/openapi_service.json patch /datasets/{dataset_id}/documents/{document_id}","href":"/en/3.12.x/develop/api/documents/update-document"},{"title":"Download Document","deprecated":null,"version":null,"sidebarTitle":"Download Document","openapi":"/en/3.12.x/develop/api/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/download","href":"/en/3.12.x/develop/api/documents/download-document"},{"title":"Get Document Indexing Status","deprecated":null,"version":null,"sidebarTitle":"Get Document Indexing Status","openapi":"/en/3.12.x/develop/api/openapi_service.json get /datasets/{dataset_id}/documents/{batch}/indexing-status","href":"/en/3.12.x/develop/api/documents/get-document-indexing-status"},{"title":"Update Document by Text","deprecated":null,"version":null,"sidebarTitle":"Update Document by Text","openapi":"/en/3.12.x/develop/api/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/update-by-text","href":"/en/3.12.x/develop/api/documents/update-document-by-text"},{"title":"Update Document by File","deprecated":true,"version":null,"sidebarTitle":"Update Document by File","openapi":"/en/3.12.x/develop/api/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/update-by-file","href":"/en/3.12.x/develop/api/documents/update-document-by-file"},{"title":"Download Documents as ZIP","deprecated":null,"version":null,"sidebarTitle":"Download Documents as ZIP","openapi":"/en/3.12.x/develop/api/openapi_service.json post /datasets/{dataset_id}/documents/download-zip","href":"/en/3.12.x/develop/api/documents/download-documents-as-zip"},{"title":"Update Document Status in Batch","deprecated":null,"version":null,"sidebarTitle":"Update Document Status in Batch","openapi":"/en/3.12.x/develop/api/openapi_service.json patch /datasets/{dataset_id}/documents/status/{action}","href":"/en/3.12.x/develop/api/documents/update-document-status-in-batch"}]},{"group":"Chunks","pages":[{"title":"Create Chunks","deprecated":null,"version":null,"sidebarTitle":"Create Chunks","openapi":"/en/3.12.x/develop/api/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments","href":"/en/3.12.x/develop/api/chunks/create-chunks"},{"title":"List Chunks","deprecated":null,"version":null,"sidebarTitle":"List Chunks","openapi":"/en/3.12.x/develop/api/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments","href":"/en/3.12.x/develop/api/chunks/list-chunks"},{"title":"Get Chunk","deprecated":null,"version":null,"sidebarTitle":"Get Chunk","openapi":"/en/3.12.x/develop/api/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/en/3.12.x/develop/api/chunks/get-chunk"},{"title":"Update Chunk","deprecated":null,"version":null,"sidebarTitle":"Update Chunk","openapi":"/en/3.12.x/develop/api/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/en/3.12.x/develop/api/chunks/update-chunk"},{"title":"Delete Chunk","deprecated":null,"version":null,"sidebarTitle":"Delete Chunk","openapi":"/en/3.12.x/develop/api/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/en/3.12.x/develop/api/chunks/delete-chunk"},{"title":"Create Child Chunk","deprecated":null,"version":null,"sidebarTitle":"Create Child Chunk","openapi":"/en/3.12.x/develop/api/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks","href":"/en/3.12.x/develop/api/chunks/create-child-chunk"},{"title":"List Child Chunks","deprecated":null,"version":null,"sidebarTitle":"List Child Chunks","openapi":"/en/3.12.x/develop/api/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks","href":"/en/3.12.x/develop/api/chunks/list-child-chunks"},{"title":"Update Child Chunk","deprecated":null,"version":null,"sidebarTitle":"Update Child Chunk","openapi":"/en/3.12.x/develop/api/openapi_service.json patch /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}","href":"/en/3.12.x/develop/api/chunks/update-child-chunk"},{"title":"Delete Child Chunk","deprecated":null,"version":null,"sidebarTitle":"Delete Child Chunk","openapi":"/en/3.12.x/develop/api/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}","href":"/en/3.12.x/develop/api/chunks/delete-child-chunk"}]},{"group":"Metadata","pages":[{"title":"Create Metadata Field","deprecated":null,"version":null,"sidebarTitle":"Create Metadata Field","openapi":"/en/3.12.x/develop/api/openapi_service.json post /datasets/{dataset_id}/metadata","href":"/en/3.12.x/develop/api/metadata/create-metadata-field"},{"title":"List Metadata Fields","deprecated":null,"version":null,"sidebarTitle":"List Metadata Fields","openapi":"/en/3.12.x/develop/api/openapi_service.json get /datasets/{dataset_id}/metadata","href":"/en/3.12.x/develop/api/metadata/list-metadata-fields"},{"title":"Update Metadata Field","deprecated":null,"version":null,"sidebarTitle":"Update Metadata Field","openapi":"/en/3.12.x/develop/api/openapi_service.json patch /datasets/{dataset_id}/metadata/{metadata_id}","href":"/en/3.12.x/develop/api/metadata/update-metadata-field"},{"title":"Delete Metadata Field","deprecated":null,"version":null,"sidebarTitle":"Delete Metadata Field","openapi":"/en/3.12.x/develop/api/openapi_service.json delete /datasets/{dataset_id}/metadata/{metadata_id}","href":"/en/3.12.x/develop/api/metadata/delete-metadata-field"},{"title":"Get Built-in Metadata Fields","deprecated":null,"version":null,"sidebarTitle":"Get Built-in Metadata Fields","openapi":"/en/3.12.x/develop/api/openapi_service.json get /datasets/{dataset_id}/metadata/built-in","href":"/en/3.12.x/develop/api/metadata/get-built-in-metadata-fields"},{"title":"Update Built-in Metadata Field","deprecated":null,"version":null,"sidebarTitle":"Update Built-in Metadata Field","openapi":"/en/3.12.x/develop/api/openapi_service.json post /datasets/{dataset_id}/metadata/built-in/{action}","href":"/en/3.12.x/develop/api/metadata/update-built-in-metadata-field"},{"title":"Update Document Metadata in Batch","deprecated":null,"version":null,"sidebarTitle":"Update Document Metadata in Batch","openapi":"/en/3.12.x/develop/api/openapi_service.json post /datasets/{dataset_id}/documents/metadata","href":"/en/3.12.x/develop/api/metadata/update-document-metadata-in-batch"}]},{"group":"Tags","pages":[{"title":"Create Knowledge Tag","deprecated":null,"version":null,"sidebarTitle":"Create Knowledge Tag","openapi":"/en/3.12.x/develop/api/openapi_service.json post /datasets/tags","href":"/en/3.12.x/develop/api/tags/create-knowledge-tag"},{"title":"List Knowledge Tags","deprecated":null,"version":null,"sidebarTitle":"List Knowledge Tags","openapi":"/en/3.12.x/develop/api/openapi_service.json get /datasets/tags","href":"/en/3.12.x/develop/api/tags/list-knowledge-tags"},{"title":"Update Knowledge Tag","deprecated":null,"version":null,"sidebarTitle":"Update Knowledge Tag","openapi":"/en/3.12.x/develop/api/openapi_service.json patch /datasets/tags","href":"/en/3.12.x/develop/api/tags/update-knowledge-tag"},{"title":"Delete Knowledge Tag","deprecated":null,"version":null,"sidebarTitle":"Delete Knowledge Tag","openapi":"/en/3.12.x/develop/api/openapi_service.json delete /datasets/tags","href":"/en/3.12.x/develop/api/tags/delete-knowledge-tag"},{"title":"Create Tag Binding","deprecated":null,"version":null,"sidebarTitle":"Create Tag Binding","openapi":"/en/3.12.x/develop/api/openapi_service.json post /datasets/tags/binding","href":"/en/3.12.x/develop/api/tags/create-tag-binding"},{"title":"Delete Tag Binding","deprecated":null,"version":null,"sidebarTitle":"Delete Tag Binding","openapi":"/en/3.12.x/develop/api/openapi_service.json post /datasets/tags/unbinding","href":"/en/3.12.x/develop/api/tags/delete-tag-binding"},{"title":"Get Knowledge Base Tags","deprecated":null,"version":null,"sidebarTitle":"Get Knowledge Base Tags","openapi":"/en/3.12.x/develop/api/openapi_service.json get /datasets/{dataset_id}/tags","href":"/en/3.12.x/develop/api/tags/get-knowledge-base-tags"}]},{"group":"Models","pages":[{"title":"Get Available Models","deprecated":null,"version":null,"sidebarTitle":"Get Available Models","openapi":"/en/3.12.x/develop/api/openapi_service.json get /workspaces/current/models/model-types/{model_type}","href":"/en/3.12.x/develop/api/models/get-available-models"}]},{"group":"Knowledge Pipeline","pages":[{"title":"Upload Pipeline File","deprecated":null,"version":null,"sidebarTitle":"Upload Pipeline File","openapi":"/en/3.12.x/develop/api/openapi_service.json post /datasets/pipeline/file-upload","href":"/en/3.12.x/develop/api/knowledge-pipeline/upload-pipeline-file"},{"title":"List Datasource Plugins","deprecated":null,"version":null,"sidebarTitle":"List Datasource Plugins","openapi":"/en/3.12.x/develop/api/openapi_service.json get /datasets/{dataset_id}/pipeline/datasource-plugins","href":"/en/3.12.x/develop/api/knowledge-pipeline/list-datasource-plugins"},{"title":"Run Datasource Node","deprecated":null,"version":null,"sidebarTitle":"Run Datasource Node","openapi":"/en/3.12.x/develop/api/openapi_service.json post /datasets/{dataset_id}/pipeline/datasource/nodes/{node_id}/run","href":"/en/3.12.x/develop/api/knowledge-pipeline/run-datasource-node"},{"title":"Run Pipeline","deprecated":null,"version":null,"sidebarTitle":"Run Pipeline","openapi":"/en/3.12.x/develop/api/openapi_service.json post /datasets/{dataset_id}/pipeline/run","href":"/en/3.12.x/develop/api/knowledge-pipeline/run-pipeline"}]}]}]},{"item":"CLI","pages":[{"title":"CLI","href":"/en/3.12.x/develop/cli/introduction"}]},{"item":"Plugins","pages":[{"title":"Plugins","href":"/en/3.12.x/develop/plugins/getting-started/getting-started-dify-plugin"}]}]}]},{"version":"3.11.x","pages":[{"title":"3.11.x","href":"/en/3.11.x/develop/api/guides/get-started"}]},{"version":"3.10.x","pages":[{"title":"3.10.x","href":"/en/3.10.x/develop/api/guides/get-started"}]},{"version":"3.9.x","tag":"LTS","pages":[{"title":"3.9.x","href":"/en/3.9.x/develop/api/guides/get-started"}]},{"version":"3.8.x","pages":[{"title":"3.8.x","href":"/en/3.8.x/develop/api/guides/get-started"}]},{"version":"3.7.x","pages":[{"title":"3.7.x","href":"/en/3.7.x/develop/api/guides/get-started"}]},{"version":"3.6.x","pages":[{"title":"3.6.x","href":"/en/3.6.x/develop/api/guides/get-started"}]},{"version":"3.5.x","pages":[{"title":"3.5.x","href":"/en/3.5.x/develop/api/guides/get-started"}]},{"version":"3.4.x","pages":[{"title":"3.4.x","href":"/en/3.4.x/develop/api/guides/get-started"}]},{"version":"3.3.x","pages":[{"title":"3.3.x","href":"/en/3.3.x/develop/api/guides/get-started"}]},{"version":"3.2.x","pages":[{"title":"3.2.x","href":"/en/3.2.x/develop/api/guides/get-started"}]},{"version":"3.1.x","pages":[{"title":"3.1.x","href":"/en/3.1.x/develop/api/guides/get-started"}]},{"version":"3.0.x","pages":[{"title":"3.0.x","href":"/en/3.0.x/develop/api/guides/get-started"}]},{"version":"2.8.x","pages":[{"title":"2.8.x","href":"/en/2.8.x/develop/api/guides/get-started"}]},{"version":"2.7.x","pages":[{"title":"2.7.x","href":"/en/2.7.x/develop/api/guides/get-started"}]},{"version":"2.6.x","pages":[{"title":"2.6.x","href":"/en/2.6.x/develop/api/guides/get-started"}]},{"version":"2.5.x","pages":[{"title":"2.5.x","href":"/en/2.5.x/develop/api/guides/get-started"}]}]},{"language":"zh","pages":[{"title":"zh","href":"/zh/3.12.x/develop/api/guides/get-started"}]},{"language":"ja","pages":[{"title":"ja","href":"/ja/3.12.x/develop/api/guides/get-started"}]}]},"basePath":"","title":"Get Started with the Dify API - Dify Enterprise Docs","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":[],"chunks":[]}
