If you’re working with an AI assistant or vibe coding, we recommend using the “Copy Page” dropdown in top right corner of each page to get AI-ready documentation. Alternatively, give your assistant links to llms.txt or llms-full.txt.
API requests are rate-limited based on your subscription plan. Current limits are shown on the pricing page.It is possible to increase rate limits upon request.
Never share your API key or commit it to version control. Use environment
variables to store your API key securely. Only access the API from a secure
server environment.
The Supadata community has created various resources and guides for using Supadata. You can find them here.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Supadata Docs","colors":{"primary":"#000","light":"#fff","dark":"#000"},"logo":{"light":"https://mintcdn.com/dumplingsoftware/pjy-1eCccPCaWUcz/logo/light.svg?fit=max\u0026auto=format\u0026n=pjy-1eCccPCaWUcz\u0026q=85\u0026s=3837e824eb8537f6b4beb9d53fe404d1","dark":"https://mintcdn.com/dumplingsoftware/pjy-1eCccPCaWUcz/logo/dark.svg?fit=max\u0026auto=format\u0026n=pjy-1eCccPCaWUcz\u0026q=85\u0026s=932c819ef58dc84058d66979c3de7277"},"favicon":"https://mintcdn.com/dumplingsoftware/pjy-1eCccPCaWUcz/favicon.svg?fit=max\u0026auto=format\u0026n=pjy-1eCccPCaWUcz\u0026q=85\u0026s=84a8c1e2ea396826da6159ae4f8f102b","navbar":{"links":[{"href":"https://status.supadata.ai","label":"Status"},{"href":"https://feedback.supadata.ai/","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dash.supadata.ai"}},"footer":{"socials":{"github":"https://github.com/supadata-ai"},"links":[{"header":"Legal","items":[{"label":"Imprint","href":"https://supadata.ai/legal/imprint"},{"label":"Privacy Policy","href":"https://supadata.ai/legal/privacy"},{"label":"Terms of Service","href":"https://supadata.ai/legal/terms"},{"label":"Data Processing Agreement","href":"https://supadata.ai/legal/dpa"}]}]},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Playground","icon":"play","href":"https://supadata.ai/playground"},{"anchor":"Feedback","icon":"comment","href":"https://supadata.featurebase.app"},{"anchor":"Changelog","icon":"clock-rotate-left","href":"https://feedback.supadata.ai/changelog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"dumplingsoftware","hasAudioNarration":false,"actualSubdomain":"dumplingsoftware","customDomains":["docs.supadata.ai"],"gitSource":{"type":"github","owner":"supadata-ai","repo":"supadata-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adb8602858a516f4e16db99","collectionId":"b426cb1c-2307-4dc4-bfa1-853b74ba20af","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb8602858a516f4e16db99"},"feedback":{"thumbs":true,"edits":false,"issues":false},"entitlements":{},"buildId":"6adb8602858a516f4e16db99","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"Documentation","count":26},{"language":"default","tag":"Features","count":24},{"language":"default","tag":"API Reference","count":22},{"language":"default","tag":"Integrations","count":13},{"language":"default","tag":"YouTube Endpoints","count":11},{"language":"default","tag":"Errors","count":9},{"language":"default","tag":"Youtube","count":9},{"language":"default","tag":"Universal Endpoints","count":5},{"language":"default","tag":"Web Endpoints","count":4},{"language":"default","tag":"Web","count":3}]},"assistantConfig":{},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"index","slug":"/","pageMetadata":{"title":"Introduction","description":"Welcome to the Supadata documentation. Our API provides powerful tools for extracting web content.","og:title":"Getting Started | Supadata","og:description":"Supadata is a web to text API that allows you to extract text from websites and YouTube videos.","href":"/index"},"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: \"Welcome to the Supadata documentation. Our API provides powerful tools for extracting web content.\"\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`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`overview`,children:`Overview`}),`\n`,_jsx(_components.p,{children:`Supadata offers five main services:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Video Transcripts - Extract transcripts from YouTube, TikTok, Instagram, Facebook, X (Twitter) and video files`}),`\n`,_jsx(_components.li,{children:`Media Metadata - Get social media post data like title, author and engagement metrics`}),`\n`,_jsx(_components.li,{children:`Structured Data Extraction - Use AI to extract structured data from videos across all supported platforms`}),`\n`,_jsx(_components.li,{children:`Web Reader - Extract content from any website, crawl pages and extract structured data`}),`\n`,_jsx(_components.li,{children:`YouTube Metadata - Extract video, channel and playlist metadata`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`getting-an-api-key`,children:`Getting an API Key`}),`\n`,_jsx(_components.p,{children:`All requests to Supadata require authentication using an API key. The same key also works with the SDKs and no-code integrations. To get your API key:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Sign up for an account at `,_jsx(_components.a,{href:`https://dash.supadata.ai`,children:`dash.supadata.ai`})]}),`\n`,_jsx(_components.li,{children:`Your API key will be generated automatically during onboarding and available in the dashboard`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`integrations-and-sdks`,children:`Integrations and SDKs`}),`\n`,_jsx(_components.p,{children:`This documentation provides examples for how to use the Supadata API and its various parameters.`}),`\n`,_jsx(_components.p,{children:`We also offer the following SDKs and integrations:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`https://github.com/supadata-ai/js`,children:`JavaScript SDK`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`https://github.com/supadata-ai/py`,children:`Python SDK`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/integrations/n8n`,children:`n8n`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/integrations/make`,children:`Make`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/integrations/zapier`,children:`Zapier`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/integrations/activepieces`,children:`Active Pieces`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/integrations/mcp`,children:`MCP`})}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`documentation-for-ai`,children:`Documentation for AI`}),`\n`,_jsxs(_components.p,{children:[`If you’re working with an AI assistant or vibe coding, we recommend using the “Copy Page” dropdown in top right corner of each page to get AI-ready documentation. Alternatively, give your assistant links to `,_jsx(_components.a,{href:`/llms.txt`,children:`llms.txt`}),` or `,_jsx(_components.a,{href:`/llms-full.txt`,children:`llms-full.txt`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`rate-limits`,children:`Rate Limits`}),`\n`,_jsxs(_components.p,{children:[`API requests are rate-limited based on your subscription plan. Current limits are shown on the `,_jsx(_components.a,{href:`https://supadata.ai/pricing`,children:`pricing page`}),`.`]}),`\n`,_jsx(_components.p,{children:`It is possible to increase rate limits upon request.`}),`\n`,_jsx(Heading,{level:`2`,id:`api-usage`,children:`API Usage`}),`\n`,_jsx(Heading,{level:`3`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(_components.p,{children:`All API requests require authentication using an API key. Include your API key in the request headers:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"x-api-key: YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.supadata.ai/v1/...`})]}),`\n`]})})}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Never share your API key or commit it to version control. Use environment\nvariables to store your API key securely. Only access the API from a secure\nserver environment.`})}),`\n`,_jsx(Heading,{level:`3`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(_components.p,{children:`All API endpoints use the following base URL:`}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`https://api.supadata.ai/v1`})}),`\n`,_jsx(Heading,{level:`3`,id:`response-format`,children:`Response Format`}),`\n`,_jsx(_components.p,{children:`All API responses are returned in JSON format.`}),`\n`,_jsx(Heading,{level:`1`,id:`community-resources`,children:`Community Resources`}),`\n`,_jsxs(_components.p,{children:[`The Supadata community has created various resources and guides for using Supadata. `,_jsx(_components.a,{href:`/community-resources`,children:`You can find them here`}),`.`]})]})}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":"Introduction","description":"Welcome to the Supadata documentation. Our API provides powerful tools for extracting web content.","og:title":"Getting Started | Supadata","og:description":"Supadata is a web to text API that allows you to extract text from websites and YouTube videos.","href":"/index"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Overview","slug":"overview","depth":2,"children":[]},{"title":"Getting an API Key","slug":"getting-an-api-key","depth":2,"children":[]},{"title":"Integrations and SDKs","slug":"integrations-and-sdks","depth":2,"children":[]},{"title":"Documentation for AI","slug":"documentation-for-ai","depth":2,"children":[]},{"title":"Rate Limits","slug":"rate-limits","depth":2,"children":[]},{"title":"API Usage","slug":"api-usage","depth":2,"children":[{"title":"Authentication","slug":"authentication","depth":3,"children":[]},{"title":"Base URL","slug":"base-url","depth":3,"children":[]},{"title":"Response Format","slug":"response-format","depth":3,"children":[]}]},{"title":"Community Resources","slug":"community-resources","depth":1,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"dumplingsoftware","siteName":"Supadata Docs","title":"Getting Started | Supadata","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-15T11:36:51.453Z","originalFileLocation":"index.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=\"Welcome to the Supadata documentation. Our API provides powerful tools for extracting web content.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Supadata 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/dumplingsoftware/x6W5VNKmhmsOhiNO/_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/dumplingsoftware/x6W5VNKmhmsOhiNO/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dumplingsoftware/x6W5VNKmhmsOhiNO/_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/dumplingsoftware/x6W5VNKmhmsOhiNO/_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/dumplingsoftware/x6W5VNKmhmsOhiNO/_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/dumplingsoftware/x6W5VNKmhmsOhiNO/_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/dumplingsoftware/x6W5VNKmhmsOhiNO/_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/dumplingsoftware/x6W5VNKmhmsOhiNO/_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/dumplingsoftware/x6W5VNKmhmsOhiNO/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Getting Started | Supadata\">\u003cmeta data-mint-head property=\"og:description\" content=\"Supadata is a web to text API that allows you to extract text from websites and YouTube videos.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Supadata Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.supadata.ai\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://dumplingsoftware.mintlify.app/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Introduction\u0026amp;description=Welcome+to+the+Supadata+documentation.+Our+API+provides+powerful+tools+for+extracting+web+content.\u0026amp;theme=020fa75e0f43edb68a597779\u0026amp;signature=c58266be744aa628920ae240a55b6e393752a8104e9bd85c80fb4f857436c142\">\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=\"Getting Started | Supadata\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Supadata is a web to text API that allows you to extract text from websites and YouTube videos.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dumplingsoftware.mintlify.app/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Introduction\u0026amp;description=Welcome+to+the+Supadata+documentation.+Our+API+provides+powerful+tools+for+extracting+web+content.\u0026amp;theme=020fa75e0f43edb68a597779\u0026amp;signature=c58266be744aa628920ae240a55b6e393752a8104e9bd85c80fb4f857436c142\">\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/dumplingsoftware/x6W5VNKmhmsOhiNO/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Supadata Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.supadata.ai\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/index.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.supadata.ai/#organization\",\"name\":\"Supadata Docs\",\"url\":\"https://docs.supadata.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/dumplingsoftware/pjy-1eCccPCaWUcz/logo/light.svg?fit=max\u0026auto=format\u0026n=pjy-1eCccPCaWUcz\u0026q=85\u0026s=3837e824eb8537f6b4beb9d53fe404d1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.supadata.ai#website\",\"name\":\"Supadata Docs\",\"url\":\"https://docs.supadata.ai\",\"publisher\":{\"@id\":\"https://docs.supadata.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.supadata.ai/#webpage\",\"url\":\"https://docs.supadata.ai/\",\"name\":\"Introduction\",\"description\":\"Welcome to the Supadata documentation. Our API provides powerful tools for extracting web content.\",\"dateModified\":\"2026-09-15T11:36:51.453Z\",\"isPartOf\":{\"@id\":\"https://docs.supadata.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.supadata.ai/#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.supadata.ai/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Getting Started\",\"item\":\"https://docs.supadata.ai/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.supadata.ai/\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.supadata.ai/#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"Welcome to the Supadata documentation. Our API provides powerful tools for extracting web content.\",\"url\":\"https://docs.supadata.ai/\",\"mainEntityOfPage\":{\"@id\":\"https://docs.supadata.ai/#webpage\"},\"dateModified\":\"2026-09-15T11:36:51.453Z\",\"publisher\":{\"@id\":\"https://docs.supadata.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.supadata.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Supadata Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Supadata Docs","nav":{"global":{"anchors":[{"anchor":"Playground","icon":"play","href":"https://supadata.ai/playground"},{"anchor":"Feedback","icon":"comment","href":"https://supadata.featurebase.app"},{"anchor":"Changelog","icon":"clock-rotate-left","href":"https://feedback.supadata.ai/changelog"}]},"tabs":[{"tab":"Documentation","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":""},{"title":"Community Resources","description":"Explore tutorials, guides, and videos about using Supadata","href":"/community-resources"}]},{"group":"Features","pages":[{"title":"Transcript","icon":"book","href":"/get-transcript"},{"title":"Metadata","icon":"circle-info","href":"/get-metadata"},{"title":"Extract","icon":"wand-magic-sparkles","href":"/get-extract"},{"group":"Youtube","icon":"youtube","pages":[{"title":"Search","sidebarTitle":"Search","href":"/youtube/search"},{"title":"Translation","href":"/youtube/get-transcript-translation"},{"title":"Channel","href":"/youtube/channel"},{"title":"Playlist","href":"/youtube/playlist"},{"title":"Channel Videos","href":"/youtube/channel-videos"},{"title":"Playlist Videos","href":"/youtube/playlist-videos"},{"title":"Batch","href":"/youtube/batch"},{"title":"Supported YouTube URL Formats and Examples | Supadata Docs","sidebarTitle":"URL Formats","href":"/youtube/supported-url-formats"},{"title":"Languages","href":"/youtube/supported-language-codes"}]},{"group":"Web","icon":"markdown","pages":[{"title":"Scrape","href":"/web/scrape"},{"title":"Map","href":"/web/map"},{"title":"Crawl","href":"/web/crawl"}]},{"group":"Errors","icon":"triangle-exclamation","pages":[{"title":"Error Codes","href":"/errors/list"},{"title":"Invalid Request","href":"/errors/invalid-request"},{"title":"Unauthorized","href":"/errors/unauthorized"},{"title":"Not Found","href":"/errors/not-found"},{"title":"Limit Exceeded","href":"/errors/limit-exceeded"},{"title":"Upgrade Required","href":"/errors/upgrade-required"},{"title":"Transcript Unavailable","href":"/errors/transcript-unavailable"},{"title":"Internal Error","href":"/errors/internal-error"},{"title":"Upstream Error","href":"/errors/upstream-error"}]}]}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]}]},"title":"Getting Started | Supadata","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":[],"chunks":[]}
