Skip to main content

Getting started

This walkthrough takes you from a fresh account to a first successful API call in three steps: sign up → create a key → call an endpoint.

1. Sign up​

Create an account at console.altuq.ai. You can sign in and look around straight away, but verifying your email is required before you can create organizations, projects, or API keys.

After signing up, check your inbox for a verification email and click its link — it opens a confirmation page in the console. Until you confirm, a banner at the top of the console offers to resend the link (already double-clicked the link? It is single-use and expired links can be resent from that banner). Once verified the banner disappears and creation is unlocked.

Inside the console you work within an organization, which owns one or more projects. A project is the unit an API key belongs to and that usage is metered against.

2. Create an API key​

In the console, open a project and create an API key. The key is shown once, at creation time — copy it immediately and store it somewhere safe. It is not recoverable afterwards; if you lose it, revoke it and issue a new one.

A key looks like this:

ak_1a2b3c4d_9f8e7d6c5b4a3210fedcba9876543210

See Authentication for the exact format and how the key is sent on each request.

3. Make your first call​

Every request carries the key in an Authorization: Bearer header. Here is a forward-geocoding call that resolves a place name to coordinates:

curl "https://api.altuq.ai/v1/geocoding/forward?query=Tokyo%20Station" \
  -H "Authorization: Bearer ak_1a2b3c4d_9f8e7d6c5b4a3210fedcba9876543210"

A successful response is wrapped in the standard data envelope:

{
  "data": {
    "results": [
      {
        "formatted": "Tokyo Station",
        "latitude": 35.681,
        "longitude": 139.767,
        "confidence": 0.9,
        "precision": "parcel"
      }
    ]
  }
}

That's it — you've made your first metered API call. Usage is recorded against the key's project and visible in the console.

Where to go next​

  • Authentication — key format, the Authorization header, and what a rejected key looks like.
  • Errors — the error envelope and the full list of codes.
  • Rate limits — how throttling works and how to back off.
  • Geocoding — every parameter and response field for the forward and reverse endpoints.