# Furniture Finder

The /furniture\_finder endpoint leverages advanced image recognition and AI algorithms to analyze images of interiors, identifying pieces of furniture and decor within them. Once identified, it automatically matches these items with real, purchasable products from a vast database of furniture retailers. This feature is designed to simplify the shopping experience, allowing users to recreate their desired interior looks with ease. It not only identifies the items but also provides users with direct links to stores where they can buy the exact or similar items.

## ENDPOINT 

<mark style="color:green;">**`POST`**</mark>  <mark style="color:purple;">**`/furniture_finder`**</mark>

An API URL would be like <mark style="color:blue;"><https://homedesigns.ai/api/v2/furniture\\_finder></mark>

{% hint style="info" %} <mark style="color:blue;">This endpoint identify the furniture and decor in the images and possible recommendations purchasable alternatives.</mark>
{% endhint %}

{% tabs %}
{% tab title="Request" %}
{% hint style="info" %} <mark style="color:blue;">An API request must be in the</mark> <mark style="color:orange;">**`form-data`**</mark> <mark style="color:blue;">format.</mark>
{% endhint %}

### Request

<table><thead><tr><th width="195">Parameters &#x26; Data Type</th><th width="181">Value</th><th>Description</th></tr></thead><tbody><tr><td><p><mark style="color:red;"><strong><code>image</code></strong></mark>  </p><p>file[ .jpg, .jpeg, .png] / base64 Image <mark style="color:green;"><code>string</code></mark></p></td><td>-</td><td>The image to be processed by the API. The image dimensions must be 512x512 pixels or greater for optimal results. <strong>(Required Parameter)</strong> Without selecting a country code, the result will be given in worldwide.</td></tr><tr><td><mark style="color:red;"><code>countryCode</code></mark> (optional)<mark style="color:green;"><code>string</code></mark></td><td>country code as per the suggested code</td><td>The country code should be in [AE, AF, AG, AI, etc.]. You can choose your country code from the suggested country code tab.</td></tr></tbody></table>
{% endtab %}

{% tab title="Errors" %}

### Parameters & Errors

<mark style="color:red;">**`image`**</mark>

<table><thead><tr><th width="289">Error Messages</th><th>Reason</th></tr></thead><tbody><tr><td>Image field required</td><td>Image not provided</td></tr><tr><td>Invalid image format. Only PNG, JPEG and JPG images are allowed.</td><td>Image Format not valid.</td></tr><tr><td></td><td></td></tr></tbody></table>

<mark style="color:red;">`countryCode`</mark>&#x20;

<table><thead><tr><th width="289">Error Messages</th><th>Reason</th></tr></thead><tbody><tr><td>Country code should be proper in [AE, AF, AG, AI, etc.]</td><td>Country code is wrong</td></tr><tr><td>No Furniture Found for selected country.</td><td>Furnture not found.</td></tr><tr><td></td><td></td></tr></tbody></table>
{% endtab %}

{% tab title="Response" %}

<pre class="language-json"><code class="lang-json"><strong>//Output should be in list of array depends on no of designs as shown below:
</strong>
"resultArray": {
    "chair": [
        {
            "position": 1,
            "title": "Holden 5-pc. Dining Set in Gray / Oak by Bellanest",
            "link": "https://www.raymourflanigan.com/dining-rooms/dining-sets/holden-5-pc-dining-set-799188618",
            "source": "Raymour &#x26; Flanigan",
            "source_icon": "https://encrypted-tbn1.gstatic.com/favicon-tbn?q=tbn:ANd9GcQviLFE8S5Lakv4ft5si8rvmCbjjubzLkrM2rsrE2BJadVHrEXD2qAMAYYgP7g8YYs7viaO_bJ_YQEkDqg02a8K3retpFWhrLo_LGGmy6uM4oHukovUYmbUZK87LQ",
            "rating": 4.8,
            "reviews": 74,
            "price": {
            "value": "$559.95*",
            "extracted_value": 559.95,
            "currency": "$"
            },
            "thumbnail": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcR0saUeTbtxIFPI28Re-pNucsslbtGq0ubsyuYz1LtpOb7UOqKH"
        },
    ...
    ...
    ]
}
</code></pre>

{% endtab %}

{% tab title="countryCode" %}
**It would be helpful for your understanding. You can select a countryCode from the suggested country names and codes below.**<br>

