Optional provider override for capability runs only when that capability supports provider selection. For example, screenshot supports firecrawl, scrapingfish, and phantomjscloud, while DumplingAI-managed capabilities such as extract_document use dumplingai.
{"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":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/execution/run","slug":"/api-reference/execution/run","pageMetadata":{"title":"Run a capability or endpoint","description":null,"deprecated":null,"version":null,"sidebarTitle":"Run","openapi":"/api-reference/openapi-v2.yaml post /api/v2/run","href":"/api-reference/execution/run","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Run a capability or endpoint","description":null,"deprecated":null,"version":null,"sidebarTitle":"Run","openapi":"/api-reference/openapi-v2.yaml post /api/v2/run","href":"/api-reference/execution/run","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/dumplingai/88b5ebac9e923e56/featurebase-messenger.js"],"openApiReferenceData":{"operation":{"tags":["Execution"],"summary":"Run a capability or endpoint","x-mint":{"href":"/api-reference/execution/run"},"requestBody":"2ed96920-e45f-4c24-b488-423c249a03e0","responses":{"200":"e33adb69-8386-4f32-8461-b222c496b32a","400":"421a5847-4c0e-4042-b3b9-c0b2ab42e0f7","401":"b622204f-1461-46f7-9c47-cf7cd5dd3cd3","403":"0ff61794-4688-4cef-adae-a4ffa1de1f16","404":"e90a3eab-d47b-4c4a-9438-8c2a31aa9b23"},"method":"post","type":"path","servers":["54897249-17e0-467a-9e6a-d6b03d6256c6"],"security":["cfc76658-341f-485a-a13a-67013e6b4272"],"path":"/api/v2/run","baseUrlOptions":["https://app.dumplingai.com"],"title":"Run a capability or endpoint","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["capability","endpoint"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"Capability id like `search_news` or `extract_document`, or endpoint id like `firecrawl.scrape`.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"input":{"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"input","typeLabel":"object"},"provider":{"type":"string","description":"Optional provider override for capability runs only when that capability supports provider selection. For example, `screenshot` supports `firecrawl`, `scrapingfish`, and `phantomjscloud`, while DumplingAI-managed capabilities such as `extract_document` use `dumplingai`.","uniqueKey":"provider","typeLabel":"string"},"options":{"type":"object","properties":{"include_native":{"type":"boolean","uniqueKey":"options.include_native","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"options","typeLabel":"object"}},"required":["type","id","input"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","input":{},"provider":"\u003cstring>","options":{"include_native":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"e33adb69-8386-4f32-8461-b222c496b32a":{"description":"Capability result","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"421a5847-4c0e-4042-b3b9-c0b2ab42e0f7":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"required":["success","requestId","error","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"requestId":"\u003cstring>","error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b622204f-1461-46f7-9c47-cf7cd5dd3cd3":{"description":"Authentication failed","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"required":["success","requestId","error","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"requestId":"\u003cstring>","error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"0ff61794-4688-4cef-adae-a4ffa1de1f16":{"description":"Policy rejected","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"required":["success","requestId","error","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"requestId":"\u003cstring>","error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"e90a3eab-d47b-4c4a-9438-8c2a31aa9b23":{"description":"Unknown capability or endpoint","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"required":["success","requestId","error","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"requestId":"\u003cstring>","error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"cfc76658-341f-485a-a13a-67013e6b4272":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","scopes":[]}}},"servers":{"54897249-17e0-467a-9e6a-d6b03d6256c6":{"url":"https://app.dumplingai.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi-v2.yaml"},"subdomain":"dumplingai","siteName":"DumplingAI Docs","title":"Run a capability or endpoint - DumplingAI Docs","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference/execution/run","matchLevel":0},"v1":{"href":"/documentation/v1/get-started","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-05-07T12:01:45.533Z","originalFileLocation":"api-reference/execution/run.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=\"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=\"Run a capability or endpoint - DumplingAI Docs\">\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/execution/run\">\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=Execution+API\u0026amp;title=Run+a+capability+or+endpoint\u0026amp;theme=f6d65ea4c1e9445145f9cff7\u0026amp;signature=ba8538df7134c4993848e81eafdefcdcb8f3fb59bc2f91d24dd623804ba5b413\">\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=\"Run a capability or endpoint - DumplingAI Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dumplingai.mintlify.app/_mintlify/api/og/v2?division=Execution+API\u0026amp;title=Run+a+capability+or+endpoint\u0026amp;theme=f6d65ea4c1e9445145f9cff7\u0026amp;signature=ba8538df7134c4993848e81eafdefcdcb8f3fb59bc2f91d24dd623804ba5b413\">\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/execution/run\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/execution/run.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.dumplingai.com/#organization\",\"name\":\"DumplingAI Docs\",\"url\":\"https://docs.dumplingai.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/dumplingai/ovQfojsBnkaBEyWP/dumplingai-logo.svg?fit=max\u0026auto=format\u0026n=ovQfojsBnkaBEyWP\u0026q=85\u0026s=46740c45e1bef65a42e4a799407a5d32\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.dumplingai.com#website\",\"name\":\"DumplingAI Docs\",\"url\":\"https://docs.dumplingai.com\",\"publisher\":{\"@id\":\"https://docs.dumplingai.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.dumplingai.com/api-reference/execution/run#webpage\",\"url\":\"https://docs.dumplingai.com/api-reference/execution/run\",\"name\":\"Run a capability or endpoint\",\"dateModified\":\"2026-05-07T12:01:45.533Z\",\"isPartOf\":{\"@id\":\"https://docs.dumplingai.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.dumplingai.com/api-reference/execution/run#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.dumplingai.com/api-reference/execution/run#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"DumplingAI Docs\",\"item\":\"https://docs.dumplingai.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Run a capability or endpoint\",\"item\":\"https://docs.dumplingai.com/api-reference/execution/run\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.dumplingai.com/api-reference/execution/run#apireference\",\"headline\":\"Run a capability or endpoint\",\"name\":\"Run a capability or endpoint\",\"url\":\"https://docs.dumplingai.com/api-reference/execution/run\",\"mainEntityOfPage\":{\"@id\":\"https://docs.dumplingai.com/api-reference/execution/run#webpage\"},\"dateModified\":\"2026-05-07T12:01:45.533Z\",\"publisher\":{\"@id\":\"https://docs.dumplingai.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.dumplingai.com#website\"}}]}\u003c/script>\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","pages":[{"title":"Documentation","href":"/documentation/v2/get-started"}]},{"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","description":null,"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","description":null,"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":"Run a capability or endpoint - DumplingAI Docs","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}