Docs

API Documentation

Quick Start

This guide helps you go from zero to your first successful API call.

1. Get API Access

  • Sign in to your Ideal House account
  • Open the API section and generate an API key

2. Pick an Endpoint

Start with one of these common endpoints:

  • Texture Replacer API
  • Smart Replace API
  • Photo Enhancer API

3. Send a Request

  • Use your API key in request headers
  • Upload an image or provide an image URL, depending on endpoint requirements
  • Save the returned task ID if the endpoint is asynchronous

4. Poll Result (if needed)

  • Query the result endpoint using the task ID
  • Handle success, failure, and timeout states in your app logic

5. Production Checklist

  • Add retry and timeout handling
  • Add request logging and error monitoring
  • Review Pricing and set budget alerts