{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"DumplingAI Docs","colors":{"primary":"#000","light":"#fdfdfd","dark":"#000"},"logo":"https://mintcdn.com/dumplingai/ovQfojsBnkaBEyWP/dumplingai-logo.svg?fit=max\u0026auto=format\u0026n=ovQfojsBnkaBEyWP\u0026q=85\u0026s=46740c45e1bef65a42e4a799407a5d32","favicon":"https://mintcdn.com/dumplingai/ovQfojsBnkaBEyWP/dumplingai-logo.svg?fit=max\u0026auto=format\u0026n=ovQfojsBnkaBEyWP\u0026q=85\u0026s=46740c45e1bef65a42e4a799407a5d32","navbar":{"links":[{"href":"mailto:help@dumplingai.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.dumplingai.com"}},"footer":{"socials":{"twitter":"https://twitter.com/dumplingai","linkedin":"https://www.linkedin.com/company/dumplingai"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"dumplingai","hasAudioNarration":false,"actualSubdomain":"dumplingai","customDomains":["docs.dumplingai.com"],"gitSource":{"type":"github","owner":"dumplingai","repo":"dumplingai","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e638b8c65e77d6677ad4","collectionId":"71f4a9e0-7aae-4b61-a7a2-ec8cadaf8568","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e638b8c65e77d6677ad4:success","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Reference","count":52},{"language":"default","tag":"Data APIs","count":23},{"language":"default","tag":"Documentation","count":14},{"language":"default","tag":"Document Processing","count":10},{"language":"default","tag":"Core Features","count":7},{"language":"default","tag":"Start Here","count":6},{"language":"default","tag":"Overview","count":5},{"language":"default","tag":"Web Scraping","count":4},{"language":"default","tag":"Usage APIs","count":3},{"language":"default","tag":"AI","count":2}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"API Reference","description":"Reference for DumplingAI transport APIs.","href":"/api-reference/introduction"},"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: \"Reference for DumplingAI transport APIs.\"\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={code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Heading,Note}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`1`,id:`api-reference`,children:`API Reference`}),`\n`,_jsx(_components.p,{children:`Use the version toggle at the top to switch between the two transport lanes:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`v2`}),` for the capability-first platform and provider endpoints under `,_jsx(_components.code,{children:`/api/v2`})]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`v1`}),` for the existing direct endpoint catalog under `,_jsx(_components.code,{children:`/api/v1`})]}),`\n`]}),`\n`,_jsx(_components.p,{children:`Both lanes can live on the same account and use the same API key for direct API calls.`}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(_components.p,{children:`For direct API requests, include your API key as a Bearer token:`}),`\n`,_jsx(CodeGroup,{children:_jsx(CodeBlock,{filename:`Authorization`,numberOfLines:`2`,language:`text`,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:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Authorization: Bearer YOUR_API_KEY`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`/mcp/v2`}),` is different: it uses OAuth for supported MCP clients instead of requiring you to paste an API key into the client.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,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:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://app.dumplingai.com`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})}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":"API Reference","description":"Reference for DumplingAI transport APIs.","href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"API Reference","slug":"api-reference","depth":1,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Base URL","slug":"base-url","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/dumplingai/88b5ebac9e923e56/featurebase-messenger.js"],"subdomain":"dumplingai","siteName":"DumplingAI Docs","title":"API Reference - DumplingAI Docs","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference/introduction","matchLevel":0},"v1":{"href":"/documentation/v1/get-started","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-03-19T20:43:10.872Z","originalFileLocation":"api-reference/introduction.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=\"Reference for DumplingAI transport APIs.\">\u003cmeta data-mint-head name=\"application-name\" content=\"DumplingAI 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/dumplingai/i_giEhVPqadP-y2_/_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/dumplingai/i_giEhVPqadP-y2_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dumplingai/i_giEhVPqadP-y2_/_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/dumplingai/i_giEhVPqadP-y2_/_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/dumplingai/i_giEhVPqadP-y2_/_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/dumplingai/i_giEhVPqadP-y2_/_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/dumplingai/i_giEhVPqadP-y2_/_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/dumplingai/i_giEhVPqadP-y2_/_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/dumplingai/i_giEhVPqadP-y2_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API Reference - DumplingAI Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Reference for DumplingAI transport APIs.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"DumplingAI Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.dumplingai.com/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://dumplingai.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=API+Reference\u0026amp;description=Reference+for+DumplingAI+transport+APIs.\u0026amp;theme=f6d65ea4c1e9445145f9cff7\u0026amp;signature=4290504494413d0a5fcac1cb052cdf41617f7018bf91de4d4975a04c4e22b6a2\">\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=\"API Reference - DumplingAI Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Reference for DumplingAI transport APIs.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dumplingai.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=API+Reference\u0026amp;description=Reference+for+DumplingAI+transport+APIs.\u0026amp;theme=f6d65ea4c1e9445145f9cff7\u0026amp;signature=4290504494413d0a5fcac1cb052cdf41617f7018bf91de4d4975a04c4e22b6a2\">\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/dumplingai/i_giEhVPqadP-y2_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"DumplingAI Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.dumplingai.com/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"DumplingAI Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"DumplingAI Docs","nav":{"global":null,"versions":[{"version":"v2","tabs":[{"tab":"Documentation","groups":[{"group":"Start Here","pages":[{"title":"Get Started","href":"/documentation/v2/get-started"},{"title":"Migrating from Direct Endpoints","href":"/documentation/v2/migrating-from-direct-endpoints"},{"title":"DumplingAI MCP Server","sidebarTitle":"MCP Server","href":"/mcp-server"},{"title":"Skills + CLI","sidebarTitle":"Skills + CLI","href":"/cli"},{"title":"Unified API","href":"/unified-api-platform"}]}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Unified API","href":"/api-reference/unified-api"},{"title":"API Reference","href":"/api-reference/v2/introduction"},{"title":"Catalog Model","href":"/api-reference/v2/catalog"}]},{"group":"Catalog APIs","pages":[{"title":"Search capabilities, providers, and endpoints","deprecated":null,"version":null,"sidebarTitle":"Search","openapi":"/api-reference/openapi-v2.yaml post /api/v2/search","href":"/api-reference/catalog/search"},{"title":"Get capability, provider, or endpoint details","deprecated":null,"version":null,"sidebarTitle":"Details","openapi":"/api-reference/openapi-v2.yaml post /api/v2/details","href":"/api-reference/catalog/details"}]},{"group":"Execution API","pages":[{"title":"Run a capability or endpoint","deprecated":null,"version":null,"sidebarTitle":"Run","openapi":"/api-reference/openapi-v2.yaml post /api/v2/run","href":"/api-reference/execution/run"}]},{"group":"Usage APIs","pages":[{"title":"Get balance and budget information for the authenticated API key","deprecated":null,"version":null,"sidebarTitle":"Balance","openapi":"/api-reference/openapi-v2.yaml get /api/v2/balance","href":"/api-reference/usage/balance"},{"title":"Get usage and request logs for the authenticated API key","deprecated":null,"version":null,"sidebarTitle":"Requests","openapi":"/api-reference/openapi-v2.yaml get /api/v2/usage","href":"/api-reference/usage/requests"},{"title":"Get credit transactions for the authenticated API key","deprecated":null,"version":null,"sidebarTitle":"Transactions","openapi":"/api-reference/openapi-v2.yaml get /api/v2/transactions","href":"/api-reference/usage/transactions"}]}]}]},{"version":"v1","pages":[{"title":"v1","href":"/documentation/v1/get-started"}]}]},"basePath":"","title":"API Reference - DumplingAI Docs","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":[],"chunks":[]}
