Geocode AI

Finds administrative boundaries (countries, states, counties, cities, districts) and postcode areas by name, in any language. Filter by country, kind or admin_level; bias toward a point with near. Free and public. Returns candidates with id, kind, admin_level, country, parents, bbox, centroid and population, but no polygon: pass the id to get_boundary for that.

Returns one boundary as a GeoJSON Feature: its polygon at a chosen detail plus properties (name, kind, admin_level, parents, bbox, area_km2, population, wikidata). Fetched from OpenStreetMap the first time anyone asks, then served from cache. Costs 1 unit; detail=low is also public without a key (for map previews). include=parents adds the full hierarchy, include=children the direct subdivisions. If the polygon is too big for one response, geometry is null and download_url points to the file.

Builds a boundary's polygon as a file (geojson, kml, wkt, svg or gml) at a detail level and returns a permanent public URL on our CDN; the REST route redirects straight to it. Use it for large polygons, GIS tools and bulk downloads. Costs 1 unit; each file is built once and then shared. Needs an API key or a connected account.

Every administrative boundary containing a point, country first down to the smallest district, plus postcode areas. Use it to tag an address, a store or a delivery with its country, state, county and city in one call. Costs 1 unit. Returns ids you can pass to get_boundary. Needs an API key or a connected account.

The direct subdivisions of a boundary: a country's states, a state's counties, a city's districts. Without admin_level it picks the next level that exists. Free and public. Use it to build drill-down pickers or to cover a region with its parts.

Tests up to 10,000 points ([lon, lat] pairs) against one boundary and returns a boolean per point plus the inside count. Use it for geofencing, service-area checks and filtering customer lists. Costs 1 unit per 1,000 points. Needs an API key or a connected account.

Merges boundaries into one polygon: the union of include minus the union of exclude (e.g. three counties minus one city). Use it for sales territories, delivery zones and service areas. Up to 50 boundaries; costs 1 unit per boundary. Returns a GeoJSON Feature with area_km2. To describe an area in words instead, use create_area. Needs an API key or a connected account.

Turns a plain-language description of an area ("Alameda and Contra Costa counties excluding San Jose, plus SFO") or wording from a contract or policy into one validated land-only polygon. An AI agent plans includes/excludes from real administrative boundaries; you get GeoJSON plus each part's source, or a 422 explaining what could not be mapped. Takes 30 s to a few minutes. For a single named place use search_boundaries + get_boundary instead: it is instant and costs 1 unit. Needs an API key or a connected account.

The signed-in account and the organization the call acts in: email and profile, the organization (id, slug, name, personal or shared) and the caller's role in it (viewer, member, admin or owner), how the call is authenticated (api_key, oauth or session), the organization's plan in force (status, renewal date, set to cancel or not), this month's use of every limit (units used and remaining, described areas remaining, API keys, requests a minute, when units reset), and what the next plan adds with its checkout_url. Plan, usage and limits belong to the organization and are shared by its members and keys. Free. Call it before a large batch to check it fits, and after a human pays to see the new plan. Needs an API key or a connected account.

無需輸入參數。

Sets the account's name, company, use case (what you are building) and language (the language for emails and the dashboard). Send only the fields to change; an empty string clears a text field. Free. Returns the updated profile. Needs an API key or a connected account.

The organization's daily usage for the last N days (default 30), by op, with cache hit counts, across every member and key. Use it to explain a bill or spot a runaway client. Needs an API key or a connected account.

The organization's API keys (prefix, name, who created it, last use; never the secret). Members see the keys they created; admins and owners see every key, including those of people who left. Needs an API key or a connected account.

Creates an API key for the organization and returns the secret once. Store it in an environment variable (GEOCODE_API_KEY); it cannot be shown again. The key acts in this organization only, with its creator's role (at most admin), and keeps working if the creator leaves until an admin revokes it. Needs an API key or a connected account.

Revokes an API key by id. Requests with it fail with 401 immediately. Members revoke the keys they created; admins and owners revoke any key in the organization. Needs an API key or a connected account.