<table><thead><tr><th width="157">Country Code</th><th width="228">Country Name</th></tr></thead><tbody><tr><td>AE</td><td>United Arab Emirates</td></tr><tr><td>AF</td><td>Afghanistan</td></tr><tr><td>AG</td><td>Antigua and Barbuda</td></tr><tr><td>AI</td><td>Anguilla</td></tr><tr><td>AL</td><td>Albania</td></tr><tr><td>AM</td><td>Armenia</td></tr><tr><td>AO</td><td>Angola</td></tr><tr><td>AR</td><td>Argentina</td></tr><tr><td>AT</td><td>Austria</td></tr><tr><td>AU</td><td>Australia</td></tr><tr><td>AW</td><td>Aruba</td></tr><tr><td>AZ</td><td>Azerbaijan</td></tr><tr><td>BA</td><td>Bosnia and Herzegovina</td></tr><tr><td>BB</td><td>Barbados</td></tr><tr><td>BD</td><td>Bangladesh</td></tr><tr><td>BE</td><td>Belgium</td></tr><tr><td>BG</td><td>Bulgaria</td></tr><tr><td>BH</td><td>Bahrain</td></tr><tr><td>BJ</td><td>Benin</td></tr><tr><td>BN</td><td>Brunei</td></tr><tr><td>BO</td><td>Bolivia</td></tr><tr><td>BR</td><td>Brazil</td></tr><tr><td>BS</td><td>Bahamas</td></tr><tr><td>BW</td><td>Botswana</td></tr><tr><td>BY</td><td>Belarus</td></tr><tr><td>BZ</td><td>Belize</td></tr><tr><td>CA</td><td>Canada</td></tr><tr><td>CG</td><td>Republic of the Congo</td></tr><tr><td>CH</td><td>Switzerland</td></tr><tr><td>CI</td><td>Ivory Coast (Côte d'Ivoire)</td></tr><tr><td>CL</td><td>Chile</td></tr><tr><td>CM</td><td>Cameroon</td></tr><tr><td>CN</td><td>China</td></tr><tr><td>CO</td><td>Colombia</td></tr><tr><td>CR</td><td>Costa Rica</td></tr><tr><td>CV</td><td>Cape Verde</td></tr><tr><td>CY</td><td>Cyprus</td></tr><tr><td>CZ</td><td>Czech Republic</td></tr><tr><td>DE</td><td>Germany</td></tr><tr><td>DK</td><td>Denmark</td></tr><tr><td>DO</td><td>Dominican Republic</td></tr><tr><td>DZ</td><td>Algeria</td></tr><tr><td>EC</td><td>Ecuador</td></tr><tr><td>EE</td><td>Estonia</td></tr><tr><td>EG</td><td>Egypt</td></tr><tr><td>ES</td><td>Spain</td></tr><tr><td>ET</td><td>Ethiopia</td></tr><tr><td>FI</td><td>Finland</td></tr><tr><td>FR</td><td>France</td></tr><tr><td>GB</td><td>United Kingdom</td></tr><tr><td>GE</td><td>Georgia</td></tr><tr><td>GH</td><td>Ghana</td></tr><tr><td>GP</td><td>Guadeloupe</td></tr><tr><td>GR</td><td>Greece</td></tr><tr><td>GT</td><td>Guatemala</td></tr><tr><td>GY</td><td>Guyana</td></tr><tr><td>HK</td><td>Hong Kong</td></tr><tr><td>HN</td><td>Honduras</td></tr><tr><td>HR</td><td>Croatia</td></tr><tr><td>HT</td><td>Haiti</td></tr><tr><td>HU</td><td>Hungary</td></tr><tr><td>ID</td><td>Indonesia</td></tr><tr><td>IE</td><td>Ireland</td></tr><tr><td>IL</td><td>Israel</td></tr><tr><td>IN</td><td>India</td></tr><tr><td>IQ</td><td>Iraq</td></tr><tr><td>IR</td><td>Iran</td></tr><tr><td>IS</td><td>Iceland</td></tr><tr><td>IT</td><td>Italy</td></tr><tr><td>JM</td><td>Jamaica</td></tr><tr><td>JO</td><td>Jordan</td></tr><tr><td>JP</td><td>Japan</td></tr><tr><td>KE</td><td>Kenya</td></tr><tr><td>KG</td><td>Kyrgyzstan</td></tr><tr><td>KH</td><td>Cambodia</td></tr><tr><td>KR</td><td>South Korea</td></tr><tr><td>KW</td><td>Kuwait</td></tr><tr><td>KY</td><td>Cayman Islands</td></tr><tr><td>KZ</td><td>Kazakhstan</td></tr><tr><td>LA</td><td>Laos</td></tr><tr><td>LB</td><td>Lebanon</td></tr><tr><td>LC</td><td>Saint Lucia</td></tr><tr><td>LK</td><td>Sri Lanka</td></tr><tr><td>LT</td><td>Lithuania</td></tr><tr><td>LU</td><td>Luxembourg</td></tr><tr><td>LV</td><td>Latvia</td></tr><tr><td>LY</td><td>Libya</td></tr><tr><td>MA</td><td>Morocco</td></tr><tr><td>MD</td><td>Moldova</td></tr><tr><td>ME</td><td>Montenegro</td></tr><tr><td>MG</td><td>Madagascar</td></tr><tr><td>MK</td><td>North Macedonia</td></tr><tr><td>ML</td><td>Mali</td></tr><tr><td>MM</td><td>Myanmar (Burma)</td></tr><tr><td>MN</td><td>Mongolia</td></tr><tr><td>MO</td><td>Macau</td></tr><tr><td>MQ</td><td>Martinique</td></tr><tr><td>MT</td><td>Malta</td></tr><tr><td>MU</td><td>Mauritius</td></tr><tr><td>MV</td><td>Maldives</td></tr><tr><td>MX</td><td>Mexico</td></tr><tr><td>MY</td><td>Malaysia</td></tr><tr><td>MZ</td><td>Mozambique</td></tr><tr><td>NA</td><td>Namibia</td></tr><tr><td>NC</td><td>New Caledonia</td></tr><tr><td>NG</td><td>Nigeria</td></tr><tr><td>NI</td><td>Nicaragua</td></tr><tr><td>NL</td><td>Netherlands</td></tr><tr><td>NO</td><td>Norway</td></tr><tr><td>NP</td><td>Nepal</td></tr><tr><td>NZ</td><td>New Zealand</td></tr><tr><td>OM</td><td>Oman</td></tr><tr><td>PA</td><td>Panama</td></tr><tr><td>PE</td><td>Peru</td></tr><tr><td>PH</td><td>Philippines</td></tr><tr><td>PK</td><td>Pakistan</td></tr><tr><td>PL</td><td>Poland</td></tr><tr><td>PR</td><td>Puerto Rico</td></tr><tr><td>PS</td><td>Palestine</td></tr><tr><td>PT</td><td>Portugal</td></tr><tr><td>PY</td><td>Paraguay</td></tr><tr><td>QA</td><td>Qatar</td></tr><tr><td>RE</td><td>Réunion</td></tr><tr><td>RO</td><td>Romania</td></tr><tr><td>RS</td><td>Serbia</td></tr><tr><td>RU</td><td>Russia</td></tr><tr><td>SA</td><td>Saudi Arabia</td></tr><tr><td>SC</td><td>Seychelles</td></tr><tr><td>SD</td><td>Sudan</td></tr><tr><td>SE</td><td>Sweden</td></tr><tr><td>SG</td><td>Singapore</td></tr><tr><td>SI</td><td>Slovenia</td></tr><tr><td>SK</td><td>Slovakia</td></tr><tr><td>SN</td><td>Senegal</td></tr><tr><td>SR</td><td>Suriname</td></tr><tr><td>SV</td><td>El Salvador</td></tr><tr><td>SY</td><td>Syria</td></tr><tr><td>TH</td><td>Thailand</td></tr><tr><td>TN</td><td>Tunisia</td></tr><tr><td>TR</td><td>Turkey</td></tr><tr><td>TT</td><td>Trinidad and Tobago</td></tr><tr><td>TW</td><td>Taiwan</td></tr><tr><td>TZ</td><td>Tanzania</td></tr><tr><td>UA</td><td>Ukraine</td></tr><tr><td>UG</td><td>Uganda</td></tr><tr><td>US</td><td>United States of America</td></tr><tr><td>UY</td><td>Uruguay</td></tr><tr><td>UZ</td><td>Uzbekistan</td></tr><tr><td>VC</td><td>Saint Vincent and the Grenadines</td></tr><tr><td>VE</td><td>Venezuela</td></tr><tr><td>VN</td><td>Vietnam</td></tr><tr><td>XK</td><td>Kosovo</td></tr><tr><td>YE</td><td>Yemen</td></tr><tr><td>ZA</td><td>South Africa</td></tr><tr><td>ZM</td><td>Zambia</td></tr><tr><td>ZW</td><td>Zimbabwe</td></tr></tbody></table>
{% endtab %}
{% endtabs %}