Authentication

All V3 API endpoints require an API key passed as an HTTP header on every request.

x-api-key: <your_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 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:

curl 'https://api.aihomedesign.com/v3/project' \
  --header 'x-api-key: <your_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