API Documentation
  • Introduction
  • API Reference
  • 🔐Authentication
  • Core APIs
    • Perfect Redesign
    • Beautiful Redesign
    • Creative Redesign
    • Sketch to Render
    • Virtual staging
    • Precision
    • Fill Spaces
    • Decor Staging
    • Furniture Removal
    • Colors & Textures
    • Furniture Finder
    • Full HD
    • Text to design
    • Furniture Creator
    • Design Advisor
    • Sky Colors
    • Design Transfer
    • Floor Editor
    • Paint Visualizer
    • Material Swap
    • Room Composer
    • Design Critique
    • Create Mask Image
    • Download Generated Images
    • Smart Home AI
  • DESIGN SCOPE
    • Interiors
      • Design Styles for Interiors
      • Room Types
      • Colors in Interior Design
      • Explore Material Options for Interior Designs
    • Exteriors
      • Design Styles for Exteriors
      • Copy of Design Styles for Exteriors
      • House angles
      • Exterior Colors
      • Material Options for Exterior Designs
    • Gardens
      • Design Styles for Gardens
      • Garden Types
      • Explore Color Options for Garden Designs
      • Material Options for Garden Designs
  • Data
    • User Details
    • Design Scope
  • Others
    • What is Masked Image?
Powered by GitBook
On this page

Was this helpful?

  1. Core APIs

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

POST /furniture_finder

An API URL would be like https://homedesigns.ai/api/v2/furniture_finder

This endpoint identify the furniture and decor in the images and possible recommendations purchasable alternatives.

An API request must be in the form-data format.

Request

Parameters & Data Type
Value
Description

image

file[ .jpg, .jpeg, .png] / base64 Image string

-

The image to be processed by the API. The image dimensions must be 512x512 pixels or greater for optimal results. (Required Parameter) Without selecting a country code, the result will be given in worldwide.

countryCode (optional)string

country code as per the suggested code

The country code should be in [AE, AF, AG, AI, etc.]. You can choose your country code from the suggested country code tab.

Parameters & Errors

image

Error Messages
Reason

Image field required

Image not provided

Invalid image format. Only PNG, JPEG and JPG images are allowed.

Image Format not valid.

countryCode

Error Messages
Reason

Country code should be proper in [AE, AF, AG, AI, etc.]

Country code is wrong

No Furniture Found for selected country.

Furnture not found.

//Output should be in list of array depends on no of designs as shown below:

"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 & 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"
        },
    ...
    ...
    ]
}

It would be helpful for your understanding. You can select a countryCode from the suggested country names and codes below.

Country Code
Country Name

AE

United Arab Emirates

AF

Afghanistan

AG

Antigua and Barbuda

AI

Anguilla

AL

Albania

AM

Armenia

AO

Angola

AR

Argentina

AT

Austria

AU

Australia

AW

Aruba

AZ

Azerbaijan

BA

Bosnia and Herzegovina

BB

Barbados

BD

Bangladesh

BE

Belgium

BG

Bulgaria

BH

Bahrain

BJ

Benin

BN

Brunei

BO

Bolivia

BR

Brazil

BS

Bahamas

BW

Botswana

BY

Belarus

BZ

Belize

CA

Canada

CG

Republic of the Congo

CH

Switzerland

CI

Ivory Coast (Côte d'Ivoire)

CL

Chile

CM

Cameroon

CN

China

CO

Colombia

CR

Costa Rica

CV

Cape Verde

CY

Cyprus

CZ

Czech Republic

DE

Germany

DK

Denmark

DO

Dominican Republic

DZ

Algeria

EC

Ecuador

EE

Estonia

EG

Egypt

ES

Spain

ET

Ethiopia

FI

Finland

FR

France

GB

United Kingdom

GE

Georgia

GH

Ghana

GP

Guadeloupe

GR

Greece

GT

Guatemala

GY

Guyana

HK

Hong Kong

HN

Honduras

HR

Croatia

HT

Haiti

HU

Hungary

ID

Indonesia

IE

Ireland

IL

Israel

IN

India

IQ

Iraq

IR

Iran

IS

Iceland

IT

Italy

JM

Jamaica

JO

Jordan

JP

Japan

KE

Kenya

KG

Kyrgyzstan

KH

Cambodia

KR

South Korea

KW

Kuwait

KY

Cayman Islands

KZ

Kazakhstan

LA

Laos

LB

Lebanon

LC

Saint Lucia

LK

Sri Lanka

LT

Lithuania

LU

Luxembourg

LV

Latvia

LY

Libya

MA

Morocco

MD

Moldova

ME

Montenegro

MG

Madagascar

MK

North Macedonia

ML

Mali

MM

Myanmar (Burma)

MN

Mongolia

MO

Macau

MQ

Martinique

MT

Malta

MU

Mauritius

MV

Maldives

MX

Mexico

MY

Malaysia

MZ

Mozambique

NA

Namibia

NC

New Caledonia

NG

Nigeria

NI

Nicaragua

NL

Netherlands

NO

Norway

NP

Nepal

NZ

New Zealand

OM

Oman

PA

Panama

PE

Peru

PH

Philippines

PK

Pakistan

PL

Poland

PR

Puerto Rico

PS

Palestine

PT

Portugal

PY

Paraguay

QA

Qatar

RE

Réunion

RO

Romania

RS

Serbia

RU

Russia

SA

Saudi Arabia

SC

Seychelles

SD

Sudan

SE

Sweden

SG

Singapore

SI

Slovenia

SK

Slovakia

SN

Senegal

SR

Suriname

SV

El Salvador

SY

Syria

TH

Thailand

TN

Tunisia

TR

Turkey

TT

Trinidad and Tobago

TW

Taiwan

TZ

Tanzania

UA

Ukraine

UG

Uganda

US

United States of America

UY

Uruguay

UZ

Uzbekistan

VC

Saint Vincent and the Grenadines

VE

Venezuela

VN

Vietnam

XK

Kosovo

YE

Yemen

ZA

South Africa

ZM

Zambia

ZW

Zimbabwe

PreviousColors & TexturesNextFull HD

Last updated 1 month ago

Was this helpful?

Page cover image