Create an account and mint an API key from the Vers dashboard.
Go to vers.sh and sign in. Select your organization, open
Settings, then open API Keys.The User-created view shows keys for your CLI and integrations. The
System-managed view lets you inspect credentials that Vers creates for
projects, launches, and Buddy tasks, including their purpose and expiration.
Vers manages those credentials automatically; use the corresponding project
or session controls to manage the work they belong to.System-managed credentials show only active keys by default. Choose History
in the status filter to inspect expired or revoked keys. Vers removes these
credentials after 30 days unless a resource or audit record still references
them. Cleanup does not delete their VMs, commits, or other resources.Select Create a new API key, give the key a descriptive name, and copy it
when it is shown. Treat the value as a password: do not paste it into tickets,
logs, screenshots, or commands that will remain in shell history.The CLI does not have a login command. Configure the key with the
VERS_API_KEY environment variable or the private ~/.versrc file described
in Installation.
⌘I
{"docsConfig":{"theme":"linden","$schema":"https://mintlify.com/docs.json","name":"Vers","colors":{"primary":"#1F86E6","light":"#4DA0EE","dark":"#1A6FC0"},"favicon":"https://mintcdn.com/vers/4S_7kY_LFSlU0Uj6/favicon.svg?fit=max\u0026auto=format\u0026n=4S_7kY_LFSlU0Uj6\u0026q=85\u0026s=e3c5bc5db8abb2b66cd06d3e88edb70b","api":{"playground":{"display":"interactive"}},"navbar":{"links":[{"icon":"github","href":"https://github.com/hdresearch","label":"GitHub"},{"icon":"calendar","href":"https://cal.com/tynan-daly/15min","label":"Book a demo"}]},"footer":{"socials":{"github":"https://github.com/hdresearch"}},"fonts":{"heading":{"family":"Redaction 35","weight":400},"body":{"family":"Necto Mono","weight":400}},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":{"light":"min-light","dark":"min-dark"}},"latex":false},"integrations":{"posthog":{"apiKey":"phc_jpdZOKSKobZHeG3ivn5o6gMeJXxxCRmUB83Y29jIT8e"}},"contextual":{"options":["copy","claude","chatgpt","perplexity"],"display":"header"},"background":{"color":{"light":"#f8fbfe","dark":"#0b0e12"}},"navigation":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/hdresearch"},{"anchor":"Support","icon":"envelope","href":"mailto:support@vers.sh"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vers","hasAudioNarration":false,"actualSubdomain":"vers","customDomains":["docs.vers.sh"],"gitSource":{"type":"github","owner":"hdresearch","repo":"chelsea","deployBranch":"next","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adbe1e93b7a1070e29f5926","collectionId":"9caa239c-89b5-476b-8cfb-e96f210cfc1b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adbe1e93b7a1070e29f5926"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adbe1e93b7a1070e29f5926","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Essays","count":7},{"language":"default","tag":"Branchable compute","count":7},{"language":"default","tag":"Start","count":6},{"language":"default","tag":"API","count":5},{"language":"default","tag":"Shell Auth","count":5},{"language":"default","tag":"Get running","count":3},{"language":"default","tag":"API-driven guides","count":2},{"language":"default","tag":"CLI","count":1},{"language":"default","tag":"Reference","count":1},{"language":"default","tag":"Introduction","count":1}]},"assistantConfig":{"deflection":{"enabled":true,"email":"pranav@hdr.is","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"get-api-key","slug":"/get-api-key","pageMetadata":{"title":"Get your API key","description":"Create an account and mint an API key from the Vers dashboard.","href":"/get-api-key"},"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: \"Create an account and mint an API key from the Vers dashboard.\"\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`,p:`p`,strong:`strong`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Go to `,_jsx(_components.a,{href:`https://vers.sh`,children:`vers.sh`}),` and sign in. Select your organization, open\n`,_jsx(_components.strong,{children:`Settings`}),`, then open `,_jsx(_components.strong,{children:`API Keys`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`The `,_jsx(_components.strong,{children:`User-created`}),` view shows keys for your CLI and integrations. The\n`,_jsx(_components.strong,{children:`System-managed`}),` view lets you inspect credentials that Vers creates for\nprojects, launches, and Buddy tasks, including their purpose and expiration.\nVers manages those credentials automatically; use the corresponding project\nor session controls to manage the work they belong to.`]}),`\n`,_jsxs(_components.p,{children:[`System-managed credentials show only active keys by default. Choose `,_jsx(_components.strong,{children:`History`}),`\nin the status filter to inspect expired or revoked keys. Vers removes these\ncredentials after 30 days unless a resource or audit record still references\nthem. Cleanup does not delete their VMs, commits, or other resources.`]}),`\n`,_jsxs(_components.p,{children:[`Select `,_jsx(_components.strong,{children:`Create a new API key`}),`, give the key a descriptive name, and copy it\nwhen it is shown. Treat the value as a password: do not paste it into tickets,\nlogs, screenshots, or commands that will remain in shell history.`]}),`\n`,_jsxs(_components.p,{children:[`The CLI does not have a `,_jsx(_components.code,{children:`login`}),` command. Configure the key with the\n`,_jsx(_components.code,{children:`VERS_API_KEY`}),` environment variable or the private `,_jsx(_components.code,{children:`~/.versrc`}),` file described\nin `,_jsx(_components.a,{href:`/installation#authentication`,children:`Installation`}),`.`]})]})}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":{"codeStyling":{"theme":{"light":"min-light","dark":"min-dark"}},"config":{},"pageMetadata":{"title":"Get your API key","description":"Create an account and mint an API key from the Vers dashboard.","href":"/get-api-key"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"vers","siteName":"Vers","title":"Get your API key - Vers","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-19T16:49:26.968Z","originalFileLocation":"get-api-key.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=\"Create an account and mint an API key from the Vers dashboard.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Vers\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vers/X7P3B5WMIAGQWJgL/_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/vers/X7P3B5WMIAGQWJgL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vers/X7P3B5WMIAGQWJgL/_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/vers/X7P3B5WMIAGQWJgL/_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/vers/X7P3B5WMIAGQWJgL/_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/vers/X7P3B5WMIAGQWJgL/_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/vers/X7P3B5WMIAGQWJgL/_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/vers/X7P3B5WMIAGQWJgL/_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/vers/X7P3B5WMIAGQWJgL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get your API key - Vers\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create an account and mint an API key from the Vers dashboard.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Vers\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.vers.sh/get-api-key\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vers.mintlify.app/_mintlify/api/og/v2?division=Get+running\u0026amp;title=Get+your+API+key\u0026amp;description=Create+an+account+and+mint+an+API+key+from+the+Vers+dashboard.\u0026amp;theme=e261774bda2a98e6de5cdac1\u0026amp;signature=0e333668ee8544b37136f871813905351c2f8dec8c2a728af299edb665a808e0\">\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=\"Get your API key - Vers\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create an account and mint an API key from the Vers dashboard.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vers.mintlify.app/_mintlify/api/og/v2?division=Get+running\u0026amp;title=Get+your+API+key\u0026amp;description=Create+an+account+and+mint+an+API+key+from+the+Vers+dashboard.\u0026amp;theme=e261774bda2a98e6de5cdac1\u0026amp;signature=0e333668ee8544b37136f871813905351c2f8dec8c2a728af299edb665a808e0\">\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/vers/X7P3B5WMIAGQWJgL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Vers\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1F86E6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.vers.sh/get-api-key\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/get-api-key.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.vers.sh/#organization\",\"name\":\"Vers\",\"url\":\"https://docs.vers.sh\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.vers.sh#website\",\"name\":\"Vers\",\"url\":\"https://docs.vers.sh\",\"publisher\":{\"@id\":\"https://docs.vers.sh/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.vers.sh/get-api-key#webpage\",\"url\":\"https://docs.vers.sh/get-api-key\",\"name\":\"Get your API key\",\"description\":\"Create an account and mint an API key from the Vers dashboard.\",\"dateModified\":\"2026-09-19T16:49:26.968Z\",\"isPartOf\":{\"@id\":\"https://docs.vers.sh#website\"},\"breadcrumb\":{\"@id\":\"https://docs.vers.sh/get-api-key#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.vers.sh/get-api-key#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Get running\",\"item\":\"https://docs.vers.sh/installation\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get your API key\",\"item\":\"https://docs.vers.sh/get-api-key\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.vers.sh/get-api-key#article\",\"headline\":\"Get your API key\",\"name\":\"Get your API key\",\"description\":\"Create an account and mint an API key from the Vers dashboard.\",\"url\":\"https://docs.vers.sh/get-api-key\",\"mainEntityOfPage\":{\"@id\":\"https://docs.vers.sh/get-api-key#webpage\"},\"dateModified\":\"2026-09-19T16:49:26.968Z\",\"publisher\":{\"@id\":\"https://docs.vers.sh/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.vers.sh#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Vers\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Vers","nav":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/hdresearch"},{"anchor":"Support","icon":"envelope","href":"mailto:support@vers.sh"}]},"tabs":[{"tab":"Start","groups":[{"group":"Introduction","pages":[{"title":"What is Vers?","sidebarTitle":"Overview","icon":"house","mode":"wide","href":"/overview"}]},{"group":"Get running","pages":[{"title":"Installation","description":"Install the Vers CLI on macOS or Linux and configure an API key.","href":"/installation"},{"title":"Get your API key","href":"/get-api-key"},{"title":"Quickstart","description":"Create a computer, run commands, write a file, and clean up.","href":"/quickstart"}]},{"group":"API-driven guides","pages":[{"title":"Static Web App (GitHub Import)","href":"/examples/static-web-app-github"},{"title":"Building pi extensions","href":"/tutorials/pi-extensions"}]}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/cli-reference/overview"}]},{"tab":"Essays","pages":[{"title":"Essays","href":"/essays/overview"}]},{"tab":"API","pages":[{"title":"API","href":"/shell-auth/overview"}]}]},"basePath":"","title":"Get your API key - Vers","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":[],"chunks":[]}