API reference

POSTAdd a property to a client

POST /v1/clients/{client_id}/properties: An identical address returns the existing property.

POSThttps://api.light-ai.app/v1/clients/{client_id}/properties

An identical address returns the existing property. is_primary moves the primary flag atomically.

Scope	`clients:write`
Credential	API key: `Authorization: Bearer lai_live_…` (or `lai_test_…`). Partner keys add `Light-AI-Organization`.
Test mode	Works with test keys against simulated test objects.
Idempotency	`Idempotency-Key` supported. See Idempotency.

Path parameters#

client_idstringrequired#

The client id (cli_…). Id prefix cli_.

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.

Idempotency-Keystring#

Retry-safe writes: the same key and body replay the first response for 24 hours (Idempotent-Replayed: true). 8–128 characters.

Request body#

addressobjectrequired#

A street address. A ZIP-, city- or region-only address is refused (422 at /address).

address.line1string | null#

At most 200 characters.

address.line2string | null#

At most 200 characters.

address.citystring | null#

At most 120 characters.

address.regionstring | null#

State or region, e.g. TX. At most 120 characters.

address.postal_codestring | null#

At most 20 characters.

address.countrystring | null#

ISO 3166-1 alpha-2 in any case, or a common name ("USA", "United States"); normalized to alpha-2. Defaults to US. At most 60 characters.

address.formattedstring | null#

A one-line address, when components are not available. At most 500 characters.

address.latnumber | null#

-90–90.

address.lngnumber | null#

-180–180.

address.place_idstring | null#

Google place id, when known (best dedupe key). At most 300 characters.

property_typestring#

At most 50 characters.

is_primaryboolean#

Make this the client's primary property.

Response 201#

The property (id only without clients:read).

idstring#

Id prefix prop_.

objectstring#

Always property.

client_idstring | null#

Id prefix cli_.

is_primaryboolean#

property_typestring | null#

addressobject | null#

address.line1string | nullrequired#

address.line2string | nullrequired#

address.citystring | nullrequired#

address.regionstring | nullrequired#

address.postal_codestring | nullrequired#

address.countrystring | nullrequired#

address.formattedstringrequired#

Always present. Components may be null for addresses entered as one line.

address.latnumber | nullrequired#

address.lngnumber | nullrequired#

created_attimestamp#

RFC 3339 timestamp (UTC, milliseconds).

updated_attimestamp#

RFC 3339 timestamp (UTC, milliseconds).

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).
`409`	Conflict. `stale_state`, `conflict`, `idempotency_in_progress`, `idempotency_scope_mismatch`, `quote_already_decided`, `quote_not_current`, `billing_review_required`
`413`	Request bodies are limited to 256 KB.
`415`	The body is not JSON: send Content-Type: application/json. `unsupported_media_type`
`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 POST "https://api.light-ai.app/v1/clients/{client_id}/properties" \
  -H "Authorization: Bearer $LIGHT_AI_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "address": {
    "line1": "88 Lantern Way",
    "city": "Austin",
    "region": "TX",
    "postal_code": "78731"
  },
  "is_primary": false
}'

const response = await fetch('https://api.light-ai.app/v1/clients/{client_id}/properties', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LIGHT_AI_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "address": {
      "line1": "88 Lantern Way",
      "city": "Austin",
      "region": "TX",
      "postal_code": "78731"
    },
    "is_primary": false
  }),
});
const data = await response.json();

import os, uuid, requests

response = requests.post(
    "https://api.light-ai.app/v1/clients/{client_id}/properties",
    headers={
        "Authorization": f"Bearer {os.environ['LIGHT_AI_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
      "address": {
        "line1": "88 Lantern Way",
        "city": "Austin",
        "region": "TX",
        "postal_code": "78731"
      },
      "is_primary": False
    },
    timeout=30,
)
data = response.json()

Response 201JSON

{
  "id": "prop_3f9c2a7be41d…",
  "object": "property",
  "client_id": "cli_3f9c2a7be41d…",
  "is_primary": true,
  "property_type": "string",
  "address": {
    "line1": "4102 Oak Hollow Dr",
    "line2": "string",
    "city": "Austin",
    "region": "TX",
    "postal_code": "78731",
    "country": "US",
    "formatted": "string",
    "lat": 0,
    "lng": 0
  },
  "created_at": "2026-10-12T14:03:11.000Z",
  "updated_at": "2026-10-12T14:03:11.000Z"
}