Credentials and environments#

AI API requests use an API key belonging to your Ideal House API account. Keep it on your server and send it in the APIKEY request header.

Obtain an API key#

1. Sign in to the AI API Console.
2. Open the API key controls and generate or select the key for your integration.
3. Store it in your server's secret manager or environment configuration. Do not commit it to source control or include it in a browser bundle.

Reading these documents does not create an API key or grant access to an account.

Configure the request environment#

Use the Base URL and request path stated in the selected API reference. For example, references that specify https://api.ideal.house use that API host, not the documentation URL.

Keep the API key in a server-only environment variable such as IDEALHOUSE_API_KEY. This is an example variable name for your application; it is not an SDK setting. A request should include the following header, with the placeholder replaced on your server:

APIKEY: YOUR_API_KEY

Follow the endpoint's required content type, fields and image input format. For asynchronous operations, retain the returned task ID and use the result endpoint documented for that operation.

Development and production#

Run local tests through your backend so the key remains private. Configure your deployment secrets before publishing, and check pricing, task limits and credit deductions. Test requests can use account credits; these guides do not promise a separate free sandbox.

Merchant Shop ID, Publishable Key and Product Import Client Secret belong to the Visualizer SDK integration. They do not replace an AI API key. The merchant Dashboard's Allowed Origins (CORS) setting is for the Visualizer integration, not the setup step for server-side AI API requests.

Verify authentication#

Follow Quick Start, then check the operation-specific response. If authentication fails, verify the APIKEY header and consult error codes. Remove keys from logs and support screenshots.