Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to TomTom

Scalekit connector
Open markdown

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

Tools
19
What they doRead · write · destructive
19 · 0 · 019 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 TomTom connection

    In AgentKit > Connections, create a TomTom 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 = 'tomtom'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize TomTom:', 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: 'tomtom_poi_categories_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their TomTom 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
  • tomtom_additional_data_getGet the outline geometry (GeoJSON polygons) of geographic areas such as cities or countries, using the geometry IDs returned in search results' dataSources.Read-only

    Get Area Geometry

    Get the outline geometry (GeoJSON polygons) of geographic areas such as cities or countries, using the geometry IDs returned in search results' dataSources. Returns a GeoJSON geometry per ID. Use this to draw or test against an area's boundary.

    Inputs

    geometriesstringrequired
    Comma-separated geometry IDs from a search result's dataSources.geometry.id (up to 20). Example: 00004631-3400-3c00-0000-0000673c4d2e.
    geometries_zoominteger
    Zoom level (0 to 22) that sets the geometry precision. One of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22. Example: 10.
  • tomtom_autocompleteRecognise what a partial search query means: which parts are a brand, a category or plain text, with suggested categories and brands.Read-only

    Autocomplete Search Query

    Recognise what a partial search query means: which parts are a brand, a category or plain text, with suggested categories and brands. Returns segments with their type, matched value and IDs. Use this to build search-as-you-type experiences before calling tomtom_category_search or tomtom_poi_search.

    Inputs

    languagestringrequired
    IETF language tag of the query, e.g. en-US. Example: en-US.
    querystringrequired
    Partial query typed by the user, e.g. piz. Do not include slashes. Example: pizza.
    country_setstring
    Comma-separated ISO country codes to restrict results to. Example: NL,BE.
    latnumber
    Latitude to bias results to; use with lon. Example: 52.3759.
    limitinteger
    Maximum number of results (default 5, max 10). Example: 5.
    lonnumber
    Longitude to bias results to; use with lat. Example: 4.8975.
    radiusinteger
    Radius in meters around lat/lon (up to 5000000). Example: 5000.
    result_setstring
    Segment types to return: category, brand or category,brand. Example: category,brand.
  • tomtom_calculate_reachable_rangeCalculate the area reachable from an origin within a time, distance, fuel or energy budget (an isochrone or isodistance).Read-only

    Calculate Reachable Range

    Calculate the area reachable from an origin within a time, distance, fuel or energy budget (an isochrone or isodistance). Returns the center and the boundary polygon points. Use this for coverage or delivery-area questions. Set exactly one budget.

    Inputs

    originstringrequired
    Origin as lat,lon, e.g. 52.3759,4.8975. Example: 52.3759,4.8975.
    avoidstring
    Things to avoid: tollRoads, motorways, ferries, unpavedRoads, carpools, alreadyUsedRoads or borderCrossings. Example: tollRoads.
    depart_atstring
    Departure time: now or an ISO 8601 date-time (e.g. 2026-07-01T08:00:00). Cannot be used with arrive_at. Defaults to now. Example: now.
    energy_budget_ink_whnumber
    Energy budget in kWh (electric vehicles). Example: 20.
    fuel_budget_in_litersnumber
    Fuel budget in liters (combustion vehicles). Example: 10.
    hillinessstring
    Degree of hilliness for calculating a thrilling route. One of: low, normal, high. Defaults to normal. Example: low.one of lownormalhigh
    route_typestring
    The type of route requested. One of: fastest, shortest, eco, thrilling. Defaults to fastest. Example: fastest.one of fastestshortestecothrilling
    time_budget_in_secnumber
    Time budget in seconds. Example: 1800.
    trafficboolean
    Set to false to ignore live traffic. Defaults to true. Example: true.
    travel_modestring
    The mode of travel for the requested route. One of: car, truck, taxi, bus, van, motorcycle, bicycle, pedestrian. Defaults to car. Example: car.one of cartrucktaxibusvanmotorcyclebicyclepedestrian
    vehicle_engine_typestring
    Engine type of the vehicle. One of: combustion, electric. Defaults to combustion. Example: combustion.one of combustionelectric
    vehicle_max_speedinteger
    Maximum speed of the vehicle in km/hour. Defaults to 0. Example: 90.
    vehicle_weightinteger
    Weight of the vehicle in kilograms. Defaults to 0. Example: 3500.
    windingnessstring
    Amount that a thrilling route should wind. One of: low, normal, high. Defaults to normal. Example: low.one of lownormalhigh
  • tomtom_calculate_routeCalculate a route between two or more locations for a car, truck, bike, pedestrian or other travel mode, with live traffic, departure or arrival time, things to avoid and vehicle dimensions.Read-only

    Calculate Route

    Calculate a route between two or more locations for a car, truck, bike, pedestrian or other travel mode, with live traffic, departure or arrival time, things to avoid and vehicle dimensions. Returns per route the length, travel time, traffic delay, arrival time, legs with points (the polyline), sections and optional turn-by-turn guidance. Use this for directions and ETAs. Use tomtom_matrix_calculate for many origin-destination pairs.

    Inputs

    locationsstringrequired
    Colon-separated lat,lon points from origin through waypoints to destination, e.g. 52.3759,4.8975:52.0907,5.1214. Example: 52.3759,4.8975:52.0907,5.1214.
    arrive_atstring
    Arrival time as an ISO 8601 date-time. Cannot be used with depart_at. Example: 2026-07-01T09:00:00.
    avoidstring
    Things to avoid: tollRoads, motorways, ferries, unpavedRoads, carpools, alreadyUsedRoads or borderCrossings. Example: tollRoads.
    compute_best_orderboolean
    Re-order the route waypoints to reduce the route length. Defaults to false. Example: true.
    compute_travel_time_forstring
    Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time. One of: none, all. Example: none.one of noneall
    depart_atstring
    Departure time: now or an ISO 8601 date-time (e.g. 2026-07-01T08:00:00). Cannot be used with arrive_at. Defaults to now. Example: now.
    hillinessstring
    Degree of hilliness for calculating a thrilling route. One of: low, normal, high. Defaults to normal. Example: low.one of lownormalhigh
    instructions_typestring
    If specified, guidance instructions will be returned (if available). One of: coded, text, tagged. Example: coded.one of codedtexttagged
    languagestring
    IETF language tag for the results, e.g. en-US. Defaults to en-GB. Example: en-US.
    max_alternativesinteger
    Number of alternative routes to be calculated. Defaults to 0. Example: 1.
    route_representationstring
    Specifies the representation of the set of routes provided as a response. One of: polyline, none. Defaults to polyline. Example: polyline.one of polylinenone
    route_typestring
    The type of route requested. One of: fastest, shortest, eco, thrilling. Defaults to fastest. Example: fastest.one of fastestshortestecothrilling
    section_typestring
    Section types to report, e.g. traffic, toll, tunnel, motorway, pedestrian. Defaults to travelMode. Example: traffic.
    trafficboolean
    Set to false to ignore live traffic. Defaults to true. Example: true.
    travel_modestring
    The mode of travel for the requested route. One of: car, truck, taxi, bus, van, motorcycle, bicycle, pedestrian. Defaults to car. Example: car.one of cartrucktaxibusvanmotorcyclebicyclepedestrian
    vehicle_axle_weightinteger
    Weight per axle of the vehicle in kg. Defaults to 0. Example: 1500.
    vehicle_commercialboolean
    Indicates that the vehicle is used for commercial purposes. This means it may not be allowed on certain roads. Defaults to false. Example: true.
    vehicle_engine_typestring
    Engine type of the vehicle. One of: combustion, electric. Defaults to combustion. Example: combustion.one of combustionelectric
    vehicle_heightnumber
    Height of the vehicle in meters. Defaults to 0. Example: 3.1.
    vehicle_lengthnumber
    Length of the vehicle in meters. Defaults to 0. Example: 6.5.
    vehicle_load_typestring
    Indicates what kinds of hazardous materials the vehicle is carrying (if any). This means it may not be allowed on certain roads. Use these for routing in the US: - <i>USHazmatClass1</i> Explosives - <i>USHazmatClass2</i> Compressed gas - <i>USHazmatClass3</i> Flammable liquids - <i>USHazmatClass4</i> Flammable solids - <i>USHazmatClass5</i> Oxidizers - <i>USHazmatClass6</i> Poisons - <i>USHazmatClass7</i> Radioactive - <i>USHazmatClass8</i> Corrosives - <i>USHazmatClass9</i> Miscellaneous Use these for routing in all other countries: - <i>otherHazmatExplosive</i> Explosives - <i>otherHazmatGeneral</i> Miscellaneous - <i>otherHazmatHarmfulToWater</i> Harmful to water vehicleLoadType can be specified multiple times. This parameter is currently only considered for <b>travelMode</b>=<i>truck</i>. Example: otherHazmatGeneral.
    vehicle_max_speedinteger
    Maximum speed of the vehicle in km/hour. Defaults to 0. Example: 90.
    vehicle_weightinteger
    Weight of the vehicle in kilograms. Defaults to 0. Example: 3500.
    vehicle_widthnumber
    Width of the vehicle in meters. Defaults to 0. Example: 2.2.
    windingnessstring
    Amount that a thrilling route should wind. One of: low, normal, high. Defaults to normal. Example: low.one of lownormalhigh
  • tomtom_cross_street_lookupFind the nearest intersection (cross street) to a coordinate.Read-only

    Find Nearest Cross Street

    Find the nearest intersection (cross street) to a coordinate. Returns the crossing street names and the intersection position. Use this to describe a location by its nearest intersection.

    Inputs

    latnumberrequired
    Latitude of the position, in decimal degrees. Example: 52.3759.
    lonnumberrequired
    Longitude of the position, in decimal degrees. Example: 4.8975.
    headingnumber
    Direction of travel in degrees (0 = north). Example: 90.
    languagestring
    IETF language tag for the results, e.g. en-US. Example: en-US.
    limitinteger
    Maximum number of results to return (up to 100). Defaults to 1. Example: 10.
    radiusinteger
    Maximum distance in meters to look for an intersection. Defaults to 10000. Example: 5000.
    spatial_keysboolean
    If the "spatialKeys" flag is set, the response will also contain a proprietary geospatial keys for a specified location. Defaults to false. Example: false.
  • tomtom_geocodeConvert a free-text address or place name into coordinates.Read-only

    Geocode Address

    Convert a free-text address or place name into coordinates. Returns matches with the full address, position, entry points, bounding box and score. Use this when you have a written address. Use tomtom_structured_geocode when the address is already split into fields.

    Inputs

    querystringrequired
    Address or place to geocode, e.g. Damrak 1 Amsterdam. Do not include slashes. Example: Damrak 1 Amsterdam.
    btm_rightstring
    Bottom-right corner of the bounding box, as lat,lon. Example: 52.33,4.95.
    country_setstring
    Comma-separated ISO 3166 country codes to restrict results to. Example: NL,BE.
    extended_postal_codes_forstring
    Indexes for which extended postal codes should be included in the results. Available indexes are: - <b>Addr</b> = Address ranges - <b>Geo</b> = Geographies - <b>PAD</b> = Point Addresses - <b>POI</b> = Points of Interest - <b>Str</b> = Streets - <b>XStr</b> = Cross Streets (intersections). Example: PAD,Addr.
    languagestring
    IETF language tag for the results, e.g. en-US. Example: en-US.
    latnumber
    Latitude of the point to bias or center results on, in decimal degrees; use with lon. Example: 52.3759.
    limitinteger
    Maximum number of results to return (up to 100). Defaults to 10. Example: 10.
    lonnumber
    Longitude of the point to bias or center results on, in decimal degrees; use with lat. Example: 4.8975.
    ofsinteger
    Offset of the first result, for paging. Defaults to 0. Example: 0.
    radiusinteger
    Radius in meters around lat/lon to restrict results to. Example: 5000.
    top_leftstring
    Top-left corner of a bounding box to restrict results to, as lat,lon. Example: 52.41,4.84.
    typeaheadboolean
    Set to true to treat the query as a partial input (search-as-you-type). Defaults to false. Example: false.
    viewstring
    Geopolitical view for disputed areas. One of: Unified, IN, PK, IL, MA. Defaults to Unified. Example: Unified.one of UnifiedINPKILMA