3vjia Technology

3vjia Technology Light Design API

轻设计

GitHub OpenAPI

Operations 16

POST /api/aiDrawImageResult/listByPage 分页查询AI出图结果 #
POST /api/kgmaterial/pageKgMagerial 分页获取规则或系列关联的图谱素材 #
POST /api/layoutCabinetCustomMaterial/listByPage 分页查询套系素材自定义替换关联 #
POST /api/layoutCabinetCustomMaterial/listCategoryByMaterialIds 根据素材ID和替换素材ID列表查询去重后的分类 #
POST /api/layoutScheme/adminListByPage 管理员分页查询企业下布局方案 #
POST /api/metaTenantMaterial/listByPage 分页查询企业自定义图元素材 #
POST /api/modelocMaterialCategory/listByPage 分页查询模型位素材分类目录配置 #
POST /api/ruleseedscheme/pageRelatedScheme 获取规则关联的种子方案 默认查询已发布 #
POST /api/v1/layoutScheme/get 获取布局模板方案表详情 #
POST /api/v1/layoutScheme/getDetail 根据ID获取方案详情,包含户型信息(若有) #
POST /api/v1/layoutScheme/save 保存布局模板方案 #
POST /api/v1/layoutSchemeFiles/listByPage 分页查询布局方案附件信息 #
POST /api/v1/layoutSchemeViewEffects/pageViewImage 分页查询布局视角效果图 #
POST /api/v1/queueok/listEffectsByPage 获取效果图分页列表 #
POST /api/vrrule/getAllMaterialSelectSort 获取选择素材分类列表结构目录 #
POST /api/vrrule/getDesignMaterials 分页查询素材列表 #

Documentation

📖
Documentation
https://dev.3vjia.com/v1/document
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/3vjia-technology/refs/heads/main/authentication/3vjia-technology-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/3vjia-technology/refs/heads/main/rate-limits/3vjia-technology-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/3vjia-technology/refs/heads/main/openapi/3vjia-technology-light-design-api-openapi.yml

Other Resources

🔗
DeveloperPortal
https://dev.3vjia.com/
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/3vjia-technology/refs/heads/main/asyncapi/3vjia-technology-webhooks.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/3vjia-technology/refs/heads/main/errors/3vjia-technology-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/3vjia-technology/refs/heads/main/conventions/3vjia-technology-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/3vjia-technology/refs/heads/main/data-model/3vjia-technology-data-model.yml
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/3vjia-technology/refs/heads/main/mcp/3vjia-technology-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/3vjia-technology-light-design-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

3vjia-technology-light-design-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: 3vjia Open Platform Light Design API
  version: '2026-09-05'
  summary: Home-furnishing 3D cloud design, quotation, order, manufacturing (AIMES/MOS/DMS) and AI operations exposed by the 3vjia (三维家) Open Platform.
  description: Machine-readable description of the 3vjia (三维家 / AiHouse) Open Platform, DERIVED — not published by the provider in this form.
  contact:
    name: 3vjia Open Platform
    url: https://dev.3vjia.com/
servers:
- url: https://open-gateway.3vjia.com
  description: 3vjia Open Platform gateway (current)
- url: https://open.3vjia.com
  description: Legacy open gateway — takes ?sysCode=external&access_token=
security:
- oauth2ClientCredentials: []
tags:
- name: Light Design
  description: 轻设计
