Image Upload

Use this API to upload a photoset to the KIRI Engine server and obtain the serial number of the model. This serial number is unique to this project.

To ensure consistency in the 3D models, please upload at least 20 images but no more than 300 images. If you need to upload more, please contact us.

Request

curl --location --request POST 'https://api.kiriengine.app/api/v1/open/photo/image' \
--header 'Authorization: Bearer ${YOUR_API_KEY}'\
--form 'imagesFiles=@""' \
--form 'modelQuality=""1' \
--form 'textureQuality="1"' \
--form 'fileFormat="OBJ"' \
--form 'isMask="1"'\
--form 'textureSmoothing="1"'

Response

 {
    "code": 0,
    "msg": "string",
    "data": {
        "serialize": "796a6f52457844b4918db3eadd64becc",
        "calculateType":1
    },
    "ok": true
}

Attributes

properties	type	description
imagesFiles	Array	Image files
modelQuality	Integer	Default: 0 (0: High, 1: Medium, 2: Low, 3: Ultra)
textureQuality	Integer	Default: 0 (0: 4K, 1: 2K, 2: 1K, 3: 8K)
isMask	Integer	Default: 0 (0: Turn off Auto Object Masking, 1: Turn on Auto Object Masking)
serialize	String	Unique identifier for the task
calculateType	Integer	1: Photo Scan, 2: Featureless Object Scan, 3: 3DGS Scan
textureSmoothing	Integer	Default: 0: Turn off Texture Smoothing, 1: Turn on Texture Smoothing (Texture Smoothing improves the texture quality of blurry areas and produces more coherent texture maps. It may also reduce the overall sharpness of the textures. It's recommended to turn this off when when using for professional use that requires precise Photo Scans)
fileFormat	String	Generated model format (obj, fbx, stl, ply, glb, gltf, usdz, xyz)