Classification Surface

Sandbox

https://airhub-api-sandbox.airspacelink.com

POST

/v2/classify

Last modified:2025-07-15 16:22:45

Scope: surface:create

The HexGen™ Surface API is a powerful geospatial aggregation and modeling engine that efficiently processes and combines multiple datasets to generate custom-tailored insights. This API enables users to integrate authoritative data provided by Airspace Link with their own GIS data, creating comprehensive and data-driven solutions. The API simplifies the process of combining and processing large amounts of data, transforming complexity into actionable insights.

For more information see the Surface Overview.

Request

Header Params

Content-Type

enum<string>

required

Allowed value:

application/json;charset=UTF-8

Example:

application/json;charset=UTF-8

Authorization

string

required

Authorization bearer accessToken generated in Authorization step

Example:

Body Params application/json

geometry

object

required

coordinates

array [array]

required

type

string

required

layers

array [object {2}]

required

code

enum<string>

optional

Allowed values:

controlled_airspacefriarailroad_bridgesrailroad_overpasspopulation_daytime_point_65000_650000population_daytime_point_65_650population_daytime_point_1_65population_daytime_point_650_6500parksclass_airspace_schedulenotamsuasfm_ceilingnsufr_ptnational_parks_simplewashington_frztfrfaa_helipadssatrrecreational_flyer_fixed_sitespopulation_daytime_point_6500_65000airportsultralightcommunity_advisoriesnsufr_ftpopulation_daytime_point_6500000balloonportstransmission_lineswater_bodiesbridgeshistorical_location_polygonsstadiumslopeschoolssporting_tfrwind_farmslulcpower_plantsbuilding_footprintglideportsmtr_buffernational_parksbuilding_footprintsstreamsrailroad_linesroadshistorical_location_pointshelipadsfaa_obstaclessua_scheduleseaportsuahospitalsurgent_care

risk

integer

optional

Relative risk. Higher number represents more risk.

>= 0

resolution

integer

required

The resolution of the output surface. Based on H3 hex grid resolution.

>= 8<= 13

Example

{
    "geometry": {
        "coordinates": [
            [
                [
                    -83.281174,
                    42.258
                ],
                [
                    -83.281174,
                    42.3121
                ],
                [
                    -83.218689,
                    42.3121
                ],
                [
                    -83.218689,
                    42.258
                ],
                [
                    -83.281174,
                    42.258
                ]
            ]
        ],
        "type": "Polygon"
    },
    "layers": [
        {
            "code": "uasfm_ceiling",
            "risk": 1
        }
    ],
    "resolution": 9
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://airhub-api-sandbox.airspacelink.com/v2/classify' \
--header 'Authorization: ' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
    "geometry": {
        "coordinates": [
            [
                [
                    -83.281174,
                    42.258
                ],
                [
                    -83.281174,
                    42.3121
                ],
                [
                    -83.218689,
                    42.3121
                ],
                [
                    -83.218689,
                    42.258
                ],
                [
                    -83.281174,
                    42.258
                ]
            ]
        ],
        "type": "Polygon"
    },
    "layers": [
        {
            "code": "uasfm_ceiling",
            "risk": 1
        }
    ],
    "resolution": 9
}'

Responses

🟢200Happy path desc

application/json

Body

data

object

required

bitmaskMap

object

required

hexes

array [object {3}]

required

message

string

required

statusCode

integer

required

Example

{
    "data": {
        "bitmaskMap": {
            "uasfm_ceiling": {
                "bitmask": 1,
                "risk": 1
            }
        },
        "hexes": [
            {
                "bitmask": 1,
                "index": "892ab2cd8d7ffff",
                "risk": 1
            }
        ]
    },
    "message": "success",
    "statusCode": 200
}

🔴500Internal error

Modified at 2025-07-15 16:22:45

Suitability

Surface v2 GeoJSON