> For the complete documentation index, see [llms.txt](https://doc.aihomedesign.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.aihomedesign.com/getting-started/authentication.md). # Authentication All V3 API endpoints require an **API key** passed as an HTTP header on every request. ``` x-api-key: ``` > **Security tip:** Treat your API key like a password. Never expose it in client-side code or public repositories. If your key is compromised, regenerate it immediately. *** ### Generating an API Key The images below show how to upgrade to the Enterprise plan and generate your API key. Follow the highlighted steps to access API features and create your key successfully. Go to [AI HomeDesign Dashboard](https://app.aihomedesign.com/) and sign in to your account. Once you are on the dashboard, locate the left sidebar navigation menu and click the **Pricing** icon to view available subscription plans and upgrade to the Enterprise plan.
On the Pricing page, select the **Enterprise Plan** and complete the upgrade process to unlock API access and enable API key generation.
After completing the upgrade, a new **API** icon will appear in the left sidebar of your dashboard. Click the **API** section to access and manage your private API key.
Use your private API key in the request headers when making API calls. For security purposes, you can regenerate your private API key at any time from the **API** section of the dashboard. *** ### Using Your API Key Include the key in the `x-api-key` header on every request: ```bash curl 'https://api.aihomedesign.com/v3/project' \ --header 'x-api-key: ' ``` *** ### Common Auth Errors | Status | Meaning | What to check | | ------------------ | ---------------------------------------------- | -------------------------------------------------------------------- | | `401 Unauthorized` | API key is missing or invalid | Make sure the header is spelled `x-api-key` and the value is correct | | `403 Forbidden` | Key is valid but lacks access to this resource | Contact support — your plan may not include the requested tool | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://doc.aihomedesign.com/getting-started/authentication.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.