Build APIs

API Reference

Orientation to Tamaat public and product API surfaces served from API Builder and the interactive edge.

Updated 2026-08-158 minutes read
Before you begin
  • Access to an API product or workspace API key

Tamaat exposes dataset-backed product APIs through API Builder (autocomplete, geocode, query / DaaS) and platform management routes behind authenticated workspace access.

Product APIs

After you build and test an API:

  • Public paths follow /api/{slug}/autocomplete, /geocode, and /query (plus handle-scoped public variants).
  • Access is controlled with access keys and restrictions.
  • Stale product indexes return 503 with retry guidance while rebuild runs.

OpenAPI lock

The repository keeps a generated OpenAPI lock at apps/docs/api/openapi.lock.json. Treat that file as the machine-readable contract synced at release time. Human how-tos live in this Build APIs section; the lock is the endpoint inventory for integrators and CI.

Authentication patterns

  • Product / public API keys — send the key as required by the product’s access policy.
  • Published web maps — use publish tokens separately from platform login when maps are restricted.
  • Workspace session — management and builder surfaces use the signed-in Tamaat session.

FAQ

Where is the interactive Swagger UI?
Use the API Builder test surface for product endpoints. The OpenAPI lock is the checked-in contract for automation and release parity.

Was this page helpful?