01Spatial Documentation

Machine-readable: manifest · index · English Markdown

Draft translation: this English page is available for review and is not yet the production default.

Scan with KIRI Engine

KIRI Engine can record scene images, camera positions, and depth information on a LiDAR-equipped iPhone or iPad. 01Spatial builds a visual map from the complete Scene Scan Raw Data ZIP and further refines the camera trajectory recorded by KIRI Engine.

This path accepts only LiDAR Scene Scan Raw Data. Room Scan, Object Capture, Photo Scan, 3DGS, and standalone OBJ, USDZ, PLY, or GLB exports cannot replace the Raw Data ZIP.

1. Confirm the device and output

Use a LiDAR-equipped iPhone or iPad and a KIRI Engine version that can export Scene Scan Raw Data. According to KIRI Engine's current official guidance, exporting Scene Scan Raw Data requires KIRI Engine Pro. Before a production scan, make a short test scan and confirm that Raw Data appears in the export menu.

A ZIP that can be used by 01Spatial contains at least:

transforms.json   # camera parameters and pose for every image
image/            # source images used for mapping
depth/            # optional depth maps
confidence/       # optional depth confidence maps

transforms.json and image/ are required. Do not export only a 3D model, rename files, or rearrange folders inside the ZIP.

2. Enable Developer Mode before scanning

Raw Data is a KIRI Engine developer export. Confirm that it is enabled before the production scan.

  1. Open KIRI Engine and go to Me.
  2. Enable Developer Mode.
  3. Return to the home screen, complete a short Scene Scan, and confirm that Raw Data can be exported.
  4. Check available storage and battery capacity before starting the production scan.

If menu names change between KIRI Engine versions, follow the official KIRI Engine Raw Data introduction. Do not substitute an ordinary model file when Raw Data is unavailable.

3. Prepare the space

  • Turn on the site lighting so door frames, wall corners, signs, and fixed fixtures remain sharp.
  • Clean the lens and confirm that the phone case or protector does not cover the cameras or LiDAR sensor.
  • Pause moving, staging, and cleaning work so chairs, doors, displays, and other objects stay in place throughout the scan.
  • Plan one continuous route through every area that needs localization or AR content, then return to an already scanned region to close the loop.

Glass, mirrors, highly reflective metal, and large plain surfaces reduce image and depth stability. When they cannot be avoided, capture the surrounding door frames, wall corners, and fixed structures from several directions instead of filling the view with the difficult surface.

4. Start a Scene Scan

  1. Select + on the KIRI Engine home screen.
  2. Choose LiDAR Scan, then Scene Scan.
  3. At the start point, slowly observe nearby walls, floor, door frames, and fixed fixtures, and confirm that live coverage is stable.
  4. Begin moving along the planned route.

The KIRI Engine LiDAR Scan menu, where Scene Scan is the correct capture type for scanning a space

Do not choose Room Scan or Object Capture. Their output structure is different from Scene Scan Raw Data and cannot enter this 01Spatial mapping path.

5. Scan the full route

  1. Move smoothly at a normal walking speed. Avoid fast rotation or large device motion.
  2. Keep shared content visible between neighboring positions while gradually revealing new walls and structures.
  3. Slow down at doors, corners, stairs, and room transitions, and observe each connection from both sides.
  4. Revisit incomplete coverage from another stable angle. Do not wave the phone quickly to chase the coverage indicator.
  5. Near the end, return to the start area or repeat part of an already scanned route. End only after the route forms a loop.

During capture, KIRI Engine overlays the live camera view with the surface being reconstructed. The white mesh represents scanned spatial structure; regions without a mesh still need coverage from a stable, sharp viewpoint. The red button at the bottom ends the scan. Do not select it until the full route is covered and the loop is closed.

KIRI Engine Scene Scan in progress, with a white reconstructed mesh over the live camera view

Large spaces can be divided into overlapping regions, but one scan must remain spatially continuous. If the device becomes hot, the app remains sluggish, or tracking repeatedly fails, finish at a well-covered position instead of carrying the error into the next area.

6. Check before finishing

  • Every target room, doorway, turn, and route endpoint is covered.
  • Neighboring regions share clear, continuous views.
  • There is no sustained blur, underexposure, overexposure, or lens obstruction.
  • Walls, door frames, and floors in the live model do not visibly overlap, tilt, or break apart.
  • The route returns to an already scanned region and closes a loop.

If the live model is visibly misaligned with the real space, further scanning usually makes the error larger. End and remove the failed scan, then restart with a better route or slower motion.

7. Process on the device and export Raw Data

Finish the project with Local Processing

After capture, KIRI Engine asks how to process the scan. Select Local Processing, then choose Start Processing to process the project on the current device. Keep KIRI Engine in the foreground and make sure the device has enough power and free storage.

KIRI Engine processing options after capture, with Local Processing selected and Start Processing visible

Local processing completes and saves the KIRI Engine project. The primary input uploaded to 01Spatial is still the Raw Data ZIP exported in the next step, not the 3D preview shown in the app.

Export the Raw Data ZIP

  1. Open the finished Scene Scan on the device that captured it.
  2. Select Export on the project page to open the export menu.
  3. Choose Raw Data, or the equivalent raw-dataset option in that app version.
  4. Wait for the ZIP to finish saving. Do not switch projects or clear application data during export.
  5. Extract a copy and confirm that it contains transforms.json and image/. Keep the untouched original ZIP for upload.

A finished KIRI Engine Scene Scan project with the Export button at the bottom of the project page

To preview surface geometry in Space Studio, you may export a GLB separately and place that GLB in another ZIP. The Raw Data ZIP is the primary mapping input; the Mesh ZIP is optional preview geometry and cannot replace Raw Data.

8. Upload to 01Spatial

  1. Open Spatial Maps in Portal, enter the target project, and select + New Map.
  2. Name the map and choose KIRI as the input type.
  3. Under Upload from, choose a source:
    • Cloud (recommended): upload the Raw Data ZIP to a supported cloud drive and create a share link for that file. Select the provider and paste the link into Raw Data URL. If there is a Mesh ZIP, paste its link into the optional Mesh URL. Choose Download from Cloud so the server can fetch the files directly.
    • Local: select the Raw Data ZIP from the computer. If a Mesh is available, also select the separate Mesh ZIP. Keep the page open until upload finishes.
  4. Wait while Portal validates the input and enters the mapping flow.

The Spatial Maps New Map interface with KIRI selected, Cloud as the source, and separate Raw Data and optional Mesh link fields

This path uploads a Raw Data ZIP, not an ordinary video or a standalone 3D model. Prefer Cloud for large files. A share link must point to one ZIP file and allow the server to read it. Do not use a folder link, a sign-in-only link, or an ordinary preview URL copied from the browser address bar.

Portal checks for transforms.json and image/ inside the ZIP. A missing requirement, corrupted ZIP, or model-only upload is rejected.

Validate after building

When the map is Ready, use Space Studio localization testing at the start, route middle, doors, turns, and endpoint. Focus on continuity between connected regions and localization at the expected device height and lighting conditions.

Keep the KIRI Engine project, original Raw Data ZIP, and optional Mesh ZIP until localization acceptance is complete.