Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Geoapify

Scalekit connector
Open markdown

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

Tools
29
What they doRead · write · destructive
25 · 4 · 025 read4 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 Geoapify connection

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

    Each user opens the link once and enters their Geoapify 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
  • geoapify_batch_geocode_reverse_getGet the status or results of a batch reverse geocoding job.Read-only

    Get Batch Reverse Geocoding Results

    Get the status or results of a batch reverse geocoding job. Returns the pending status while running, then one address per input location. Start the job with geoapify_batch_geocode_reverse_create.

    Inputs

    idstringrequired
    Batch job identifier returned by the submit endpoint. Example: 51a5c7bdd1f2a52a40595d1d7a55743b4a40f00103f90146f3.
    formatstring
    Batch geocode result format. Default: json.one of jsongeojson
  • geoapify_batch_geocode_search_getGet the status or results of a batch geocoding job.Read-only

    Get Batch Geocoding Results

    Get the status or results of a batch geocoding job. Returns the pending status while running, then one result per input address with lat, lon and formatted address. Start the job with geoapify_batch_geocode_search_create.

    Inputs

    idstringrequired
    Batch job identifier returned by the submit endpoint. Example: 51a5c7bdd1f2a52a40595d1d7a55743b4a40f00103f90146f3.
    formatstring
    Batch geocode result format. Default: json.one of jsongeojson
  • geoapify_batch_getGet the status or results of a generic batch job.Read-only

    Get Batch Job Results

    Get the status or results of a generic batch job. Returns the pending status while running, then one result per input with its params and the API response. Start the job with geoapify_batch_create.

    Inputs

    idstringrequired
    Batch job identifier returned by the submit endpoint. Example: 51a5c7bdd1f2a52a40595d1d7a55743b4a40f00103f90146f3.
  • geoapify_boundaries_consists_ofList the boundaries one level (or more) below a boundary, such as the districts of a city.Read-only

    Get Sub-Boundaries

    List the boundaries one level (or more) below a boundary, such as the districts of a city. Returns a feature for each sub-boundary with place_id, name, boundary type and optional geometry. Get the boundary place ID from geoapify_boundaries_part_of or a geocoding result.

    Inputs

    idstringrequired
    Geoapify place identifier returned by the Geocoding, Places, or related Geoapify APIs. This is the recommended lookup method. Example: 51a5c7bdd1f2a52a40595d1d7a55743b4a40f00103f90146f3.
    boundarystring
    Boundary type to return. Default: administrative.one of administrativepostal_codepoliticallow_emission_zonepublic_transporttraditionaltimezonereligious_administrationreligiousplaceneighborhoodregionmunicipalitybaronytownhealthhistorichistoric:administrative
    geometrystring
    Geometry representation for returned boundaries. point returns representative points and is the default. The geometry_* values return simplified Polygon or MultiPolygon geometry at the specified accuracy in meters.one of pointgeometry_1000geometry_5000geometry_10000
    langstring
    Language used for boundary names and address fields. Default: en.
    sublevelinteger
    Nested boundary depth. Default: 1.
  • geoapify_boundaries_part_ofList the administrative and other boundaries (city, county, state, country, postcode) that contain a location or place.Read-only

    Get Boundaries Containing

    List the administrative and other boundaries (city, county, state, country, postcode) that contain a location or place. Returns a feature for each containing boundary with name, boundary type, admin level and optional geometry. Use geoapify_boundaries_consists_of for the sub-areas of a boundary.

    Inputs

    boundariesstring
    Boundary types to return. Multiple values are comma-separated. Separate multiple values with ,. Values: administrative, postal_code, political, low_emission_zone, public_transport, traditional, timezone, religious_administration, religious, place, neighborhood, region, municipality, barony, town, health, historic, historic:administrative. Example: administrative,postal_code.
    geometrystring
    Geometry representation for returned boundaries. point returns representative points and is the default. The geometry_* values return simplified Polygon or MultiPolygon geometry at the specified accuracy in meters.one of pointgeometry_1000geometry_5000geometry_10000
    idstring
    Geoapify place identifier returned by the Geocoding, Places, or related Geoapify APIs. This is the recommended lookup method. Example: 51a5c7bdd1f2a52a40595d1d7a55743b4a40f00103f90146f3.
    langstring
    Language used for boundary names and address fields. Default: en.
    latnumber
    Latitude of the place. Alternative to id; provide together with lon and leave unset when using a place ID. Example: 52.5163.
    lonnumber
    Longitude of the place. Alternative to id; provide together with lat and leave unset when using a place ID. Example: 13.3777.
    osm_idinteger
    Numeric OpenStreetMap object identifier. Alternative to id; use together with osm_type and leave unset when using a place ID. Example: 240109189.
    osm_typestring
    OpenStreetMap object type used with osm_id: n for node, w for way, or r for relation.one of rwn
  • geoapify_elevation_getGet the ground elevation of up to 1,000 locations, optionally with the distance from the previous point.Read-only

    Get Elevation

    Get the ground elevation of up to 1,000 locations, optionally with the distance from the previous point. Returns results in input order with elevation in meters or feet. Use for elevation profiles along a route.

    Inputs

    locationsarrayrequired
    Ordered input locations. Use [longitude, latitude] arrays or objects with lat and lon. Results preserve this order. Example: [[13.3777, 52.5163], [13.405, 52.52]].
    formatstring
    Response representation. json returns a results array; geojson returns a FeatureCollection. Default: json.one of jsongeojson
    includeDistanceboolean
    When true, include the distance from the previous input location. The first result has distance 0. Default: False. Example: false.
    unitsstring
    Elevation and optional distance units. Metric results use meters (m); imperial results use rounded feet (ft). Default: metric.one of metricimperial
  • geoapify_geocode_autocompleteSuggest addresses and places for partial text, for type-ahead search.Read-only

    Autocomplete Address

    Suggest addresses and places for partial text, for type-ahead search. Returns suggestions with formatted address, address parts, lat, lon and result type. Use geoapify_geocode_search for a complete address.

    Inputs

    textstringrequired
    Partial address or place name to autocomplete. Example: Potsdamer Platz, Berlin.
    biasstring
    Result ranking bias. Separate multiple values with ,. Example: proximity:13.3777,52.5163.
    countrycodesstring
    ISO 3166-1 alpha-2 country filters. Separate multiple values with ,. Example: de,at.
    filterstring
    Hard result filters. Separate multiple values with ,. Example: countrycode:de.
    formatstring
    Response serialization: geojson, json, or xml. Default: geojson.one of jsongeojson
    langstring
    Result language. Default: en.
    limitinteger
    Maximum number of results. Example: 20.
    typestring
    Requested location type. Example: country.one of countrystatecitypostcodestreetamenitylocality
  • geoapify_geocode_reverseConvert latitude and longitude into the nearest address or place.Read-only

    Reverse Geocode

    Convert latitude and longitude into the nearest address or place. Returns the address with formatted text, street, city, postcode, country and distance from the point. Use geoapify_geocode_search for address to coordinates.

    Inputs

    latnumberrequired
    Latitude. Example location: Old Saint Stephens Church, 24 Clark Street, Boston, Massachusetts. Example: 52.5163.
    lonnumberrequired
    Longitude for the same example location. Example: 13.3777.
    countrycodesstring
    ISO 3166-1 alpha-2 country filters. Separate multiple values with ,. Example: de,at.
    formatstring
    Response format. Default: geojson.one of jsongeojson
    langstring
    Result language. Default: en.
    limitinteger
    Maximum number of results. Default: 1. Example: 20.
    typestring
    Requested result type. Example: country.one of countrystatecitypostcodestreetamenitylocalitybuilding