Documentação da API Style Config#

URL Base: https://api.ideal.house
Versão: v1
Atualizado: 2026-05-21

📖 Visão Geral#

O endpoint Style Config da API retorna grupos de opções de estilo usados pelas APIs de geração. Essas opções fornecem IDs válidos para campos de solicitação como styleId, roomId, indoorStyleId, sceneId e outros parâmetros de estilo similares.

As páginas de recursos suportadas incluem:

Os arquivos de recursos atuais incluem virtual-staging.json, portanto virtual_staging é o nome de ferramenta de trabalho para o Virtual Staging. O erro de digitação virual_staging não é respaldado pelo arquivo de recursos atual e retorna conteúdo vazio. Qualquer toolName não suportado retorna conteúdo vazio.

🔐 Autenticação#

📌 Endpoint da API#

Obter Style Config#

Endpoint

GET /api/v1/style/{toolName}/getStyles

Cabeçalhos da Solicitação

Parâmetros de Caminho

📥 Exemplo de Requisição#

curl -X GET "https://api.ideal.house/api/v1/style/change_furniture/getStyles" \
  -H "APIKEY: your_api_key_here"

📤 Estrutura da Resposta#

O corpo da resposta é agrupado por categoria de estilo. Cada categoria mapeia para um parâmetro de solicitação por meio de backendParamKey.

{
  "code": 0,
  "message": "success",
  "data": {
    "roomType": {
      "backendParamKey": "indoorTypeId",
      "options": [
        {
          "name": {
            "en": "Living Room",
            "zh-CN": "客厅"
          },
          "id": "Interior Design_Interior Scene_Living Room",
          "url": "https://example.com/style-preview.webp"
        }
      ]
    }
  }
}

Alguns campos de solicitação suportam múltiplos IDs de opção. Para esses campos, una os valores de id selecionados com vírgula, por exemplo id1,id2.

🧭 Mapeamento de Nome da Ferramenta#

Visualizador de Plantas#

GET /api/v1/style/ai_plan_visualizer/getStyles

Troca de Móveis#

GET /api/v1/style/change_furniture/getStyles

Reformador de Fachadas#

GET /api/v1/style/exterior_renovator/getStyles

Decoração para Casa#

GET /api/v1/style/home_decor_ideas/getStyles

Remodelação de Interiores#

GET /api/v1/style/interoir_remodel/getStyles

Paisagismo#

GET /api/v1/style/landscaping/getStyles

Staging Virtual#

GET /api/v1/style/virtual_staging/getStyles

❌ Respostas de Erro#

Para valores de toolName não suportados, o endpoint retorna conteúdo vazio em data.