AI HomeDesign API Docs
  • introduction
    • Getting Started
    • API Key
    • How to Use the API Key?
    • Step-by-Step Guide
  • API Endpoints
    • Getting Started with API Endpoints
    • Image Upload
    • Submit Order
      • AI Virtual Staging
      • AI Interior Design
      • AI Image Enhancement
      • AI Day to Dusk
      • AI Item Removal
      • AI Item Removal Mask
    • Get Spaces
    • Get Widgets and Items
    • Get Order Details
    • Generated Image Webhook
    • Upscale Download Webhook
    • Code Examples
      • Mask Canvas
    • Postman Workspace
  • Usage Limits and Policies
    • Rate Limit
  • Support and Contact
    • Help & Support
    • FAQs
Powered by GitBook
On this page
  1. introduction

API Key

How to Access Your AI HomeDesign API Key

PreviousGetting StartedNextHow to Use the API Key?

Last updated 5 months ago

  1. Sign up on

  2. To access the API key, you need to subscribe to one of our Enterprise plans.

  3. After subscribing to an Enterprise plan, click the icon next to the "All Tools" button. From there, select "API Key" to access your key.

In this section, you can view your API key or generate a new one by clicking the "Regenerate" button.

Please note that if you reset your API key, the current key will be permanently deleted and cannot be recovered, so proceed with caution.

Set your Webhook

You can also view webhook logs here to monitor and troubleshoot your webhook activity.

What is Webhook and why do I need it?

A webhook is a way for one application to send real-time updates to another application. It's like setting up a callback URL where you'll automatically receive notifications when an event occurs—no need to keep checking manually!

In this case, you need a webhook to receive the generated image URL (after_src) once your order is processed. This ensures you get the results instantly without delays or manual intervention. Set it up in the API-access section of your dashboard to get started!

You need to configure your webhook endpoint on the page. Your endpoint will be called whenever your images (order) are processed.

API Access
Learn more about Webhooks
AIHomeDesign.com.