To authenticate your API requests, you need an API key. This key identifies and authorizes your requests, ensuring only authorized users can access resources.Your API key provides access to all data available to your account, including projects, site summaries, and monitoring data.
Sign into the platform. In the bottom left, click on your name and select API Keys.
This will show your key generation portal and a table of your keys.
2
Configure your Key
Fill in the following fields to configure your API key:
Key Name: Enter a descriptive name for your API key (e.g., example-api-key)
Key Level: Choose the access scope for your key:
User Level: Access all your projects
Project Level: Access one specific project (requires selecting a project)
User Level - Access all projects
If you select Project Level, an additional dropdown will appear to select the specific project:
Project Level - Access a specific project
3
Create your Key
When ready, click Create API Key to generate the key.
4
View API keys
That’s it! You have now generated an API key that can be used to authenticate requests to the Wellows API.
Your key will be displayed in a table along with other keys you generate. Return to this page at any time to see your keys, check expiry dates, or revoke an existing key.
Your API key is sensitive information. Never share it publicly or commit it to version control. Store it securely and treat it like a password.
Your API key access level determines what data you can retrieve:
Key Level
Description
Project Header
User Level
Access all projects owned by your account
X-Project-ID required except for /validate and /projects endpoints
Project Level
Scoped to a single project
Not needed
When using a User Level key, you must include the X-Project-ID header to specify which project you want to access except for /validate and /projects endpoints
If you encounter authentication issues or need to request API access, contact our support team for assistance.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Wellows Documentation","colors":{"primary":"#0554F2","light":"#C5DBFF","dark":"#00153E"},"logo":{"light":"https://app.wellows.com/media/app/logo-main.png","dark":"https://app.wellows.com/media/app/logo-white.png"},"favicon":"https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/favicon-32x32.png?fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=625ed5cacb8a7aa6e6786467f7146dcb","navbar":{"links":[{"href":"mailto:support@wellows.com","label":"Support"}]},"footer":{"socials":{"youtube":"https://www.youtube.com/@wellowsofficial","linkedin":"https://www.linkedin.com/company/wellowsofficial"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"website","href":"https://wellows.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"wellows","hasAudioNarration":false,"actualSubdomain":"wellows","customDomains":["docs.wellows.com"],"gitSource":{"type":"github","owner":"wellows","repo":"wellows-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a6b4c36d13fba52b6735c2c","collectionId":"2e5805a6-3dc3-4f07-8451-68705affce1d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a6b4c36d13fba52b6735c2c"},"entitlements":{},"buildId":"6ae946b73da74a958a8e3e3b:success","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":" REST API","count":6},{"language":"default","tag":"Endpoint examples","count":4},{"language":"default","tag":"Overview","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"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":"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},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/authentication","slug":"/api-reference/authentication","pageMetadata":{"title":"Authentication","description":"Learn how to authenticate API requests securely","icon":"lock","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: \"Learn how to authenticate API requests securely\"\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`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Check,CodeBlock,Frame,Heading,Info,OptimizedImage,Step,Steps,Table,Warning}=_components;if(!Check)_missingMdxReference(`Check`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`overview`,children:`Overview`}),`\n`,_jsx(_components.p,{children:`To authenticate your API requests, you need an API key. This key identifies and authorizes your requests, ensuring only authorized users can access resources.`}),`\n`,_jsx(_components.p,{children:`Your API key provides access to all data available to your account, including projects, site summaries, and monitoring data. `}),`\n`,_jsx(Heading,{level:`2`,id:`getting-your-api-key`,children:`Getting Your API Key`}),`\n`,_jsx(_components.p,{children:`Follow these steps to obtain your API key:`}),`\n`,_jsxs(Steps,{children:[_jsxs(Step,{title:`Navigate to API Keys`,children:[_jsxs(_components.p,{children:[`Sign into the platform. In the bottom left, click on your name and select `,_jsx(_components.strong,{children:`API Keys`}),`.`]}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step1-api-keys.png?fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=1d7a067d36c45ebc1c417a681281f38f`,alt:`Navigate to API Keys`,\"data-og-width\":`1910`,width:`1910`,\"data-og-height\":`914`,height:`914`,\"data-path\":`images/api-keys/step1-api-keys.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step1-api-keys.png?w=280\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=38972136c5ed4533b46bcd971e4d2e93 280w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step1-api-keys.png?w=560\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=e401dc16b88a2cf1d46b0c5a141d79dc 560w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step1-api-keys.png?w=840\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=416ce039f6f80a54700b84976fceb680 840w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step1-api-keys.png?w=1100\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=e2aec4700687c3cc4013de6db9ea8225 1100w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step1-api-keys.png?w=1650\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=9afdededd16ac5f11e44ea9f8c1f377e 1650w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step1-api-keys.png?w=2500\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=27b54396fe8cd68b8d883f054d128dc8 2500w`})}),_jsx(_components.p,{children:`This will show your key generation portal and a table of your keys.`}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step1-api-key-2.png?fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=3008c9bfa91455211d26408f242815e9`,alt:`Navigate to APIeys`,\"data-og-width\":`1910`,width:`1910`,\"data-og-height\":`914`,height:`914`,\"data-path\":`images/api-keys/step1-api-key-2.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step1-api-key-2.png?w=280\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=159d3ed020378a63fccef961d5ff0774 280w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step1-api-key-2.png?w=560\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=ec1ea9fd61546d0c937bb5e39505e3a5 560w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step1-api-key-2.png?w=840\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=e4ad6c624ae36d257cd47b559c60a473 840w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step1-api-key-2.png?w=1100\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=e633d2533826a31bfc26d4dd4f7e3723 1100w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step1-api-key-2.png?w=1650\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=6c31a8a16372b0aa59484d37f078acea 1650w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step1-api-key-2.png?w=2500\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=a8091bb39aa8ea580b9d4a83f50a46ed 2500w`})})]}),_jsxs(Step,{title:`Configure your Key`,children:[_jsx(_components.p,{children:`Fill in the following fields to configure your API key:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Key Name`}),`: Enter a descriptive name for your API key (e.g., `,_jsx(_components.code,{children:`example-api-key`}),`)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Key Level`}),`: Choose the access scope for your key:`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`User Level`}),`: Access all your projects`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Project Level`}),`: Access one specific project (requires selecting a project)`]}),`\n`]}),`\n`]}),`\n`]}),_jsx(Frame,{caption:`User Level - Access all projects`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step2-configure-key-user.png?fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=864cceeac8a8cdfa0c3b58541522838a`,alt:`Configure API Key - User Level`,\"data-og-width\":`1910`,width:`1910`,\"data-og-height\":`914`,height:`914`,\"data-path\":`images/api-keys/step2-configure-key-user.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step2-configure-key-user.png?w=280\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=b21b2ad0b1ebd8b99b55bc74d8202ec3 280w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step2-configure-key-user.png?w=560\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=53a0804f35f8202ef32f3e225eb8e244 560w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step2-configure-key-user.png?w=840\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=d1ad10766c7f99e14e1789792c6cba6d 840w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step2-configure-key-user.png?w=1100\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=8a074dcf055929592174e6b25ab4a04c 1100w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step2-configure-key-user.png?w=1650\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=576a0c1a16fd58455c8059f6fd4348ba 1650w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step2-configure-key-user.png?w=2500\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=82cbdee4a523df82376419942fc4b6f5 2500w`})}),_jsxs(_components.p,{children:[`If you select `,_jsx(_components.strong,{children:`Project Level`}),`, an additional dropdown will appear to select the specific project:`]}),_jsx(Frame,{caption:`Project Level - Access a specific project`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step2-configure-key-project.png?fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=22af091e2e3c468eafa872037c14f4c5`,alt:`Configure API Key - Project Level`,\"data-og-width\":`1910`,width:`1910`,\"data-og-height\":`914`,height:`914`,\"data-path\":`images/api-keys/step2-configure-key-project.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step2-configure-key-project.png?w=280\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=bec433ff4397bc20b2167d52d071402d 280w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step2-configure-key-project.png?w=560\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=6f3d319455f5dbd544a75fb75e6d9074 560w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step2-configure-key-project.png?w=840\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=1536cb16b938ec288bb95b1898b667ff 840w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step2-configure-key-project.png?w=1100\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=81f4dc78e2d418b45cab5b3300b88258 1100w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step2-configure-key-project.png?w=1650\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=a756aea3877992d8a8abffa8a2e43135 1650w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step2-configure-key-project.png?w=2500\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=99eed75fc9c9c920498be92c16cd44e1 2500w`})})]}),_jsxs(Step,{title:`Create your Key`,children:[_jsxs(_components.p,{children:[`When ready, click `,_jsx(_components.strong,{children:`Create API Key`}),` to generate the key.`]}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step3-create-apikey.png?fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=ff69d43e316c4edd4621eac4125c1663`,alt:`Create your Key`,\"data-og-width\":`1910`,width:`1910`,\"data-og-height\":`914`,height:`914`,\"data-path\":`images/api-keys/step3-create-apikey.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step3-create-apikey.png?w=280\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=fd8a54d86bd1aff95405caa40d68d6fa 280w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step3-create-apikey.png?w=560\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=6744bb401f5166b9699881e3d5d4c059 560w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step3-create-apikey.png?w=840\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=9756737611d870b16d6027f2c3791b0c 840w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step3-create-apikey.png?w=1100\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=f80dcfd65988cb8b542f7eb1ac7930ef 1100w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step3-create-apikey.png?w=1650\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=36f198d593890662b19c5deca60db812 1650w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step3-create-apikey.png?w=2500\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=5e6a53514310f73c63f3d5758638ebb3 2500w`})})]}),_jsxs(Step,{title:`View API keys`,children:[_jsx(Check,{children:_jsx(_components.p,{children:`That’s it! You have now generated an API key that can be used to authenticate requests to the Wellows API.`})}),_jsx(_components.p,{children:`Your key will be displayed in a table along with other keys you generate. Return to this page at any time to see your keys, check expiry dates, or revoke an existing key.`}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step4-view-keys.png?fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=ee57ec1e6210dee01eb7325e83146a24`,alt:`View API keys`,\"data-og-width\":`1910`,width:`1910`,\"data-og-height\":`914`,height:`914`,\"data-path\":`images/api-keys/step4-view-keys.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step4-view-keys.png?w=280\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=03201d7d0b98fe016f75668daf55f571 280w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step4-view-keys.png?w=560\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=9f6206947256f72794b0fca08e37fb7c 560w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step4-view-keys.png?w=840\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=3979fa81b0ace1ef0def609f44e96a83 840w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step4-view-keys.png?w=1100\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=88b5205d5bf48e137b242b7ff32782a5 1100w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step4-view-keys.png?w=1650\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=0ca8f5dc8b4a5c1511322a01cbb5e87b 1650w, https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/images/api-keys/step4-view-keys.png?w=2500\u0026fit=max\u0026auto=format\u0026n=LA0e5Zk_k43SHwGv\u0026q=85\u0026s=8183bc3bdf809c69c24cf91016cbd22f 2500w`})})]})]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Your API key is sensitive information. Never share it publicly or commit it to version control. Store it securely and treat it like a password.`})}),`\n`,_jsx(Heading,{level:`2`,id:`authentication-method`,children:`Authentication Method`}),`\n`,_jsxs(_components.p,{children:[`Include your API key in the `,_jsx(_components.code,{children:`X-API-Key`}),` header for all requests:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,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:`3`,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:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` GET`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://integrations.wellows.com/api/v1/validate\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_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_here\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`api-key-scope-\u0026-permissions`,children:`API Key Scope \u0026 Permissions`}),`\n`,_jsx(_components.p,{children:`Your API key access level determines what data you can retrieve:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Key Level`}),_jsx(_components.th,{children:`Description`}),_jsx(_components.th,{children:`Project Header`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`User Level`})}),_jsx(_components.td,{children:`Access all projects owned by your account`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`X-Project-ID`}),` required except for `,_jsx(_components.code,{children:`/validate`}),` and `,_jsx(_components.code,{children:`/projects`}),` endpoints`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Project Level`})}),_jsx(_components.td,{children:`Scoped to a single project`}),_jsx(_components.td,{children:`Not needed`})]})]})]}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[`When using a `,_jsx(_components.strong,{children:`User Level`}),` key, you must include the `,_jsx(_components.code,{children:`X-Project-ID`}),` header to specify which project you want to access except for `,_jsx(_components.code,{children:`/validate`}),` and `,_jsx(_components.code,{children:`/projects`}),` endpoints`]})}),`\n`,_jsx(Heading,{level:`2`,id:`security-best-practices`,children:`Security Best Practices`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Keep keys private`}),`: Never expose API keys in client-side code or public repositories`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Use environment variables`}),`: Store keys in environment variables or secure configuration files`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Rotate regularly`}),`: Consider rotating your API keys periodically for enhanced security`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Monitor usage`}),`: Check your API usage regularly to detect any unauthorized access`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`authentication-errors`,children:`Authentication Errors`}),`\n`,_jsx(_components.p,{children:`Common authentication errors and their meanings:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status Code`}),_jsx(_components.th,{children:`Error`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`401 Unauthorized`})}),_jsx(_components.td,{children:`Invalid API key`}),_jsx(_components.td,{children:`The provided API key is incorrect or expired`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`403 Forbidden`})}),_jsx(_components.td,{children:`Insufficient permissions`}),_jsx(_components.td,{children:`Your API key doesn’t have access to the requested resource`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`need-help`,children:`Need Help?`}),`\n`,_jsx(_components.p,{children:`If you encounter authentication issues or need to request API access, contact our support team for assistance.`})]})}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 API requests securely","icon":"lock","href":"/api-reference/authentication"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Overview","slug":"overview","depth":2,"children":[]},{"title":"Getting Your API Key","slug":"getting-your-api-key","depth":2,"children":[]},{"title":"Authentication Method","slug":"authentication-method","depth":2,"children":[]},{"title":"API Key Scope \u0026 Permissions","slug":"api-key-scope-\u0026-permissions","depth":2,"children":[]},{"title":"Security Best Practices","slug":"security-best-practices","depth":2,"children":[]},{"title":"Authentication Errors","slug":"authentication-errors","depth":2,"children":[]},{"title":"Need Help?","slug":"need-help","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"wellows","siteName":"Wellows Documentation","title":"Authentication - Wellows Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-06T06:59:47.925Z","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=\"Learn how to authenticate API requests securely\">\u003cmeta data-mint-head name=\"application-name\" content=\"Wellows Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/favicon-32x32.png?fit=max\u0026amp;auto=format\u0026amp;n=LA0e5Zk_k43SHwGv\u0026amp;q=85\u0026amp;s=625ed5cacb8a7aa6e6786467f7146dcb\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/favicon-32x32.png?fit=max\u0026amp;auto=format\u0026amp;n=LA0e5Zk_k43SHwGv\u0026amp;q=85\u0026amp;s=625ed5cacb8a7aa6e6786467f7146dcb\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/favicon-32x32.png?fit=max\u0026amp;auto=format\u0026amp;n=LA0e5Zk_k43SHwGv\u0026amp;q=85\u0026amp;s=625ed5cacb8a7aa6e6786467f7146dcb\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/png\" href=\"https://mintcdn.com/wellows/LA0e5Zk_k43SHwGv/favicon-32x32.png?fit=max\u0026amp;auto=format\u0026amp;n=LA0e5Zk_k43SHwGv\u0026amp;q=85\u0026amp;s=625ed5cacb8a7aa6e6786467f7146dcb\">\u003cmeta data-mint-head property=\"og:title\" content=\"Authentication - Wellows Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Learn how to authenticate API requests securely\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Wellows Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.wellows.com/api-reference/authentication\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://wellows.mintlify.app/_mintlify/api/og/v2?division=Overview\u0026amp;title=Authentication\u0026amp;description=Learn+how+to+authenticate+API+requests+securely\u0026amp;theme=544c3041b135c0620c08ffa5\u0026amp;signature=2e0c6143332989d6bb4eec419718594072c48bc6667b18f500f0d4a18dfe5ead\">\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 - Wellows Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Learn how to authenticate API requests securely\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://wellows.mintlify.app/_mintlify/api/og/v2?division=Overview\u0026amp;title=Authentication\u0026amp;description=Learn+how+to+authenticate+API+requests+securely\u0026amp;theme=544c3041b135c0620c08ffa5\u0026amp;signature=2e0c6143332989d6bb4eec419718594072c48bc6667b18f500f0d4a18dfe5ead\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/wellows/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Wellows Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0554F2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.wellows.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.wellows.com/#organization\",\"name\":\"Wellows Documentation\",\"url\":\"https://docs.wellows.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://app.wellows.com/media/app/logo-main.png\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.wellows.com#website\",\"name\":\"Wellows Documentation\",\"url\":\"https://docs.wellows.com\",\"publisher\":{\"@id\":\"https://docs.wellows.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.wellows.com/api-reference/authentication#webpage\",\"url\":\"https://docs.wellows.com/api-reference/authentication\",\"name\":\"Authentication\",\"description\":\"Learn how to authenticate API requests securely\",\"dateModified\":\"2026-02-06T06:59:47.925Z\",\"isPartOf\":{\"@id\":\"https://docs.wellows.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.wellows.com/api-reference/authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.wellows.com/api-reference/authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Overview\",\"item\":\"https://docs.wellows.com/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authentication\",\"item\":\"https://docs.wellows.com/api-reference/authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.wellows.com/api-reference/authentication#article\",\"headline\":\"Authentication\",\"name\":\"Authentication\",\"description\":\"Learn how to authenticate API requests securely\",\"url\":\"https://docs.wellows.com/api-reference/authentication\",\"mainEntityOfPage\":{\"@id\":\"https://docs.wellows.com/api-reference/authentication#webpage\"},\"dateModified\":\"2026-02-06T06:59:47.925Z\",\"publisher\":{\"@id\":\"https://docs.wellows.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.wellows.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Wellows Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Wellows Documentation","nav":{"global":{"anchors":[{"anchor":"Website","icon":"website","href":"https://wellows.com/"}]},"tabs":[{"tab":" REST API","groups":[{"group":"Overview","icon":"book-open","pages":[{"title":"Introduction","description":"An overview of the REST API and its capabilities","icon":"code","href":"/api-reference/introduction"},{"title":"Authentication","icon":"lock","href":"/api-reference/authentication"}]},{"group":"Endpoint examples","pages":[{"title":"Validate API Key","openapi":"GET /validate","description":"Validate an API key and return its details.\n\nUse this endpoint to verify that an API key is valid.","href":"/api-reference/endpoint/validate"},{"title":"List Projects","openapi":"GET /projects","href":"/api-reference/endpoint/projects"},{"title":"Get Overview","openapi":"GET /overview","href":"/api-reference/endpoint/overview"},{"title":"Get Monitoring","openapi":"GET /monitoring","href":"/api-reference/endpoint/monitoring"}]}]}]},"basePath":"","title":"Authentication - Wellows Documentation","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-PS-3COT9.js","DynamicMarkdown-BcnBltEQ.js","zoom-image-lightbox-B4-wUcHm.js","lightbox-handle-r17bVUz3.js"]}