paths:
  /api/aiDrawImageResult/listByPage:
    post:
      operationId: apiAiDrawImageResultListByPage
      summary: 分页查询AI出图结果
      tags:
      - Light Design
      x-source-documentation: https://dev.3vjia.com/document?apiId=832299125029617719
      x-documentation-category: 轻设计
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                createDateEnd:
                  type: string
                  description: 创建时间结束日期
                createDateStart:
                  type: string
                  description: 创建时间开始日期
                createUser:
                  type: string
                  description: 创建人ID
                drawImageId:
                  type: string
                  description: 绘图任务ID
                ids:
                  type: array
                  items: {}
                  description: "This is List Type  \nID"
                imageResult:
                  type: string
                  description: 图片结果url
                isDelete:
                  type: integer
                  format: int32
                  description: 删除1是0否
                layoutId:
                  type: string
                  description: 户型ID
                layoutSchemeId:
                  type: string
                  description: 方案ID
                orderBy:
                  type: string
                  description: 排序
                pageIndex:
                  type: integer
                  format: int32
                  description: 页码
                pageSize:
                  type: integer
                  format: int32
                  description: 页容量
                roomId:
                  type: string
                  description: 房间ID
                roomName:
                  type: string
                  description: 房间名称
                updateDateEnd:
                  type: string
                  description: 更新时间结束日期
                updateDateStart:
                  type: string
                  description: 更新时间开始日期
                updateUser:
                  type: string
                  description: 更新人ID
                aiModel:
                  type: integer
                  format: int32
                  description: 出图模式0效果图1全景
                layoutName:
                  type: string
                  description: 方案名称
                viewAngleName:
                  type: string
                  description: 视角名称
            example:
              drawImageId: ''
              layoutSchemeId: ''
              isDelete: 0
              orderBy: ''
              pageSize: 0
              updateUser: ''
              layoutId: ''
              roomId: ''
              roomName: ''
              layoutName: ''
              createDateStart: ''
              pageIndex: 0
              updateDateStart: ''
              updateDateEnd: ''
              ids: []
              imageResult: ''
              createUser: ''
              aiModel: 0
              viewAngleName: ''
              createDateEnd: ''
      responses:
        '200':
          description: 成功 / OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: 请求是否成功 / whether the call succeeded
                  code:
                    type: integer
                    description: 结果码 / result code (0 = success)
                  msg:
                    type: string
                    description: 提示信息 / message
                  data:
                    type: object
                    properties:
                      pageIndex:
                        type: integer
                        format: int32
                      pageSize:
                        type: integer
                        format: int32
                      recordCount:
                        type: integer
                        format: int32
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            aiModel:
                              type: integer
                              format: int32
                              description: 0效果图1全景图
                            createUser:
                              type: string
                              description: 创建人
                            id:
                              type: string
                              description: 图片ID
                            imageResult:
                              type: string
                              description: 图片url
                            layoutId:
                              type: string
                              description: 户型ID
                            layoutSchemeId:
                              type: string
                              description: 布局方案ID
                            roomId:
                              type: string
                              description: 房间ID
                            roomName:
                              type: string
                              description: 房间名称
                            viewAngleName:
                              type: string
                              description: 视角名称
                            createDate:
                              type: string
                              description: 创建时间
                            layoutName:
                              type: string
                              description: 布局方案名称
                            updateDate:
                              type: string
                              description: 更新时间
                            drawImageId:
                              type: string
                              description: 绘图任务ID
                        description: AI出图结果类
              example:
                msg: ''
                code: 0
                data:
                  recordCount: 0
                  pageSize: 0
                  result:
                  - drawImageId: ''
                    updateDate: ''
                    layoutSchemeId: ''
                    layoutId: ''
                    roomId: ''
                    roomName: ''
                    layoutName: ''
                    imageResult: ''
                    createUser: ''
                    aiModel: 0
                    id: ''
                    viewAngleName: ''
                    createDate: ''
                  pageIndex: 0
                success: false
        '401':
          description: access_token 缺失或已过期 / missing or expired access_token
  /api/kgmaterial/pageKgMagerial:
    post:
      operationId: apiKgmaterialPageKgMagerial
      summary: 分页获取规则或系列关联的图谱素材
      tags:
      - Light Design
      x-source-documentation: https://dev.3vjia.com/document?apiId=844215383568322627
      x-documentation-category: 轻设计
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                applySpace:
                  type: string
                  description: 空间名称
                isPlatform:
                  type: integer
                  format: int32
                  description: 是否查询平台套系对应模型位数据1是0否默认0
                keyword:
                  type: string
                  description: 素材ID或素材名称搜索关键字
                lengthMax:
                  type: integer
                  format: int32
                  description: 素材长度最大值
                lengthMin:
                  type: integer
                  format: int32
                  description: 素材长度最小值
                materialId:
                  type: string
                  description: 素材id
                materialName:
                  type: string
                  description: 素材名称
                modelLoc:
                  type: string
                  description: 模型位(新版图谱中文名)
                orderBy:
                  type: string
                  description: 排序
                pageIndex:
                  type: integer
                  format: int32
                  description: 页码
                pageSize:
                  type: integer
                  format: int32
                  description: 页容量
                ruleId:
                  type: string
                  description: 规则ID
                seriesId:
                  type: string
                  description: 规则/系列ID
                status:
                  type: integer
                  format: int32
                  description: 素材状态-1入库失败1入库中2入库成功
            example:
              lengthMax: 0
              isPlatform: 0
              orderBy: ''
              pageSize: 0
              materialId: ''
              modelLoc: ''
              seriesId: ''
              applySpace: ''
              materialName: ''
              lengthMin: 0
              pageIndex: 0
              keyword: ''
              ruleId: ''
              status: 0
      responses:
        '200':
          description: 成功 / OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: 请求是否成功 / whether the call succeeded
                  code:
                    type: integer
                    description: 结果码 / result code (0 = success)
                  msg:
                    type: string
                    description: 提示信息 / message
                  data:
                    type: object
                    properties:
                      pageIndex:
                        type: integer
                        format: int32
                      pageSize:
                        type: integer
                        format: int32
                      recordCount:
                        type: integer
                        format: int32
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            applySpace:
                              type: array
                              items: {}
                              description: "This is List Type  \n应用空间"
                            brushStyleList:
                              type: array
                              items:
                                type: object
                                properties:
                                  styleCode:
                                    type: string
                                    description: 风格刷唯一标识(固定传值)code全屋风格刷:styleBrushId厨房风格刷:kitchenBrushId背景墙风格刷:wallBrushId
                                  styleId:
                                    type: string
                                    description: 风格刷ID
                                  styleImage:
                                    type: string
                                    description: 封面图
                                  styleName:
                                    type: string
                                    description: 风格名称
                                  styleType:
                                    type: string
                                    description: 风格类别
                                  xmlDataUrl:
                                    type: string
                                    description: 风格刷对应数据URL
                              description: '*风格刷参数'
                            category:
                              type: string
                              description: 素材分类
                            circleShare:
                              type: integer
                              format: int32
                              description: 设计圈共享0否1是默认0
                            color:
                              type: string
                              description: 素材颜色
                            createTime:
                              type: string
                              description: 创建时间
                            customStyleIds:
                              type: array
                              items: {}
                              description: "This is List Type  \n所属规则/系列Ids"
                            groupName:
                              type: string
                              description: 素材组名称
                            groupType:
                              type: integer
                              format: int32
                              description: 素材组类型：1地板瓷砖、2墙体涂料、3模型、4墙体瓷砖、、6模型组合
                            height:
                              type: number
                              format: double
                              description: 高
                            id:
                              type: integer
                              format: int32
                              description: 主键id
                            imagePath:
                              type: string
                              description: 素材图片路径
                            is3d:
                              type: integer
                              format: int32
                              description: 3D启用1是0否默认0
                            isDirect:
                              type: integer
                              format: int32
                              description: 是否直接归属系列
                            isValid:
                              type: integer
                              format: int32
                              description: 禁用标识[0禁用1启用]默认1
                            kgId:
                              type: string
                              description: 图谱入库id
                            kgMaterialType:
                              type: string
                              description: 图谱模型分类名称
                            kgStatus:
                              type: integer
                              format: int32
                              description: 图谱入库状态：-1入库失败0未提交入库1入库中2入库成功
                            length:
                              type: number
                              format: double
                              description: 长
                            lengthMax:
                              type: integer
                              format: int32
                              description: 素材长度最大值
                            lengthMin:
                              type: integer
                              format: int32
                              description: 素材长度最小值
                            materialGroupId:
                              type: string
                              description: 素材组id
                            materialId:
                              type: string
                              description: 素材id
                            materialName:
                              type: string
                              description: 素材名称
                            materialSource:
                              type: string
                              description: 素材来源本机构/素材广场
                            materialStyle:
                              type: string
                              description: 素材风格
                            materialType:
                              type: integer
                              format: int32
                              description: 素材类型(1硬装、2软装、3定制)
                            modelFlag:
                              type: string
                              description: 模型类型标记
                            modelLoc:
                              type: string
                              description: 模型位(新版图谱中文名)
                            modellocId:
                              type: string
                              description: 模型位置id
                            modellocName:
                              type: string
                              description: 模型位置名称
                            msg:
                              type: string
                              description: msg
                            recommended:
                              type: boolean
                              description: 是否推荐素材
                            ruleId:
                              type: integer
                              format: int32
                              description: 设计规则id/系列ID
                            schemeType:
                              type: string
                              description: 方案种类cupboard:橱柜wardrobe:衣柜systemCabinet:系统柜
                            score:
                              type: number
                              format: float
                              description: 多模态分数
                            seedSchemeIds:
                              type: string
                              description: 种子方案ids
                            seriesKgId:
                              type: string
                              description: 系列kgId
                            spaceId:
                              type: string
                              description: 空间id
                            spaceName:
                              type: string
                              description: 空间名称
                            status:
                              type: string
                              description: 素材状态-1入库失败1入库中2入库成功
                            texture:
                              type: string
                              description: 素材材质
                            topViewImage:
                              type: string
                              description: 素材顶视图
                            traceId:
                              type: string
                              description: traceId
                            typeOnRelation:
                              type: string
                              description: 素材边上的type
                            width:
                              type: number
                              format: double
                              description: 宽
                            wireframeImage:
                              type: string
                              description: 线框图
                        description: This is List Type
              example:
                msg: ''
                code: 0
                data:
                  recordCount: 0
                  pageSize: 0
                  result:
                  - msg: ''
                    groupType: 0
                    color: ''
                    schemeType: ''
                    imagePath: ''
                    is3d: 0
                    modelLoc: ''
                    spaceName: ''
                    applySpace: []
                    spaceId: ''
                    materialStyle: ''
                    seedSchemeIds: ''
                    modelFlag: ''
                    typeOnRelation: ''
                    materialGroupId: ''
                    customStyleIds: []
                    brushStyleList:
                    - xmlDataUrl: ''
                      styleImage: ''
                      styleName: ''
                      styleCode: ''
                      styleType: ''
                      styleId: ''
                    id: 0
                    kgStatus: 0
                    ruleId: 0
                    materialSource: ''
                    modellocId: ''
                    traceId: ''
                    wireframeImage: ''
                    kgMaterialType: ''
                    topViewImage: ''
                    kgId: ''
                    texture: ''
                    isValid: 0
                    lengthMax: 0
                    materialType: 0
                    materialId: ''
                    seriesKgId: ''
                    recommended: false
                    materialName: ''
                    groupName: ''
                    circleShare: 0
                    createTime: ''
                    lengthMin: 0
                    category: ''
                    modellocName: ''
                    isDirect: 0
                    status: ''
                  pageIndex: 0
                success: false
        '401':
          description: access_token 缺失或已过期 / missing or expired access_token
  /api/layoutCabinetCustomMaterial/listByPage:
    post:
      operationId: apiLayoutCabinetCustomMaterialListByPage
      summary: 分页查询套系素材自定义替换关联
      tags:
      - Light Design
      x-source-documentation: https://dev.3vjia.com/document?apiId=843157642473017444
      x-documentation-category: 轻设计
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                categoryCode:
                  type: string
                  description: 分类编码
                categoryId:
                  type: string
                  description: 关联分类目录ID(按照分类关联)
                categoryName:
                  type: string
                  description: 分类名称
                createDateEnd:
                  type: string
                  description: 创建时间结束日期
                createDateStart:
                  type: string
                  description: 创建时间开始日期
                createUser:
                  type: string
                  description: 创建人
                height:
                  type: number
                  format: double
                  description: 替换素材高
                ids:
                  type: array
                  items: {}
                  description: "This is List Type  \nID"
                imagePath:
                  type: string
                  description: 替换素材主图
                isDelete:
                  type: integer
                  format: int32
                  description: 删除标识
                length:
                  type: number
                  format: double
                  description: 替换素材长
                materialId:
                  type: string
                  description: 原素材ID(套系中录入的素材)
                materialName:
                  type: string
                  description: 替换素材名称
                materialNameLike:
                  type: string
                  description: 替换素材名称模糊匹配
                modelFlag:
                  type: integer
                  format: int32
                  description: 替换素材分类
                orderBy:
                  type: string
                  description: 排序
                pageIndex:
                  type: integer
                  format: int32
                  description: 页码
                pageSize:
                  type: integer
                  format: int32
                  description: 页容量
                replaceMaterialId:
                  type: string
                  description: 替换素材ID
                replaceModel:
                  type: string
                  description: 素材替换类型category|material
                replaceType:
                  type: string
                  description: 替换类别doorBoard门板|chartlet贴图|electric电器|category分类(则根据categoryId获取分类树)
                tenantId:
                  type: string
                  description: 租户
                updateDateEnd:
                  type: string
                  description: 更新时间结束日期
                updateDateStart:
                  type: string
                  description: 更新时间开始日期
                updateUser:
                  type: string
                  description: 更新人
                width:
                  type: number
                  format: double
                  description: 替换素材宽
            example:
              replaceMaterialId: ''
              imagePath: ''
              isDelete: 0
              orderBy: ''
              pageSize: 0
              updateUser: ''
              replaceType: ''
              categoryCode: ''
              materialId: ''
              categoryName: ''
              replaceModel: ''
              materialName: ''
              modelFlag: 0
              createDateStart: ''
              pageIndex: 0
              updateDateStart: ''
              tenantId: ''
              updateDateEnd: ''
              ids: []
              createUser: ''
              createDateEnd: ''
              categoryId: ''
              materialNameLike: ''
      responses:
        '200':
          description: 成功 / OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: 请求是否成功 / whether the call succeeded
                  code:
                    type: integer
                    description: 结果码 / result code (0 = success)
                  msg:
                    type: string
                    description: 提示信息 / message
                  data:
                    type: object
                    properties:
                      pageIndex:
                        type: integer
                        format: int32
                      pageSize:
                        type: integer
                        format: int32
                      recordCount:
                        type: integer
                        format: int32
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            categoryCode:
                              type: string
                              description: 分类编码
                            categoryId:
                              type: string
                              description: 关联分类目录ID(按照分类关联)
                            categoryName:
                              type: string
                              description: 分类名称
                            createDate:
                              type: string
                              description: 创建时间
                            createUser:
                              type: string
                              description: 创建人
                            glbList:
                              type: array
                              items: {}
                              description: "This is List Type  \n替换素材glb列表"
                            height:
                              type: number
                              format: double
                              description: 替换素材高
                            id:
                              type: string
                              description: ID
                            imagePath:
                              type: string
                              description: 替换素材主图
                            isDelete:
                              type: integer
                              format: int32
                              description: 删除标识
                            leftValue:
                              type: integer
                              format: int32
                              description: 是否有子分类1是0否
                            length:
                              type: number
                              format: double
                              description: 替换素材长
                            materialId:
                              type: string
                              description: 原素材ID
                            materialName:
                              type: string
                              description: 替换素材素材名称
                            modelFlag:
                              type: integer
                              format: int32
                              description: 替换素材素材分类
                            replaceMaterialId:
                              type: string
                              description: 替换素材ID
                            replaceModel:
                              type: string
                              description: 素材替换类型category|material
                            replaceType:
                              type: string
                              description: 替换类别doorBoard门板|chartlet贴图|electric电器
                            tenantId:
                              type: string
                              description: 租户
                            updateDate:
                              type: string
                              description: 更新时间
                            updateUser:
                              type: string
                              description: 更新人
                            width:
                              type: number
                              format: double
                              description: 替换素材宽
                        description: AI搭柜自定素材配置结果类
              example:
                msg: ''
                code: 0
                data:
                  recordCount: 0
                  pageSize: 0
                  result:
                  - replaceMaterialId: ''
                    updateDate: ''
                    imagePath: ''
                    isDelete: 0
                    leftValue: 0
                    updateUser: ''
                    replaceType: ''
                    categoryCode: ''
                    materialId: ''
                    categoryName: ''
                    glbList: []
                    replaceModel: ''
                    materialName: ''
                    modelFlag: 0
                    tenantId: ''
                    createUser: ''
                    id: ''
                    categoryId: ''
                    createDate: ''
                  pageIndex: 0
   

# --- truncated at 32 KB (200 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/3vjia-technology/refs/heads/main/openapi/3vjia-technology-light-design-api-openapi.yml