Skip to main content

Altuq API

The Altuq API is a REST edge for developers. You authenticate with an API key, call an endpoint, and get back a JSON response. Authentication, rate limiting, and usage metering are handled at the edge, in front of every product.

  • Base URL: https://api.altuq.ai
  • Transport: HTTPS only. All requests and responses are JSON.
  • Auth: an Authorization: Bearer <api key> header on every request (Authentication).

Products

ProductBase pathReference
Geocoding/v1/geocodingGeocoding

More products will appear here as they launch. Every product shares the same authentication, error envelope, and rate-limit conventions described in these docs.

Conventions at a glance

  • Every successful response wraps its payload in a top-level data object:

    { "data": { "results": [] } }
  • Every error uses one stable envelope, whatever the endpoint:

    { "error": { "code": "rate_limited", "message": "rate limit exceeded" } }
  • Requests are versioned by path prefix (/v1/...). A breaking change to a response is a new version, never a silent change to an existing one.

Next steps

  1. Getting started — sign up, create a key, make your first call.
  2. Authentication — the API-key format and how keys are sent.
  3. Geocoding — the forward and reverse geocoding reference.
note

The management API behind the console (creating orgs, projects, and keys) is driven through the console UI and is not part of this public reference. These docs cover the customer-facing data-plane API only.