Get a customer profile

Fetch Feature access and signed Experience delivery state.

POSThttps://i.nuxie.ai/profile

Fetch a customer’s Feature access and Experience delivery state. The SDK uses this profile to find Experiences the customer can run and verifies each signed release before displaying it.

Request

If-None-Matchheaderstring

The complete ETag from the previous response, including its quotes. An unchanged profile returns 304 with no body.

apiKeybodystringrequired

Publishable key for the app platform. A pk_test_ key selects test data; a pk_live_ key selects live data. Copy it from Connect your app.

distinct_idbodystringrequired

The identified or anonymous customer ID your app supplies to the SDK, rather than Nuxie’s internal customer record ID. See Customer identifiers.

Response

schemaVersionstringrequired

nuxie.journey-plane-profile.v2.

statusstringrequired

ok.

deliveryobjectrequired

Base URLs for rendering Experiences and loading assets.

Delivery fields

renderBaseUrlstringrequired

Base URL for Experience rendering.

assetBaseUrlstringrequired

Base URL for Experience assets.

featuresobject[]required

Active Features that apply to this platform.

Feature fields

idstringrequired

Published Feature key.

typestringrequired

boolean, metered, or creditSystem.

balancenumberrequired

Remaining units, or null for Boolean or unlimited access.

unlimitedbooleanrequired

Whether usage is unlimited.

nextResetAtnullrequired

Reset metadata.

intervalnullrequired

Interval metadata.

factsobjectrequired

Customer properties, Segment memberships, and Experiment assignments.

armedLegsobject[]required

New or continuing Journey sections available to run.

releasesobject[]required

Signed Experience content for those sections.

A customer without an available Experience can receive empty armedLegs and releases arrays. Use Check Feature access to evaluate a specific required balance and Consume Feature usage to spend units.

Caching and response headers

Header	Meaning
`ETag`	Validator for this exact response body
`Cache-Control`	`private, no-cache`; revalidate a stored response before using it
`Nuxie-App-Id`	Platform ID associated with the publishable key
`Nuxie-App-Environment`	`test` or `live`
`X-Request-Id`	Request identifier for troubleshooting

A 304 response has no body. Keep the previous profile and use the returned headers. Copy the complete ETag, including its quotes, into If-None-Match.

Profile requests from the SDK also update the connection status in Connect your app.

curl https://i.nuxie.ai/profile \
  --header 'Content-Type: application/json' \
  --data '{
  "apiKey": "pk_test_example",
  "distinct_id": "user-456"
}'

{
  "schemaVersion": "nuxie.journey-plane-profile.v2",
  "status": "ok",
  "delivery": {
    "renderBaseUrl": "https://cdn.nuxie.ai/",
    "assetBaseUrl": "https://cdn.nuxie.ai/"
  },
  "features": [],
  "facts": {
    "properties": {},
    "memberships": {},
    "assignments": {}
  },
  "armedLegs": [],
  "releases": []
}

HTTP/1.1 304 Not Modified