Mapping API

2026-09-20

DJI FlightHub Mapping API Introduction

Added FlightHub Mapping API in OpenAPI, supporting third-party fast integration of cloud mapping capabilities.

  1. Maximum number of concurrent mapping tasks: 2 for standard version, 5 for business version, and 10 for enterprise version
  2. Pricing strategy: Consistent with DJI FlightHub public cloud. 2D, 3D, and 3DGS files are charged separately.
  • Supports uploading point cloud data for reconstruction. Every 5 MB of point cloud model uses 1 mapping image.
  • For point cloud files, LDR files are counted based on size, while images and other files are counted by quantity.

  1. Supported mapping range:
    Visible light: 2D model, 3D point cloud, 3D mesh, and 3DGS Gaussian splatting
    Laser point cloud: supported for L1 and L2, and preparing to be supported for L3

  2. Maximum number of files per mapping task: Each mapping task has a maximum file limit.
    2D model: Minimum 5, maximum 20,000
    3D model: Minimum 5, maximum 20,000
    Gaussian splatting: Minimum 5, maximum 4,000
    Laser point cloud: Minimum 5, maximum 20,000

Sample Code

OpenAPI has been upgraded to V2.0. The Mapping API behavior is unchanged; only the "v0.1" segment in the route is replaced with "v2.0".

  • For example, "/openapi/v0.1/open_model/stores/obtain_token" becomes "/openapi/v2.0/open_model/stores/obtain_token".
  • If you are an OpenAPI V1.0 user, simply keep "v0.1".

1. Get the upload credential

Get the temporary credential for uploading media files for modeling to the bucket.

POST /openapi/v2.0/open_model/stores/obtain_token
X-User-Token: xxxxxxxx
X-Request-ID: yyyyyyyy

Response

{
    "code": 0,
    "message": "",
    "data": {
        "cloud_name": "ali",
        "access_key_id": "xxx",
        "secret_access_key": "xx",
        "session_token": "xx",
        "region": "cn-hangzhou",
        "cloud_bucket_name": "xxx",
        "callback_param": "Q1g0Mm1uOUR6ZUJnMlkzb29vUmE0dmNWdnh0b1M1eis0d3B2c0paQmsrUURmT0Z5dHVLblBjbVllYlZ3cnovbE5ZdHRqM2VjMWxDTUwzYVJCTFk0N2tWd2pkSWIwQlU5dHBMZVZkbXJXZ2xJSWFhdHNxWnE2anQrTk9SMzlET0JNUUg0WkdDVDJ0OHNWbC9mMTZ6R01meEp2WGRzMFU4ZFkyMFIyMzJ6Ty9UUWZ2WUhlcEJWYnQ0NjJDdDFISS9Za0FON0srVjdZYnJITXprNHpRS09aSTJMbEZBdkpLNDNlVUd5dmRzMUJSSTVQVVA1VVlWVnEraDlNdkpQbHdSSw==",
        "store_path": "fh/organizations/5a6f9d4b-2a38-4b4b-86f9-3a678da0bf4a/open_reconstruction/tmp/fbe4f0a1-561c-43d1-a880-baf464bed5c6/{fileName}",
        "expire_time": 1768209932,
        "end_point": "https://xxx"
    }
}

2. Send an upload callback

This is used to notify which file resources need to be copied after file upload.

POST /openapi/v2.0/open_model/stores/upload_callback
X-User-Token: xxxxxxxx
X-Request-ID: yyyyyyyy

Request

{
    "resource_uuid": "69e49a97-6a02-4638-b1b5-b9e871b6c51e",
    "resource_name": "test",
    "callback_param": "Q1g0Mm1uOUR6ZUJnMlkzb29vUmE0dmNWdnh0b1M1eis0d3B2c0paQmsrUURmT0Z5dHVLblBjbVllYlZ3cnovbE5ZdHRqM2VjMWxDTUwzYVJCTFk0N3JTRjg2anc0aklVMEZ5U0FUdUNCbThqNDJMNEdPRkgvMzZBRWZNZDluZHJGNDJWMGxjUHFUMlk1bG9uNVN5eDZON2l5K0NVZUJGZ3Jrdyt5QTB5RXp1eWJESWZqdG5HeGp5QkF2WnRHTFpZc0thVWtTL1I1eVp5M0UrS0VvMGVpTVlLUGpvUzhiUlo4dE1rMk1PY2lUZz0=",
    "files": [
        {
            "name": "DJI_20250721120152_0025_V.jpeg",
            "etag": "69922E94721B338B174C219542370E8E"
        },
        {
            "name": "DJI_20250721120153_0026_V.jpeg",
            "etag": "60C05FF3D620ADA0365F3427F2A43FA7"
        }
    ]
}

Response

{
    "code": 0,
        "message": "",
        "data": {
        "resource_uuid": "69e49a97-6a02-4638-b1b5-b9e871b6c51e",
        "upload_count": 2
    }
}
  • etag specifies the hash value assigned to the file by the bucket to verify file integrity.

Sample code for obtaining the etag value (Go)

meta, _ := bucket.GetObjectDetailedMeta(key)
etag := strings.Trim(meta.Get("ETag"), "\"")

3. Start the reconstruction task

POST /openapi/v2.0/open_model/models/reconstruction/start
X-User-Token: xxxxxxxx
X-Request-ID: yyyyyyyy

Request

{
    "resource_uuid": "69e49a97-6a02-4638-b1b5-b9e871b6c51e",
    "parameter_2d": "",
    "parameter_3d": "{\"parameter\":{\"cut_AOI\":false,\"generate_b3dm\":true,\"generate_las\":false,\"generate_obj\":false,\"generate_osgb\":false,\"generate_ply\":false,\"generate_pnts\":false,\"generate_point_ply\":false,\"global_min_depth\":-1,\"model_simplify\":0.2,\"output_geo_desc\":{\"cs_type\":\"GEO_CS\",\"geo_cs\":\"EPSG:32650\",\"geo_cs_wkt\":\"\",\"override_vertical_cs\":\"\"},\"output_mesh\":true,\"output_ply_with_normals\":false,\"output_pointcloud\":false,\"ply_with_normals_level\":0,\"quality_level\":3,\"stereo_mode\":false,\"usable_memory_GB\":60,\"water_refine\":false}}",
    "parameter_3dgs": "",
    "parameter_lidar": "",
    "delete_resource_if_finish": false
}

Response

{
    "code": 0,
    "message": "",
    "data": {
        "model_3d": {
            "uuid": "476954f7-3ad4-4dcf-a03f-2654d5e0d3cc",
            "status": 12,
            "sub_error_code": 0
        }
    }
}

4. Get Model Details

Get model details to check the model status, size, and task progress.

GET /openapi/v2.0/open_model/models/476954f7-3ad4-4dcf-a03f-2654d5e0d3cc
X-User-Token: xxxxxxxx
X-Request-ID: yyyyyyyy

Response

{
    "code": 0,
    "message": "",
    "data": {
        "resource_uuid": "69e49a97-6a02-4638-b1b5-b9e871b6c51e",
        "model_uuid": "476954f7-3ad4-4dcf-a03f-2654d5e0d3cc",
        "model_type": 2,
        "model_status": 9,
        "model_size": 37420969,
        "reconstruction_progress": 100,
        "error_code": 0,
        "zip_status": 2,
        "zip_progress": 100,
        "zip_file_key": "xxxx"
    }
}
Last Updated: