All API requests to VTULab should be made using the base URL below. Our API is versioned to ensure stability as we introduce new features.
Production Environment
The production base URL for all endpoints is:
API Base URL
https://api.vtulab.com/v1
HTTPS Only
To protect your data and API keys, the VTULab API requires all requests to be made over HTTPS. Unencrypted HTTP requests will be automatically rejected.
Versioning
The current version of the API is v1. We include the version number in the URL path to maintain backward compatibility for existing integrations.
When testing your integration, you can use the same base URL with your Test Key. The system will automatically process the request in Sandbox mode.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"VTULab API","colors":{"primary":"#6236FF"},"logo":{"light":"https://mintcdn.com/vtulab/_EfS-jggBmx-30Sn/logo.png?fit=max\u0026auto=format\u0026n=_EfS-jggBmx-30Sn\u0026q=85\u0026s=1945426eeeb8313d260cabbe7ee911d3","dark":"https://mintcdn.com/vtulab/_EfS-jggBmx-30Sn/logo.png?fit=max\u0026auto=format\u0026n=_EfS-jggBmx-30Sn\u0026q=85\u0026s=1945426eeeb8313d260cabbe7ee911d3"},"favicon":"https://mintcdn.com/vtulab/_EfS-jggBmx-30Sn/favicon.ico?fit=max\u0026auto=format\u0026n=_EfS-jggBmx-30Sn\u0026q=85\u0026s=7af65284b5b6d72caefd3ee67b00221d","api":{"openapi":"openapi.yml"},"appearance":{},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vtulab","hasAudioNarration":false,"actualSubdomain":"vtulab","customDomains":["docs.vtulab.com"],"gitSource":{"type":"github","owner":"vtulab-official","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae9264793c0d64dfeafbfb0:success","clientVersion":"0.0.4271","searchFilterCounts":[{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"API Reference","count":7},{"language":"default","tag":"Identity Services","count":4},{"language":"default","tag":"Getting Started","count":4},{"language":"default","tag":"VTU Services","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"site-roles","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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"base-url","slug":"/base-url","pageMetadata":{"title":"Base URL","description":"The root endpoint for all VTULab API requests.","href":"/base-url"},"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: \"The root endpoint for all VTULab API requests.\"\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`,hr:`hr`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Card,Heading,Tip}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`All API requests to VTULab should be made using the base URL below. Our API is versioned to ensure stability as we introduce new features.`}),`\n`,_jsx(Heading,{level:`2`,id:`production-environment`,children:`Production Environment`}),`\n`,_jsx(_components.p,{children:`The production base URL for all endpoints is:`}),`\n`,_jsx(Card,{title:`API Base URL`,icon:`globe`,children:_jsx(_components.p,{children:_jsx(_components.code,{children:`https://api.vtulab.com/v1`})})}),`\n`,_jsx(Heading,{level:`2`,id:`https-only`,children:`HTTPS Only`}),`\n`,_jsxs(_components.p,{children:[`To protect your data and API keys, the VTULab API requires all requests to be made over `,_jsx(_components.strong,{children:`HTTPS`}),`. Unencrypted HTTP requests will be automatically rejected.`]}),`\n`,_jsx(Heading,{level:`2`,id:`versioning`,children:`Versioning`}),`\n`,_jsxs(_components.p,{children:[`The current version of the API is `,_jsx(_components.code,{children:`v1`}),`. We include the version number in the URL path to maintain backward compatibility for existing integrations.`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`When testing your integration, you can use the same base URL with your `,_jsx(_components.strong,{children:`Test Key`}),`. The system will automatically process the request in Sandbox mode.`]})})]})}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":"Base URL","description":"The root endpoint for all VTULab API requests.","href":"/base-url"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Production Environment","slug":"production-environment","depth":2,"children":[]},{"title":"HTTPS Only","slug":"https-only","depth":2,"children":[]},{"title":"Versioning","slug":"versioning","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"vtulab","siteName":"VTULab API","title":"Base URL - VTULab API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-07T17:07:00.821Z","originalFileLocation":"base-url.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=\"The root endpoint for all VTULab API requests.\">\u003cmeta data-mint-head name=\"application-name\" content=\"VTULab API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vtulab/KW3EJuh7CkXXQmjF/_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/vtulab/KW3EJuh7CkXXQmjF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vtulab/KW3EJuh7CkXXQmjF/_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/vtulab/KW3EJuh7CkXXQmjF/_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/vtulab/KW3EJuh7CkXXQmjF/_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/vtulab/KW3EJuh7CkXXQmjF/_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/vtulab/KW3EJuh7CkXXQmjF/_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/vtulab/KW3EJuh7CkXXQmjF/_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/vtulab/KW3EJuh7CkXXQmjF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Base URL - VTULab API\">\u003cmeta data-mint-head property=\"og:description\" content=\"The root endpoint for all VTULab API requests.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"VTULab API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.vtulab.com/base-url\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vtulab.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Base+URL\u0026amp;description=The+root+endpoint+for+all+VTULab+API+requests.\u0026amp;theme=e61d57df495b8f46bdefced1\u0026amp;signature=60cacaa2432226026ae20de44efe02c05171a7eb1dd43ce546c6af4f400dfa25\">\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=\"Base URL - VTULab API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The root endpoint for all VTULab API requests.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vtulab.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Base+URL\u0026amp;description=The+root+endpoint+for+all+VTULab+API+requests.\u0026amp;theme=e61d57df495b8f46bdefced1\u0026amp;signature=60cacaa2432226026ae20de44efe02c05171a7eb1dd43ce546c6af4f400dfa25\">\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/vtulab/KW3EJuh7CkXXQmjF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"VTULab API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6236FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.vtulab.com/base-url\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/base-url.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.vtulab.com/#organization\",\"name\":\"VTULab API\",\"url\":\"https://docs.vtulab.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vtulab/_EfS-jggBmx-30Sn/logo.png?fit=max\u0026auto=format\u0026n=_EfS-jggBmx-30Sn\u0026q=85\u0026s=1945426eeeb8313d260cabbe7ee911d3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.vtulab.com#website\",\"name\":\"VTULab API\",\"url\":\"https://docs.vtulab.com\",\"publisher\":{\"@id\":\"https://docs.vtulab.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.vtulab.com/base-url#webpage\",\"url\":\"https://docs.vtulab.com/base-url\",\"name\":\"Base URL\",\"description\":\"The root endpoint for all VTULab API requests.\",\"dateModified\":\"2026-05-07T17:07:00.821Z\",\"isPartOf\":{\"@id\":\"https://docs.vtulab.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.vtulab.com/base-url#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.vtulab.com/base-url#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Getting Started\",\"item\":\"https://docs.vtulab.com/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Base URL\",\"item\":\"https://docs.vtulab.com/base-url\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.vtulab.com/base-url#article\",\"headline\":\"Base URL\",\"name\":\"Base URL\",\"description\":\"The root endpoint for all VTULab API requests.\",\"url\":\"https://docs.vtulab.com/base-url\",\"mainEntityOfPage\":{\"@id\":\"https://docs.vtulab.com/base-url#webpage\"},\"dateModified\":\"2026-05-07T17:07:00.821Z\",\"publisher\":{\"@id\":\"https://docs.vtulab.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.vtulab.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"VTULab API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"VTULab API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/base-url.md","siteName":"VTULab API","nav":{"global":null,"tabs":[{"tab":"Guides","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Authentication","description":"Securely access the VTULab API using API keys.","href":"/authentication"},{"title":"Base URL","href":"/base-url"},{"title":"Errors","description":"Understanding and handling API error responses.","href":"/errors"}]},{"group":"Guides","pages":[{"title":"Quickstart","href":"/quick-start"},{"title":"Making your First Request","href":"/making-first-request"},{"title":"Webhooks","href":"/webhooks"},{"title":"Going Live","href":"/going-live"},{"title":"Rate Limits","href":"/rate-limits"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/vtu/data-catalog"}]}]},"basePath":"","title":"Base URL - VTULab API","deploymentId":"dpl_Em2U4NQQ2N2DE3HPbPUJVZLnAtvc","buildId":"dpl_Em2U4NQQ2N2DE3HPbPUJVZLnAtvc","dynamics":[],"chunks":[]}