Which automated emails the account receives: the global subscription and one switch per kind (getting-started notes, first boundary, usage milestones, quota warnings, check-ins, monthly digest). Free. Sign-in codes are always sent. Needs an API key or a connected account.

無需輸入參數。

Turns automated emails on or off: `subscribed: false` stops all of them (the same as the unsubscribe link), `subscribed: true` resubscribes, and `kinds` switches individual kinds. Kinds not named keep their setting. Free. Returns the preferences after the change. Needs an API key or a connected account.

The organizations you belong to, with your role in each and which one this call acts in (current). Personal is the one made for you at signup. An API key acts in its own organization only, so with a key this lists that one. Free. Needs an API key or a connected account.

無需輸入參數。

The people in the organization: email, name, role (viewer, member, admin, owner), when they joined and their teams. Free. Use it to find who to share a file with. Inviting, removing and changing roles is done by a person on the dashboard. Needs an API key or a connected account.

無需輸入參數。

The organization's teams: slug, name, description and members with their team role (maintainer or member). Free. Pass a team's slug to share_file to share a library file with everyone in it. Needs an API key or a connected account.

無需輸入參數。

Invitations to the organization: email, role, teams, status (pending, accepted, expired, revoked) and when they expire. Admins and owners only. Free. Sending, resending and revoking invites is done on the dashboard. Needs an API key or a connected account.

The organization's audit log, newest first: who (a person, an API key, an OAuth client or the system) changed membership, roles, teams, invites, API keys, billing or file sharing, and when. Admins and owners only. Free. Needs an API key or a connected account.

Exports a boundary (like export_boundary) and saves it in the organization's file library, so teammates find it on the dashboard and through list_files. visibility org (default) shares it with every member at their role; restricted keeps it to you, admins and whoever you share it with (share_file). Saving the same boundary, format and detail again returns the existing entry. Costs 1 unit. Returns the library entry with its permanent download url. Needs an API key or a connected account.

The boundary files in the organization's library that you can see, newest first: org-visible ones plus restricted ones shared with you or a team you are in. Each has your access (read, write or admin). Free. Needs an API key or a connected account.

One library file: its boundary, format, detail, visibility, your access, the permanent download url and, when you can manage it, who it is shared with. Free. Needs an API key or a connected account.

Renames a library file (write access) or sets its visibility (admin access on the file): org shares it with every member at their role, restricted keeps it to its creator, admins and explicit shares. Free. Needs an API key or a connected account.

Removes a file from the organization's library and its shares (admin access on the file). The exported file itself stays in the public cache; export_boundary rebuilds the url any time. Free. Needs an API key or a connected account.

Shares a library file with a team (by slug or id) or a person in the organization (by email or user id) at read, write or admin access; sharing again changes the access. Needs admin access on the file (its creator, an org admin, or an admin share). Viewers are capped at read whatever the share says. Free. Returns the file's shares. Needs an API key or a connected account.

Removes one share of a library file by its grant id (from get_file). Needs admin access on the file. Org-visible files stay visible to every member; make it restricted with update_file to limit it to its shares. Free. Needs an API key or a connected account.

The organization's plan and subscription: plan, status, when the period renews or ends, whether it is set to cancel, the price, this month's use of every limit (units, described areas, API keys, rate) and what the next plan adds, with its checkout_url. Free. The same as get_account without the profile. Call it before suggesting an upgrade, and after handing a human a checkout link to see when the payment went through (plan changes from free to the plan bought, usually within seconds). Needs an API key or a connected account.

無需輸入參數。

A link a human opens to buy a plan (pro or business) on a Stripe page branded Geocode AI. Free, and charges nothing: the person enters or confirms the card (never pass card details to a tool). With a key, the link is a Checkout page for that account (or, on a paid plan already, a page that confirms the switch, prorated). Without a key it is a Checkout page that collects the human's email and creates their account when they pay (kind guest_checkout), so an agent with no account can still hand its human one link. Give the url to the human as is, say the plan and price (monthly by default; yearly: true bills ten months' price once a year), then call get_account to see when it is paid. Never open or pay it yourself, and only call it when the human asked to buy or upgrade.

