Your API Key can be found in the API tab of the dashboard.You should store your API Key in an environment variable so that users can see it as it must remain private.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Zymono","colors":{"primary":"#0091FF","light":"#0091FF","dark":"#0091FF"},"favicon":"Zymono-New.png","logo":{"light":"https://mintcdn.com/zymono/MXt8ZCprpMp39epD/Zymono-New.png?fit=max\u0026auto=format\u0026n=MXt8ZCprpMp39epD\u0026q=85\u0026s=c982c80c6ec44725e91a3ad2bc278119","dark":"https://mintcdn.com/zymono/MXt8ZCprpMp39epD/Zymono-New.png?fit=max\u0026auto=format\u0026n=MXt8ZCprpMp39epD\u0026q=85\u0026s=c982c80c6ec44725e91a3ad2bc278119"},"background":{"image":"https://mintlify.s3.us-west-1.amazonaws.com/zymono/images/bbg.png","decoration":null},"navbar":{"links":[{"label":"Support","href":"https://zymono.com/support"}],"primary":{"type":"button","label":"Zymono","href":"https://zymono.com"}},"footer":{"socials":{"youtube":"https://youtube.com/@zymono","github":"https://github.com/zymono","twitter":"https://www.twitter.com/useZymono","website":"https://zymono.com"}},"navigation":{"global":{"anchors":[{"anchor":"Help Desk","href":"https://blog.zymono.com","icon":"handshake"},{"anchor":"API Dashboard","href":"https://zymono.com/dashboard/api/","icon":"discord"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zymono","hasAudioNarration":false,"actualSubdomain":"zymono","customDomains":["docs.zymono.com"],"gitSource":{"type":"github","owner":"zymono","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c35112ef21155ee5517c","collectionId":"becb13c2-0259-4d2a-a5b0-39e504c724ad","schemaVersion":"v2"},"feedback":{"thumbs":true,"edits":true},"entitlements":{},"buildId":"6a20c35112ef21155ee5517c:success","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":7},{"language":"default","tag":"Static API Documentation","count":4},{"language":"default","tag":"NodeJS API Documentation","count":3},{"language":"default","tag":"Documentation","count":3},{"language":"default","tag":"Home","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":"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":"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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/authentication","slug":"/api-reference/authentication","pageMetadata":{"title":"Authentication","description":"How to authenticate request to the API","icon":"shield","href":"/api-reference/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: \"How to authenticate request to the 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={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The API requires authentication so that only you and your team can access your API information.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,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:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` apiKey`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'YOUR_API_KEY_HERE'`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`api-tokens`,children:`API Tokens`}),`\n`,_jsx(_components.p,{children:`Your API Key can be found in the API tab of the dashboard.`}),`\n`,_jsx(_components.p,{children:`You should store your API Key in an environment variable so that users can see it as it must remain private.`}),`\n`,_jsx(Heading,{level:`3`,id:`permissions`,children:`Permissions`}),`\n`,_jsx(_components.p,{children:`This API Key will grant you access to all of your information retrievable by the API.`}),`\n`,_jsx(_components.p,{children:`This API Key can be revoked by us at anytime!`})]})}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":"How to authenticate request to the API","icon":"shield","href":"/api-reference/authentication"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"API Tokens","slug":"api-tokens","depth":2,"children":[{"title":"Permissions","slug":"permissions","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"zymono","siteName":"Zymono","title":"Authentication - Zymono","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-06T22:48:13.674Z","originalFileLocation":"api-reference/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=\"How to authenticate request to the API\">\u003cmeta data-mint-head name=\"application-name\" content=\"Zymono\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zymono/ssDcdoL43RoimXio/_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/zymono/ssDcdoL43RoimXio/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zymono/ssDcdoL43RoimXio/_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/zymono/ssDcdoL43RoimXio/_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/zymono/ssDcdoL43RoimXio/_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/zymono/ssDcdoL43RoimXio/_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/zymono/ssDcdoL43RoimXio/_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/zymono/ssDcdoL43RoimXio/_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/zymono/ssDcdoL43RoimXio/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Authentication - Zymono\">\u003cmeta data-mint-head property=\"og:description\" content=\"How to authenticate request to the API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Zymono\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.zymono.com/api-reference/authentication\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zymono.mintlify.app/_mintlify/api/og/v2?division=Static+API+Documentation\u0026amp;title=Authentication\u0026amp;description=How+to+authenticate+request+to+the+API\u0026amp;theme=0d322bb9c477d81612c09d8a\u0026amp;signature=d456ec297d8f3c4fd12071c06e001da5067063c85cf21138452f95c6ea32788b\">\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 - Zymono\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"How to authenticate request to the API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zymono.mintlify.app/_mintlify/api/og/v2?division=Static+API+Documentation\u0026amp;title=Authentication\u0026amp;description=How+to+authenticate+request+to+the+API\u0026amp;theme=0d322bb9c477d81612c09d8a\u0026amp;signature=d456ec297d8f3c4fd12071c06e001da5067063c85cf21138452f95c6ea32788b\">\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/zymono/ssDcdoL43RoimXio/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Zymono\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0091FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.zymono.com/api-reference/authentication\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/authentication.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.zymono.com/#organization\",\"name\":\"Zymono\",\"url\":\"https://docs.zymono.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/zymono/MXt8ZCprpMp39epD/Zymono-New.png?fit=max\u0026auto=format\u0026n=MXt8ZCprpMp39epD\u0026q=85\u0026s=c982c80c6ec44725e91a3ad2bc278119\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.zymono.com#website\",\"name\":\"Zymono\",\"url\":\"https://docs.zymono.com\",\"publisher\":{\"@id\":\"https://docs.zymono.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.zymono.com/api-reference/authentication#webpage\",\"url\":\"https://docs.zymono.com/api-reference/authentication\",\"name\":\"Authentication\",\"description\":\"How to authenticate request to the API\",\"dateModified\":\"2026-01-06T22:48:13.674Z\",\"isPartOf\":{\"@id\":\"https://docs.zymono.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.zymono.com/api-reference/authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.zymono.com/api-reference/authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Zymono\",\"item\":\"https://docs.zymono.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authentication\",\"item\":\"https://docs.zymono.com/api-reference/authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.zymono.com/api-reference/authentication#article\",\"headline\":\"Authentication\",\"name\":\"Authentication\",\"description\":\"How to authenticate request to the API\",\"url\":\"https://docs.zymono.com/api-reference/authentication\",\"mainEntityOfPage\":{\"@id\":\"https://docs.zymono.com/api-reference/authentication#webpage\"},\"dateModified\":\"2026-01-06T22:48:13.674Z\",\"publisher\":{\"@id\":\"https://docs.zymono.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.zymono.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Zymono\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Zymono","nav":{"global":{"anchors":[{"anchor":"Help Desk","href":"https://blog.zymono.com","icon":"handshake"},{"anchor":"API Dashboard","href":"https://zymono.com/dashboard/api/","icon":"discord"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Static API Documentation","pages":[{"title":"Authentication","icon":"shield","href":"/api-reference/authentication"},{"title":"Create Report","description":"Create a report to be sent to your dashboard.","api":"POST https://zymono.com/api/report","href":"/api-reference/report"},{"title":"Get Reports","api":"POST https://zymono.com/api/getReports","href":"/api-reference/getReports"},{"title":"Delete Report","api":"POST https://zymono.com/api/deleteReport","href":"/api-reference/delete"}]},{"group":"NodeJS API Documentation","pages":[{"title":"Installation","icon":"download","href":"/api-reference/node/install"},{"title":"Authentication","icon":"shield","href":"/api-reference/node/authentication"},{"title":"Start","icon":"flag","href":"/api-reference/node/report"}]}]}]},"title":"Authentication - Zymono","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":[],"chunks":[]}
