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/3dgs/image' \
--header 'Authorization: Bearer ${YOUR_API_KEY}'\
--form 'isMesh="0"'\
--form 'isMask="0"'\
--form 'imagesFiles=@""'

Response

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

Attributes

properties	type	description
imagesFiles	Array	Image files
serialize	String	Unique identifier for the task
calculateType	Integer	1: Photo Scan, 2: Featureless Object Scan, 3: 3DGS Scan
isMesh	Integer	Default: 0: Turn off 3DGS to Mesh, 1: Turn on 3DGS to Mesh (3DGS projects are generated and stored as special PLY files. Turning on this feature will generate a separate mesh file)
isMask	Integer	Default: 0: Turn off Auto Masking, 1: Turn on Auto Object Masking
fileFormat	String	With 3DGS to Mesh turned on, the available file formats for generation: obj, fbx, stl, ply, glb, gltf, usdz, xyz