Menu: Identity

Identity

The calling key, the organisation and the API's health.

GET/v1/health

Liveness probe

healthNo key

Public and unauthenticated. Answers in the usual envelope.

Returns

200 The API is up. data is Health.

Fields of data

status"ok"required
version"v1"required

Errors

Request

curl "https://app.zentiqai.com/v1/health"

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.health();

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.health()

Example answer

Response

{
  "data": {
    "status": "ok",
    "version": "v1"
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}

GET/v1/me

Identify the calling API key

getMeAny keyread: 600/min per key

The key, its organisation, plan and limits. Any valid key may call it: a quick check that a key works.

Returns

200 The calling key and its organisation. data is Me.

Fields of data

organizationobjectrequired
- idstringrequired
  Organisation id (org_…).
  pattern `^org_.*`
- displayNamestringrequired
  The name the organisation chose for the API (never an internal workspace name).
- planstringrequired
  The plan's code (free, starter, plus, pro, business, enterprise).
- createdAtstring (date-time)required
  ISO 8601 UTC timestamp.
planobjectrequired
- keystringrequired
- namestringrequired
- includedMinutesnumber | nullrequired
  The plan's minutes this cycle; null on an unlimited account.
- featuresstring[]required
  The plan's features that are on (dashboards.serve, embed.website, api.access, …).
limitsobjectrequired
- maxConcurrentSessionsinteger | nullrequired
  Live sessions at once; null = no limit.
- activeSessionsintegerrequired
- minutesRemainingnumber | nullrequired
  Minutes the account can still spend (and within its own monthly API cap); null = unlimited.
rateLimitsobjectrequired
The rate limits this key works within (RateLimit-* headers on every answer).
- windowSecondsintegerrequired
- perKeyobjectrequired
  Requests per window, by operation class (each operation's class is in the reference as x-zentiq-rate-class).
  - readintegerrequired
  - writeintegerrequired
  - liveintegerrequired
  - heavyintegerrequired
  - searchintegerrequired
- perOrganizationobjectrequired
  Shared by all of the organisation's keys.
  - readintegerrequired
  - writeintegerrequired
  - liveintegerrequired
  - heavyintegerrequired
  - searchintegerrequired
apiKeyobjectrequired
- idstringrequired
  API key id (key_…).
  pattern `^key_.*`
- namestring | nullrequired
- prefixstringrequired
  The key's first characters, as shown in the console.
- scopesstring[]required
  The key's scopes as set on it; [] or ["*"] is full access.
- effectiveScopesstring[]required
  Every scope the key holds, after full access and the implied scopes of keys made before 2026-10-01.
- fullAccessbooleanrequired
- apiVersion"2026-07-08" | "2026-10-01"required
  The contract the key is pinned to (Zentiq-Version may ask for a newer one).
- lastUsedAtstring (date-time) | nullrequired
- createdAtstring (date-time)required
  ISO 8601 UTC timestamp.

Errors

invalid_request unauthorized forbidden upgrade_required rate_limited server_error

Request

curl "https://app.zentiqai.com/v1/me" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY"

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.getMe();

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.get_me()

Example answer

Response

{
  "data": {
    "organization": {
      "id": "org_cmfq2b7x10000abcd1234",
      "displayName": "…",
      "plan": "pro",
      "createdAt": "2026-09-25T12:00:00.000Z"
    },
    "plan": {
      "key": "pro",
      "name": "Pro",
      "includedMinutes": 1,
      "features": [
        "api.access",
        "dashboards.serve",
        "embed.website"
      ]
    },
    "limits": {
      "maxConcurrentSessions": 1,
      "activeSessions": 1,
      "minutesRemaining": 1
    },
    "rateLimits": {
      "windowSeconds": 1,
      "perKey": {
        "read": 1,
        "write": 1,
        "live": 1,
        "heavy": 1,
        "search": 1
      },
      "perOrganization": {
        "read": 1,
        "write": 1,
        "live": 1,
        "heavy": 1,
        "search": 1
      }
    },
    "apiKey": {
      "id": "key_cmfq2b7x10000abcd1234",
      "name": "Zoe",
      "prefix": "zq_live_ab12",
      "scopes": [
        "…"
      ],
      "effectiveScopes": [
        "…"
      ],
      "fullAccess": true
    }
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}