API reference

GETWho am I

GET /v1/me: The credential's organization (or partner), effective scopes (key ∩ grant ∩ plan), entitlements, limits and API version.

GEThttps://api.light-ai.app/v1/me

The credential's organization (or partner), effective scopes (key ∩ grant ∩ plan), entitlements, limits and API version. Doubles as an authenticated health check. Partner keys add Light-AI-Organization to see one connected organization.

Credential	API key: `Authorization: Bearer lai_live_…` (or `lai_test_…`). Partner keys add `Light-AI-Organization`.
Test mode	Works with test keys (test objects only).

Headers#

Light-AI-Organizationstring#

Partner keys: the connected organization to act for (org_…). Organization keys may omit it. Id prefix org_.

Light-AI-Versionstring#

Pin a dated API version (defaults to the key's version). One of: 2026-11-01.

Response 200#

The principal.

objectstringrequired#

Always principal.

livemodebooleanrequired#

false for objects created with a test key.

keyobjectrequired#

key.idstringrequired#

Id prefix key_.

key.namestringrequired#

key.livemodebooleanrequired#

false for objects created with a test key.

key.scopesstring[]required#

One of: leads:read, leads:write, clients:read, clients:write, projects:read, projects:write, quotes:read, quotes:write, quotes:share_link, quotes:asset_links, webhooks:manage, events:read, mockups:read, mockups:write, forms:read, forms:write.

key.expires_attimestamp | nullrequired#

RFC 3339 timestamp (UTC, milliseconds).

key.expires_in_daysinteger | nullrequired#

key.replaced_bystring | nullrequired#

Id prefix key_.

partnerobject | nullrequired#

partner.idstringrequired#

Id prefix ptr_.

partner.objectstringrequired#

Always partner.

partner.legal_namestringrequired#

partner.display_namestringrequired#

partner.verified_domainstringrequired#

partner.statusstringrequired#

partner.verifiedbooleanrequired#

partner.active_grantsintegerrequired#

organizationobject | nullrequired#

organization.idstringrequired#

Id prefix org_.

organization.namestring | nullrequired#

organization.timezonestring | nullrequired#

organization.pausedbooleanrequired#

grantobject | nullrequired#

grant.idstringrequired#

Id prefix grant_.

grant.scopesstring[]required#

grant.external_referencestring | nullrequired#

grant.metadataobjectrequired#

scopesstring[]required#

Effective scopes: key ∩ grant ∩ the organization's plan. One of: leads:read, leads:write, clients:read, clients:write, projects:read, projects:write, quotes:read, quotes:write, quotes:share_link, quotes:asset_links, webhooks:manage, events:read, mockups:read, mockups:write, forms:read, forms:write.

entitlementsobject | nullrequired#

limitsobjectrequired#

limits.reads_per_minuteintegerrequired#

limits.writes_per_minuteintegerrequired#

limits.lead_daily_capinteger | nullrequired#

api_versionstringrequired#

Errors#

Status	Meaning
`400`	Bad request. `bad_request`, `test_mode_mismatch`, `test_mode_unsupported`, `unsupported_api_version`
`401`	Missing or invalid credential. `authentication_required`, `invalid_api_key`, `api_key_revoked`, `api_key_expired`, `api_key_suspended`
`403`	Not allowed. `insufficient_scope`, `plan_upgrade_required`, `organization_paused`, `organization_off_season`, `api_disabled`, `api_access_not_enabled`, `ip_not_allowed`, `forbidden`
`404`	Not found (also for objects of other organizations and for organizations without an active grant).
`422`	Validation failed. `idempotency_key_reused`
`429`	Rate limited or daily cap reached. See Retry-After and the RateLimit headers. `rate_limited`, `daily_cap_reached`
`500`	Unexpected server error. Safe to retry with exponential backoff; quote the Request-Id to support. `internal_error`
`503`	Temporarily unavailable. Retry with exponential backoff. `service_unavailable`

Request

curl -X GET "https://api.light-ai.app/v1/me" \
  -H "Authorization: Bearer $LIGHT_AI_API_KEY"

const response = await fetch('https://api.light-ai.app/v1/me', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LIGHT_AI_API_KEY}`,
  },
});
const data = await response.json();

import os, uuid, requests

response = requests.get(
    "https://api.light-ai.app/v1/me",
    headers={
        "Authorization": f"Bearer {os.environ['LIGHT_AI_API_KEY']}",
    },
    timeout=30,
)
data = response.json()

Response 200JSON

{
  "object": "principal",
  "livemode": false,
  "key": {
    "id": "key_3f9c2a7be41d…",
    "name": "Dana Reyes",
    "livemode": false,
    "scopes": [
      "leads:read"
    ],
    "expires_at": "2026-10-12T14:03:11.000Z",
    "expires_in_days": 0,
    "replaced_by": "key_3f9c2a7be41d…"
  },
  "partner": {
    "id": "ptr_3f9c2a7be41d…",
    "object": "partner",
    "legal_name": "string",
    "display_name": "Dana Reyes",
    "verified_domain": "string",
    "status": "string",
    "verified": true,
    "active_grants": 0
  },
  "organization": {
    "id": "org_3f9c2a7be41d…",
    "name": "Dana Reyes",
    "timezone": "string",
    "paused": true
  },
  "grant": {
    "id": "grant_3f9c2a7be41d…",
    "scopes": [
      "leads:read"
    ],
    "external_reference": "string",
    "metadata": {}
  },
  "scopes": [
    "leads:read"
  ],
  "entitlements": {},
  "limits": {
    "reads_per_minute": 0,
    "writes_per_minute": 0,
    "lead_daily_cap": 0
  },
  "api_version": "2026-11-01"
}