A link for the account's owner to open Stripe's Customer Portal: download invoices, change the card or billing details, switch plans, or cancel (at the end of the period already paid for). Free. The link does not expire; it asks the person to sign in to Geocode AI, then opens the portal. Fails with no_subscription when the account never had a paid plan. Needs an API key or a connected account.

無需輸入參數。

The feedback board: feature requests and published issues with their status and upvotes, most upvoted first (with a key, also your own private issues, and whether you voted). Free and needs no key. Call it before request_feature or report_issue to find an existing item to upvote instead of filing a duplicate, or when the human asks what is planned or shipped.

One feedback item with its status, upvotes, comments (official team responses marked) and timeline of status changes. Free and needs no key for public items; a private issue is visible to its reporter and the team.

What you filed (including private issues), what you follow because you voted or commented, and your review, each with its current status. Free; needs a key. Use it to check on an issue you reported or a feature you asked for. Needs an API key or a connected account.

Files a feature request on the public board and upvotes it for you. Use it when the human wishes the API did something it cannot (a boundary type, export format, op or option). It first looks for similar requests: if any match it files nothing and returns them in `similar`, so you can upvote_feedback the right one; pass force: true to file anyway. Free; needs a key; 10 new items per account a day. The human gets a thank-you email and an email on every status change. Feature requests are public (never the author's email); issues are private to you and the team. Do not include API keys, personal data or customer data. Needs an API key or a connected account.

Reports a problem with Geocode AI: a failing or wrong API call, a wrong or missing boundary, a docs error. Call it after a call fails in a way that looks like our bug (5xx, a wrong polygon, a boundary that should exist), with the failing call's request_id (X-Request-Id header or the error's request_id) and op; add query, boundary_id and the error in context. Issues are private to you and the team. It first returns similar issues you can see, filing nothing; upvote_feedback the same one or pass force: true. Free; needs a key; 10 new items per account a day. The human gets an email with the reference and on every status change. Needs an API key or a connected account.

Adds your upvote to a feature request or issue (a "me too"); votes decide what gets built and fixed first, and you get an email when its status changes. Idempotent: one vote per account. A vote on a duplicate goes to the original. Free; needs a key. Returns the item with its new vote count. Needs an API key or a connected account.

Takes back your upvote on a feature request or issue, and stops its emails unless you filed or commented on it. Free; needs a key. Returns the item with its new vote count. Needs an API key or a connected account.

Adds context to an existing feature request or issue: your use case, another failing request id, a workaround. Prefer it (with upvote_feedback) over filing a near-duplicate. You then get its status emails; its author gets a daily digest of comments. Free; needs a key; 50 comments per account a day. Feature requests are public (never the author's email); issues are private to you and the team. Do not include API keys, personal data or customer data. Needs an API key or a connected account.

Published reviews of Geocode AI with the average rating and the distribution, and the team's response under each. Free and needs no key. Use it when the human asks what other users think.

Your review of the product, if you posted one, with its status (published, pending a check, or hidden with the reason) and the team's response. Free; needs a key. Needs an API key or a connected account.

無需輸入參數。

Posts the human's public review of Geocode AI (1–5 stars, what they like and dislike, what they use it for), or replaces their existing one; each account has one review and earlier versions are kept. Only call it with the human's own rating and words, never invented ones. Published at once unless it holds links or the account is under a day old (then pending). Free; needs a key; one edit an hour. The human gets a thank-you email. Needs an API key or a connected account.

Every plan with its monthly price, included units, limits (units, described areas, requests a minute, API keys), features and checkout_url, plus what each call costs in units and what works without a key. Free and needs no key. Call it before a large batch, when the human asks what something costs, or before create_checkout_link; never quote prices from memory.

無需輸入參數。