All endpoints in the Product API, Media API, and Analytics API require authentication via an access token. Include the token in the headers of every request.See the API overview for the base URL, rate limits, and which endpoints to use.
Obtain your access token from your Videowise account settings. Go to Settings -> Stores -> Click View license key
Include the token in the X-Videowise-Access-Token header of your request.
siteId and siteType are deprecated and no longer required. They were
previously obtained from Settings → Stores → Edit and were passed in the
request body. Existing integrations that still send these fields will continue
to work.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Videowise","colors":{"primary":"#0D9373","light":"#3cfecf","dark":"#0D9373"},"favicon":"https://mintcdn.com/videowise/bveJQb1lfkNLr7Hc/favicon.svg?fit=max\u0026auto=format\u0026n=bveJQb1lfkNLr7Hc\u0026q=85\u0026s=62ba5f44a824fe38becf1715f7a5bcbc","logo":{"light":"https://mintcdn.com/videowise/8_1ghAJvj_CP-3qs/logo/light.svg?fit=max\u0026auto=format\u0026n=8_1ghAJvj_CP-3qs\u0026q=85\u0026s=52372475afbc9c75b461755b5b3a0e64","dark":"https://mintcdn.com/videowise/8_1ghAJvj_CP-3qs/logo/dark.svg?fit=max\u0026auto=format\u0026n=8_1ghAJvj_CP-3qs\u0026q=85\u0026s=5a6dfc94ae3da2a9b02476677a1b4304"},"background":{"decoration":null,"color":{"light":"#f5f5f5","dark":"#121212"}},"navbar":{"links":[{"label":"Support","href":"https://help.videowise.com/"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.videowise.com/"}},"footer":{"socials":{"twitter":"https://twitter.com/videowisehq","linkedin":"https://www.linkedin.com/company/reeviewapp"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Help Center","href":"https://help.videowise.com/","icon":"circle-info"},{"anchor":"Blog","href":"https://videowise.com/blog","icon":"newspaper"},{"anchor":"FAQ","href":"https://videowise.com/faq","icon":"circle-question"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"videowise","hasAudioNarration":false,"actualSubdomain":"videowise","customDomains":["docs.videowise.com"],"gitSource":{"type":"github","owner":"vidystar","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad9f6170febba82de3031b4","collectionId":"c39161fd-fb7a-450f-8185-1f83f5cf92de","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad9f6170febba82de3031b4"},"entitlements":{},"buildId":"6ad9f6170febba82de3031b4","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Documentation","count":58},{"language":"default","tag":"SDK","count":7},{"language":"default","tag":"Live shopping","count":5},{"language":"default","tag":"Order tracking pixel","count":5},{"language":"default","tag":"API","count":5},{"language":"default","tag":"Shoppable videos","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"product-api/authentication","slug":"/product-api/authentication","pageMetadata":{"title":"Authentication","description":"Learn how to authenticate with the Videowise API.","icon":"shield-check","iconType":"solid","href":"/product-api/authentication"},"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: \"Learn how to authenticate with the Videowise API.\"\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`,hr:`hr`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`All endpoints in the `,_jsx(_components.strong,{children:`Product API`}),`, `,_jsx(_components.strong,{children:`Media API`}),`, and `,_jsx(_components.strong,{children:`Analytics API`}),` require authentication via an access token. Include the token in the headers of every request.`]}),`\n`,_jsxs(_components.p,{children:[`See the `,_jsx(_components.a,{href:`/product-api/overview`,children:`API overview`}),` for the base URL, rate limits, and which endpoints to use.`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`how-to-get-your-x-videowise-access-token`,children:`How to get your X-Videowise-Access-Token`}),`\n`,_jsx(Heading,{level:`2`,id:`how-to-authenticate`,children:`How to Authenticate`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Obtain your access token from your Videowise account settings. Go to Settings -> Stores -> Click `,_jsx(_components.strong,{children:`View license key`})]}),`\n`,_jsxs(_components.li,{children:[`Include the token in the `,_jsx(_components.code,{children:`X-Videowise-Access-Token`}),` header of your request.`]}),`\n`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`siteId`}),` and `,_jsx(_components.code,{children:`siteType`}),` are deprecated and no longer required. They were\npreviously obtained from Settings → Stores → `,_jsx(_components.strong,{children:`Edit`}),` and were passed in the\nrequest body. Existing integrations that still send these fields will continue\nto work.`]})}),`\n`,_jsx(_components.p,{children:`Example:`}),`\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:`X-Videowise-Access-Token: \u003cyour_access_token>`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`2`,id:`error-responses`,children:`Error Responses`}),`\n`,_jsxs(_components.p,{children:[`If the token is missing or invalid, the API will return a `,_jsx(_components.strong,{children:`401 Unauthorized`}),` error:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`javascript`,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:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`3`,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:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Missing X-Videowise-Access-Token header\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`related`,children:`Related`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/product-api/overview`,children:`API overview`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/product-api/product`,children:`Product`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/product-api/media`,children:`Media`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/product-api/analytics`,children:`Analytics`})}),`\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":"Authentication","description":"Learn how to authenticate with the Videowise API.","icon":"shield-check","iconType":"solid","href":"/product-api/authentication"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"How to get your X-Videowise-Access-Token","slug":"how-to-get-your-x-videowise-access-token","depth":2,"children":[]},{"title":"How to Authenticate","slug":"how-to-authenticate","depth":2,"children":[]},{"title":"Error Responses","slug":"error-responses","depth":2,"children":[]},{"title":"Related","slug":"related","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"videowise","siteName":"Videowise","title":"Authentication - Videowise","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-22T07:39:21.256Z","originalFileLocation":"product-api/authentication.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=\"Learn how to authenticate with the Videowise API.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Videowise\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/videowise/OD2Nf15Hmd7qA0Yt/_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/videowise/OD2Nf15Hmd7qA0Yt/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/videowise/OD2Nf15Hmd7qA0Yt/_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/videowise/OD2Nf15Hmd7qA0Yt/_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/videowise/OD2Nf15Hmd7qA0Yt/_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/videowise/OD2Nf15Hmd7qA0Yt/_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/videowise/OD2Nf15Hmd7qA0Yt/_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/videowise/OD2Nf15Hmd7qA0Yt/_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/videowise/OD2Nf15Hmd7qA0Yt/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Authentication - Videowise\">\u003cmeta data-mint-head property=\"og:description\" content=\"Learn how to authenticate with the Videowise API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Videowise\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.videowise.com/product-api/authentication\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://videowise.mintlify.app/_mintlify/api/og/v2?division=API\u0026amp;title=Authentication\u0026amp;description=Learn+how+to+authenticate+with+the+Videowise+API.\u0026amp;theme=a8b76a9e3bc43ff43f07123a\u0026amp;signature=1383414a39f1ca0f0046d9f3a583d6a473a46d75a56d8e1f4aa799f7cbba610c\">\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=\"Authentication - Videowise\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Learn how to authenticate with the Videowise API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://videowise.mintlify.app/_mintlify/api/og/v2?division=API\u0026amp;title=Authentication\u0026amp;description=Learn+how+to+authenticate+with+the+Videowise+API.\u0026amp;theme=a8b76a9e3bc43ff43f07123a\u0026amp;signature=1383414a39f1ca0f0046d9f3a583d6a473a46d75a56d8e1f4aa799f7cbba610c\">\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/videowise/OD2Nf15Hmd7qA0Yt/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Videowise\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.videowise.com/product-api/authentication\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/product-api/authentication.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.videowise.com/#organization\",\"name\":\"Videowise\",\"url\":\"https://docs.videowise.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/videowise/8_1ghAJvj_CP-3qs/logo/light.svg?fit=max\u0026auto=format\u0026n=8_1ghAJvj_CP-3qs\u0026q=85\u0026s=52372475afbc9c75b461755b5b3a0e64\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.videowise.com#website\",\"name\":\"Videowise\",\"url\":\"https://docs.videowise.com\",\"publisher\":{\"@id\":\"https://docs.videowise.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.videowise.com/product-api/authentication#webpage\",\"url\":\"https://docs.videowise.com/product-api/authentication\",\"name\":\"Authentication\",\"description\":\"Learn how to authenticate with the Videowise API.\",\"dateModified\":\"2026-09-22T07:39:21.256Z\",\"isPartOf\":{\"@id\":\"https://docs.videowise.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.videowise.com/product-api/authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.videowise.com/product-api/authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Documentation\",\"item\":\"https://docs.videowise.com/welcome\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API\",\"item\":\"https://docs.videowise.com/product-api/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Authentication\",\"item\":\"https://docs.videowise.com/product-api/authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.videowise.com/product-api/authentication#article\",\"headline\":\"Authentication\",\"name\":\"Authentication\",\"description\":\"Learn how to authenticate with the Videowise API.\",\"url\":\"https://docs.videowise.com/product-api/authentication\",\"mainEntityOfPage\":{\"@id\":\"https://docs.videowise.com/product-api/authentication#webpage\"},\"dateModified\":\"2026-09-22T07:39:21.256Z\",\"publisher\":{\"@id\":\"https://docs.videowise.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.videowise.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Videowise\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Videowise","nav":{"global":{"anchors":[{"anchor":"Help Center","href":"https://help.videowise.com/","icon":"circle-info"},{"anchor":"Blog","href":"https://videowise.com/blog","icon":"newspaper"},{"anchor":"FAQ","href":"https://videowise.com/faq","icon":"circle-question"}]},"anchors":[{"anchor":"Documentation","icon":"book-open","groups":[{"group":"Documentation","pages":[{"title":"Welcome","href":"/welcome"},{"group":"Shoppable videos","pages":[{"title":"Overview","href":"/shoppable-videos/overview"},{"title":"Working with custom platforms","href":"/shoppable-videos/custom-platforms"},{"title":"Widget re-rendering","href":"/shoppable-videos/re-rendering"},{"title":"Custom events","href":"/shoppable-videos/custom-events"},{"title":"Order tracking","href":"/shoppable-videos/order-tracking"}]},{"group":"Live shopping","pages":[{"title":"Overview","href":"/live-shopping/overview"},{"title":"Live channel page layout","href":"/live-shopping/channel-layout"},{"title":"Launch a live stream","href":"/live-shopping/stream-rendering"},{"title":"Custom events","href":"/live-shopping/custom-events"},{"title":"Order tracking","href":"/live-shopping/order-tracking"}]},{"group":"Order tracking pixel","pages":[{"title":"Overview","icon":"list","href":"/pixel/overview"},{"title":"Shopify","icon":"shopify","href":"/pixel/shopify"},{"title":"Magento","icon":"magento","href":"/pixel/magento"},{"title":"Salesforce Commerce Cloud","icon":"cloud","iconType":"solid","href":"/pixel/sfcc"},{"title":"Other","icon":"code","href":"/pixel/custom"}]},{"group":"API","pages":[{"title":"Overview","description":"Import products, upload media, and read live shopping analytics with the Videowise API.","icon":"list","href":"/product-api/overview"},{"title":"Authentication","icon":"shield-check","iconType":"solid","href":"/product-api/authentication"},{"title":"Product","description":"This API handles operations related to importing, retrieving, and deleting products in bulk or individually.","icon":"tag","iconType":"solid","href":"/product-api/product"},{"title":"Media","icon":"photo-film","iconType":"solid","href":"/product-api/media"},{"title":"Analytics","icon":"chart-mixed","iconType":"solid","href":"/product-api/analytics"}]},{"group":"SDK","pages":[{"title":"React Native SDK","href":"/sdk/react-native"},{"title":"Live Shopping Channel","href":"/sdk/live-shopping-channel"},{"title":"VideoFeed","href":"/sdk/video-feed"},{"title":"Floating","href":"/sdk/floating"},{"title":"Inline","href":"/sdk/inline"},{"title":"Tracking pixel","href":"/sdk/tracking-pixel"},{"title":"getStoredData","href":"/sdk/get-stored-data"}]},{"title":"Cookies","href":"/cookies"}]}]}]},"basePath":"","title":"Authentication - Videowise","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":[],"chunks":[]}