AI Feature API
The AI Feature API allows you to retrieve a small Area of Interest (AOI) from our vector map that exists for our AI content. You can use your Nearmap AI export credits to extract a single building at a specific location to the AOI enclosed by a property, or even a small neighbourhood. Where the AI Feature API returns a vector map of all geospatial features relating to a request, the Rollup API further processes this to return a summarised, single row result per request. All you need to provide is a polygon for your Query AOI, an optional date range, and your Nearmap API Key. The AI Feature API allows programmatic access to Nearmap AI for Gen 3 content onwards. You can use the AI Feature API for:
- Distributed AOIs: If you have a number of small areas of interest that are distributed broadly rather than clustered in a contiguous region. For example, assessment of property parcels for an insurance carrier.
- Large data sets: If your AOI crosses multiple regions, it is best to use the date query in the AI Feature API. This allows you to extract the latest result available for each property regardless of the survey regions to which you require access.
- Regular updates: For customers who continuously update their data set in a transactional way, the API can be used to automate this rather than relying on a user to frequently export via MapBrowser.
- Real-time access: Customer-facing applications that require real-time retrieval of Nearmap AI content are well suited to API access. Because all our AI content is pre-processed, the time taken to retrieve the results is typically faster than on-the-fly AI processing systems.
Illustration of defining a Query AOI (outlined in red) on our vector map, and returning some of the features and attributes. The data necessary to visualise the shapes and metadata within the Query AOI is all included in a single API payload.
AI Rollup API
The Rollup API queries the AI Feature API data to provide a summary of the contents of the query AOI (requested polygon). It is best used for the purposes of customised rollup workflows where you can define your own logic to convert features to a tabular summary using geospatial operations. The Rollup API is suitable for users with limited geospatial experience who simply want "facts for an address". You can access these facts in the following formats:
The Rollup API allows you to bypass geospatial operations in your workflows by performing these operations:
- Removing features that do not meaningfully belong within the polygon. For example, a building where only a very small area is within the query AOI.
- Summarising basic facts such as instance counts, total areas, and aggregate confidence scores. For example, for an AOI with multiple roofs, the Rollup API will return facts such as roof count, t otal tile roof area, t otal metal roof area, total ponding roof area, and so on.
- For some feature classes, identifying the "primary object" (the largest object of that type), and providing additional information.
- Flattening nested hierarchies of features retrieved from the AI Feature API.
Accessing the API
If you already have access to the relevant AI Packs, and an appropriate number of Nearmap AI export credits, all you need to do is ask your account manager to add the "AI Feature API" product to your subscription. This leverages the shared Nearmap AI credit balance and AI Pack configuration - just think of it as an additional way to access the data to which you have already subscribed.
To use any of our Nearmap APIs, you need an API key. Learn how to get an API key here: API Key Authentication.
Getting Started Guide
The Getting Started Guide is a Jupyter Notebook containing python code and informal documentation, which you can download, to help you get up and running as quickly as possible. It explores a range of common tasks, and provides a useful base of algorithms and 3rd party packages that may help software developers who do not have a geospatial background to get started quickly with simple tasks such as calculating areas and distances between objects.