Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to HERE

Scalekit connector
Open markdown

The HERE connector lets your AI agent act in each user's HERE account. Each user connects their own HERE API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 26 tools.

Tools
26
What they doRead · write · destructive
26 · 0 · 026 read0 write0 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the HERE connection

    In AgentKit > Connections, create a HERE connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'here'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize HERE:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'here_geocode',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their HERE credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • here_address_autocompleteComplete a partial address entry into full address candidates.Read-only

    Autocomplete Address

    Complete a partial address entry into full address candidates. Returns items with title, id, resultType, address and highlighting. Use this for address forms. Use here_places_autosuggest when places should be included.

    Inputs

    qstringrequired
    Partial address text. Example: Invalidenstraße 1.
    atstring
    Position as latitude,longitude to bias results toward. Example: 52.5308,13.3847.
    instring
    Area filter: countryCode:<ISO 3166-1 alpha-3 list>, circle:lat,lng;r=<meters>, or bbox:west,south,east,north. Example: countryCode:USA,CAN.
    langstring
    BCP 47 language code(s) for result rendering, comma-separated. Example: en-US.
    limitinteger
    Maximum number of results (1-100, default 20). Example: 10.
    political_viewstring
    ISO 3166-1 alpha-3 country code whose political view of disputed areas to use. Example: IND.
    typesstring
    Result types to return, comma-separated: address, area, city, houseNumber, postalCode, street. Example: houseNumber,street.
  • here_geocodeConvert a free-form or qualified address or place into coordinates, with the normalized address and match quality.Read-only

    Geocode Address

    Convert a free-form or qualified address or place into coordinates, with the normalized address and match quality. Returns items with title, id, resultType, address, position (lat, lng), mapView and scoring. Use this for a known address. Use here_places_discover to search places by name or category, or here_reverse_geocode for coordinates to address.

    Inputs

    atstring
    Position as latitude,longitude to bias results toward. Example: 52.5308,13.3847.
    instring
    Area filter: countryCode:<ISO 3166-1 alpha-3 list>, circle:lat,lng;r=<meters>, or bbox:west,south,east,north. Example: countryCode:USA,CAN.
    langstring
    BCP 47 language code(s) for result rendering, comma-separated. Example: en-US.
    limitinteger
    Maximum number of results (1-100, default 20). Example: 10.
    political_viewstring
    ISO 3166-1 alpha-3 country code whose political view of disputed areas to use. Example: IND.
    qstring
    Free-form address query. Provide q or qq. Example: Invalidenstr 117 Berlin.
    qqstring
    Qualified query: key=value pairs separated by ; with keys country, state, county, city, district, street, houseNumber, postalCode. Example: houseNumber=117;street=Invalidenstr;city=Berlin.
    showstring
    Extra sections, comma-separated: countryInfo, parsing, streetInfo, tz. Example: tz,streetInfo.
    typesstring
    Result types to return, comma-separated: address, area, city, houseNumber, postalCode, street. Example: houseNumber,street.
  • here_intermodal_routes_calculateCalculate routes that combine public transit with car (park and ride), taxi, rented vehicles, bicycle or walking.Read-only

    Calculate Intermodal Route

    Calculate routes that combine public transit with car (park and ride), taxi, rented vehicles, bicycle or walking. Returns routes with sections per mode, times, places and optional polyline and travel summary. Use this for mixed-mode trips. Use here_transit_routes_calculate for transit only or here_routes_calculate for driving.

    Inputs

    destinationstringrequired
    End as latitude,longitude. Example: 52.5005,13.4489.
    originstringrequired
    Start as latitude,longitude. Example: 52.5307,13.3847.
    alternativesinteger
    Number of alternative routes. Example: 2.
    changesinteger
    Maximum number of transit changes. Example: 3.
    departure_timestring
    Departure time, RFC 3339 date-time; use any to ignore traffic. Defaults to now. Example: 2026-01-15T08:30:00+01:00.
    langstring
    BCP 47 language. Example: en-US.
    rented_enablestring
    Where rented vehicles may be used: routeHead, routeTail and/or entireRoute. Example: routeHead.
    returnstring
    Sections to return, comma-separated: polyline, actions, travelSummary. Example: travelSummary,polyline.
    taxi_enablestring
    Where a taxi may be used: routeHead, routeTail and/or entireRoute. Example: routeTail.
    unitsstring
    Unit system for instructions: metric (default) or imperial. Example: metric.one of metricimperial
    vehicle_enablestring
    Where a private car may be used: routeHead, routeTail and/or entireRoute, comma-separated. Example: routeHead.
  • here_isolines_calculateCalculate the area reachable from an origin (or that can reach a destination) within given travel times, distances or energy budgets.Read-only

    Calculate Isolines

    Calculate the area reachable from an origin (or that can reach a destination) within given travel times, distances or energy budgets. Returns isolines per range value with polygons as encoded flexible polylines, plus departure/arrival place. Use this for reachability or service-area questions. Use here_routes_calculate for a single route.

    Inputs

    range_typestringrequired
    What the range values measure. Example: time.one of distancetimeconsumption
    range_valuesstringrequired
    Comma-separated range values: seconds for time, meters for distance, Wh for consumption. Example: 600,1200.
    transport_modestringrequired
    Mode of transport. Example: car.one of cartruckpedestrianbicyclescootertaxibusprivateBus
    avoid_featuresstring
    Features to avoid, comma-separated: tollRoad, controlledAccessHighway, ferry, carShuttleTrain, tunnel, dirtRoad, difficultTurns, uTurns. Example: tollRoad,ferry.
    departure_timestring
    Departure time, RFC 3339 date-time; use any to ignore traffic. Defaults to now. Example: 2026-01-15T08:30:00+01:00.
    destinationstring
    Center as latitude,longitude (isolines to here). Example: 52.5308,13.3847.
    optimize_forstring
    quality, performance or balanced. Example: balanced.one of qualityperformancebalanced
    originstring
    Center as latitude,longitude (isolines from here). Provide origin or destination. Example: 52.5308,13.3847.
    routing_modestring
    fast (default) or short. Example: fast.one of fastshort
    shape_max_pointsinteger
    Maximum points per isoline polygon. Example: 200.
  • here_matrix_calculateCalculate travel times and/or distances between every origin and destination.Read-only

    Calculate Route Matrix

    Calculate travel times and/or distances between every origin and destination. With async=false the matrix is returned directly; otherwise poll the status. Returns matrix with numOrigins, numDestinations, travelTimes and/or distances arrays (sync), or matrixId and status (async). Use this for many-to-many travel times. Use here_routes_calculate for directions between two points.

    Inputs

    originsarrayrequired
    Origins, each an object with lat and lng. Example: [{"lat": 52.5308, "lng": 13.3847}, {"lat": 52.5200, "lng": 13.4050}]
    region_definitionobjectrequired
    Area the calculation may use: {"type": "world"} (needs a profile or flexible mode), {"type": "autoCircle"}, a circle, a boundingBox or a polygon. Example: {"type": "autoCircle", "margin": 10000}
    asyncboolean
    false for a synchronous response (small matrices); true (default) to queue and poll here_matrix_status_get. Example: false.
    departure_timestring
    RFC 3339 departure time, or any for time-independent results. Example: any.
    destinationsarray
    Destinations, each an object with lat and lng. Defaults to the origins. Example: [{"lat": 52.5264, "lng": 13.3686}]
    matrix_attributesarray
    What to return: travelTimes and/or distances. Example: ["travelTimes", "distances"]
    profilestring
    Predefined profile ID from here_matrix_profiles_list (needed with a world region). Example: carFast.
    routing_modestring
    fast or short. Example: fast.one of fastshort
    transport_modestring
    Mode of transport (default car). Example: car.one of cartruckpedestrianbicyclescootertaxibusprivateBus
  • here_matrix_profile_getGet one predefined matrix profile.Read-only

    Get Matrix Profile

    Get one predefined matrix profile. Returns the profile's transport mode, routing mode and vehicle options. Use this to check a profile before using it.

    Inputs

    profile_idstringrequired
    Profile ID from here_matrix_profiles_list. Example: carFast.
  • here_matrix_profiles_listList the predefined routing profiles for world-wide matrix calculations.Read-only

    List Matrix Profiles

    List the predefined routing profiles for world-wide matrix calculations. Returns profiles with id, transportMode and options. Use this to pick a profile for here_matrix_calculate.

    Inputs

    This tool takes no inputs.

  • here_matrix_result_getGet the result of a completed asynchronous matrix calculation.Read-only

    Get Matrix Result

    Get the result of a completed asynchronous matrix calculation. Returns matrix with travelTimes and/or distances arrays and any errorCodes. Use this once here_matrix_status_get reports completed.

    Inputs

    matrix_idstringrequired
    Matrix ID from here_matrix_calculate. Example: b2a3c4d5-e6f7-4890-a1b2-c3d4e5f60718.