Generated by API Evangelist
Written by API Evangelist tooling for HERE's API. It is a proposal applied on top of the contract, not a document HERE publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Matrix Routing API v8 Matrix Calculation API
version: 1.0.0
extends: openapi/here-matrix-calculation-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/matrix'].post
update:
x-apievangelist-phrasing:
intent: Calculate a routing matrix
effect: write
questions:
- How do I calculate travel times and distances between many origins and destinations?
- Can I run a large routing matrix asynchronously and fetch the result later?
- Which transport modes, like truck or pedestrian, does the matrix calculation support?
instructions:
- text: Calculate a routing matrix from origins {origins} to destinations {destinations} in region {regionDefinition}.
slots:
origins: requestBody.origins
destinations: requestBody.destinations
regionDefinition: requestBody.regionDefinition
- text: Submit an async matrix {async} for origins {origins} within {regionDefinition} using transport mode {transportMode}.
slots:
async: query.async
origins: requestBody.origins
regionDefinition: requestBody.regionDefinition
transportMode: requestBody.transportMode
method: generated
generated: '2026-09-26'
- target: $.paths['/matrix/{matrixId}/status'].get
update:
x-apievangelist-phrasing:
intent: Check an async matrix calculation's status
effect: read
questions:
- Is my submitted matrix calculation finished yet?
- How do I poll the progress of an asynchronous routing matrix?
instructions:
- text: Check the status of matrix calculation {matrixId}.
slots:
matrixId: path.matrixId
- text: Poll whether matrix {matrixId} has completed.
slots:
matrixId: path.matrixId
method: generated
generated: '2026-09-26'
- target: $.paths['/matrix/{matrixId}'].get
update:
x-apievangelist-phrasing:
intent: Download a completed matrix result
effect: read
questions:
- Where do I download the result of a completed routing matrix?
- Does the matrix result require a compressed response encoding?
instructions:
- text: Get the result of completed matrix {matrixId}.
slots:
matrixId: path.matrixId
- text: Download matrix {matrixId} results with encoding {encoding}.
slots:
matrixId: path.matrixId
encoding: header.Accept-Encoding
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.