Log in

Quickstart

Global Mosaic docs are personalized by account level. Public docs explain the workflow and access model. Signed-in and customer docs add the concrete examples enabled for your account.

1. Choose your path

GoalStart here
Evaluate Global MosaicReview the capability overview and request access.
Use the map workspaceSign in, open Workspace, and run a boundary or polygon query.
Integrate the APICreate an API key from Profile, then use the customer API guide.
Interpret resultsUse the customer Data Access guide for output and limitation notes.

2. Get access

  1. Sign up or log in at globalmosaic.xyz/login.
  2. Open your profile page.
  3. Create an API key if your account is eligible for API access.
  4. Store the key securely. Do not paste real keys into source code, docs, screenshots, or chat.

Set your environment:

export GLOMO_API_URL="https://www.globalmosaic.xyz/api"
export GLOMO_API_KEY="gm_live_..."

3. Understand the API flow

Global Mosaic API queries are asynchronous:

  1. Send a query request to start a job.
  2. Receive a job_id.
  3. Poll the job until it is complete or failed.
  4. Read the inline result or follow the short-lived result URL.
POST/invokex-api-key

Starts an async query job for the data groups enabled on your account.

curl -sS -X POST "$GLOMO_API_URL/invoke" \
  -H "content-type: application/json" \
  -H "x-api-key: $GLOMO_API_KEY" \
  -d '{
    "layers": {
      "<enabled-layer>": [{ "year": "2025" }]
    },
    "gid": "<boundary-id>"
  }'

For one location, replace gid with an explicit point:

{
  "point": {
    "latitude": 32.66431,
    "longitude": -86.91668
  }
}
Accepted job202
{
  "job_id": "0dfb87d0-c2a6-4115-b892-38e56c6f31e8",
  "status": "running",
  "poll_after_seconds": 2,
  "metadata": {
    "invocation_count": 1,
    "quota_used_before": 0,
    "quota_used_after": 1,
    "quota_limit": 10000,
    "tier": "beta"
  }
}

4. Poll the job

GET/jobs/{job_id}x-api-key

Poll with the same API key that started the job.

curl -sS "$GLOMO_API_URL/jobs/0dfb87d0-c2a6-4115-b892-38e56c6f31e8" \
  -H "x-api-key: $GLOMO_API_KEY"

Poll until status is complete or failed. Completed jobs include either an inline result or a short-lived signed URL depending on result size.

5. Next steps