App

Version floor and health, for the apps and the platform.6 operations

Operations

GET/healthNo session needed

Say which build is answering

Public. Always ok with the version and build id of the process that answered; the platform's liveness and readiness probes live beside it and are not part of the contract.

Parameters

No parameters

Responses

200OK
application/jsonHealthResponse
Headers
X-Trace-Id
— The W3C trace id of this request — the same id in the log and in the traceId of a problem. Quote it when reporting.
Server-Timing
— Where the time went: total, db;dur=…;desc="N queries", and every step the handler named (ADR-163).
X-Diagnostics
— Only when the request asked with X-Diagnostics: 1 or ?diagnostics=1: the same breakdown as one JSON object, with the trace id (ADR-163).

Example

curl \
  "https://bryti.app/health"

Example response

200application/json
{
  "status": "string",
  "version": "string",
  "build": "string"
}
GET/robots.txtNo session needed

Tell crawlers to stay off the API host

Public. Plain text that disallows every path and sets the content signals to no; the API has no pages for a crawler and no sitemap.

Parameters

No parameters

Responses

200OK
text/plainstring
429Too many calls in the window; Retry-After says how long.
application/problem+jsonProblemDetails
Headers
X-Trace-Id
— The W3C trace id of this request — the same id in the log and in the traceId of a problem. Quote it when reporting.
Server-Timing
— Where the time went: total, db;dur=…;desc="N queries", and every step the handler named (ADR-163).
X-Diagnostics
— Only when the request asked with X-Diagnostics: 1 or ?diagnostics=1: the same breakdown as one JSON object, with the trace id (ADR-163).
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl \
  "https://bryti.app/robots.txt"
GET/health/liveNo session needed

Say whether the process is up

Public. The platform's liveness probe: always ok with the version and build id of the process that answered. Infrastructure rather than contract — the apps have no reason to call it.

Parameters

No parameters

Responses

200OK
application/jsonHealthResponse
Headers
X-Trace-Id
— The W3C trace id of this request — the same id in the log and in the traceId of a problem. Quote it when reporting.
Server-Timing
— Where the time went: total, db;dur=…;desc="N queries", and every step the handler named (ADR-163).
X-Diagnostics
— Only when the request asked with X-Diagnostics: 1 or ?diagnostics=1: the same breakdown as one JSON object, with the trace id (ADR-163).

Example

curl \
  "https://bryti.app/health/live"

Example response

200application/json
{
  "status": "string",
  "version": "string",
  "build": "string"
}
GET/health/readyNo session needed

Say whether this build can serve

Public. The platform's readiness probe, which Railway gates deploy cutover on: ok when the database answers and this build's migrations are all applied, 503 otherwise. The ok answer also says what is switched on — stores, billing, the provider per model task, agent access, whether the request came through the edge and the country it saw, the key ring's certificate — by name and never by value. Infrastructure rather than contract — the apps have no reason to call it.

Parameters

No parameters

Responses

200OK
application/jsonReadyResponse
Headers
X-Trace-Id
— The W3C trace id of this request — the same id in the log and in the traceId of a problem. Quote it when reporting.
Server-Timing
— Where the time went: total, db;dur=…;desc="N queries", and every step the handler named (ADR-163).
X-Diagnostics
— Only when the request asked with X-Diagnostics: 1 or ?diagnostics=1: the same breakdown as one JSON object, with the trace id (ADR-163).
503Service Unavailable
application/jsonHealthResponse
Headers
X-Trace-Id
— The W3C trace id of this request — the same id in the log and in the traceId of a problem. Quote it when reporting.
Server-Timing
— Where the time went: total, db;dur=…;desc="N queries", and every step the handler named (ADR-163).
X-Diagnostics
— Only when the request asked with X-Diagnostics: 1 or ?diagnostics=1: the same breakdown as one JSON object, with the trace id (ADR-163).

Example

curl \
  "https://bryti.app/health/ready"

Example response

200application/json
{
  "status": "string",
  "version": "string",
  "build": "string",
  "environment": "string",
  "stores": {
    "appStore": false,
    "play": false
  },
  "billing": {
    "stripe": false,
    "reconcile": false
  },
  "ai": {
    "chat": "string",
    "culinary": "string",
    "receipt": "string",
    "import": "string",
    "serving": "string",
    "translation": "string",
    "foodGroups": "string"
  },
  "agentAccess": false,
  "clientAddressSource": "string",
  "country": "string",
  "dataProtection": {
    "certificate": false
  },
  "maintenance": false
}
GET/api/v1/app/versionNo session needed

Get the oldest app version each platform may still use

Public, and the one path the version gate never blocks: a stopped build must be able to ask whether it is still stopped (ADR-070, #725). Both fields null for a platform means no floor. Never cached (Cache-Control: no-store), so a raised floor reaches the next launch.

Parameters

No parameters

Responses

200OK
application/jsonAppVersionResponse
Headers
X-Trace-Id
— The W3C trace id of this request — the same id in the log and in the traceId of a problem. Quote it when reporting.
Server-Timing
— Where the time went: total, db;dur=…;desc="N queries", and every step the handler named (ADR-163).
X-Diagnostics
— Only when the request asked with X-Diagnostics: 1 or ?diagnostics=1: the same breakdown as one JSON object, with the trace id (ADR-163).
429Too many calls in the window; Retry-After says how long.
application/problem+jsonProblemDetails
Headers
X-Trace-Id
— The W3C trace id of this request — the same id in the log and in the traceId of a problem. Quote it when reporting.
Server-Timing
— Where the time went: total, db;dur=…;desc="N queries", and every step the handler named (ADR-163).
X-Diagnostics
— Only when the request asked with X-Diagnostics: 1 or ?diagnostics=1: the same breakdown as one JSON object, with the trace id (ADR-163).
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
503The server is down for maintenance (#4693). Retry-After says when to try again; problem type maintenance. Every call under /api answers this while maintenance mode is on, the version floor included.
application/problem+jsonProblemDetails
Headers
X-Trace-Id
— The W3C trace id of this request — the same id in the log and in the traceId of a problem. Quote it when reporting.
Server-Timing
— Where the time went: total, db;dur=…;desc="N queries", and every step the handler named (ADR-163).
X-Diagnostics
— Only when the request asked with X-Diagnostics: 1 or ?diagnostics=1: the same breakdown as one JSON object, with the trace id (ADR-163).
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl \
  "https://bryti.app/api/v1/app/version"

Example response

200application/json
{
  "ios": {
    "minimum": "string",
    "storeUrl": "string"
  },
  "android": {
    "minimum": "string",
    "storeUrl": "string"
  }
}
POST/api/v1/events

Count a batch of the signed-in member's taps and screens

At most 50 events. screen, action and problemCode are short codes (lower-case letters, digits, «.», «-», «_», at most 40), never text; one that is not answers 400 event_code_invalid, more than 50 answers 400 events_batch_too_large. 204 whether or not anything was stored: with the member's usage sharing off nothing is. householdId is kept only when the caller is a member of it. Rows keep the member's id for 30 days and are then only day counts (ADR-287, #2931). Rate-limited per session, 60 a minute; over it answers 429 with Retry-After.

Parameters

No parameters

Request body

application/jsonRequiredTrackProductEventsRequest

Responses

204No Content
Headers
X-Trace-Id
— The W3C trace id of this request — the same id in the log and in the traceId of a problem. Quote it when reporting.
Server-Timing
— Where the time went: total, db;dur=…;desc="N queries", and every step the handler named (ADR-163).
X-Diagnostics
— Only when the request asked with X-Diagnostics: 1 or ?diagnostics=1: the same breakdown as one JSON object, with the trace id (ADR-163).
400Bad Request
application/problem+jsonProblemDetails
Headers
X-Trace-Id
— The W3C trace id of this request — the same id in the log and in the traceId of a problem. Quote it when reporting.
Server-Timing
— Where the time went: total, db;dur=…;desc="N queries", and every step the handler named (ADR-163).
X-Diagnostics
— Only when the request asked with X-Diagnostics: 1 or ?diagnostics=1: the same breakdown as one JSON object, with the trace id (ADR-163).
401No session, or the session is no longer valid.
application/problem+jsonProblemDetails
Headers
X-Trace-Id
— The W3C trace id of this request — the same id in the log and in the traceId of a problem. Quote it when reporting.
Server-Timing
— Where the time went: total, db;dur=…;desc="N queries", and every step the handler named (ADR-163).
X-Diagnostics
— Only when the request asked with X-Diagnostics: 1 or ?diagnostics=1: the same breakdown as one JSON object, with the trace id (ADR-163).
426The build named in X-App-Version is below its platform's version floor (ADR-070). Problem type app-version-unsupported; the only way forward is the store. Callers without the header are never turned away.
application/problem+jsonProblemDetails
Headers
X-Trace-Id
— The W3C trace id of this request — the same id in the log and in the traceId of a problem. Quote it when reporting.
Server-Timing
— Where the time went: total, db;dur=…;desc="N queries", and every step the handler named (ADR-163).
X-Diagnostics
— Only when the request asked with X-Diagnostics: 1 or ?diagnostics=1: the same breakdown as one JSON object, with the trace id (ADR-163).
429Too Many Requests
application/problem+jsonProblemDetails
Headers
X-Trace-Id
— The W3C trace id of this request — the same id in the log and in the traceId of a problem. Quote it when reporting.
Server-Timing
— Where the time went: total, db;dur=…;desc="N queries", and every step the handler named (ADR-163).
X-Diagnostics
— Only when the request asked with X-Diagnostics: 1 or ?diagnostics=1: the same breakdown as one JSON object, with the trace id (ADR-163).
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
503The server is down for maintenance (#4693). Retry-After says when to try again; problem type maintenance. Every call under /api answers this while maintenance mode is on, the version floor included.
application/problem+jsonProblemDetails
Headers
X-Trace-Id
— The W3C trace id of this request — the same id in the log and in the traceId of a problem. Quote it when reporting.
Server-Timing
— Where the time went: total, db;dur=…;desc="N queries", and every step the handler named (ADR-163).
X-Diagnostics
— Only when the request asked with X-Diagnostics: 1 or ?diagnostics=1: the same breakdown as one JSON object, with the trace id (ADR-163).
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  -X POST \
  "https://bryti.app/api/v1/events" \
  -H "Content-Type: application/json" \
  -d '{"platform":"string","appVersion":"string","events":[{"occurredAt":"2026-09-07T16:30:00Z","screen":"string","action":"string"}]}'

Schemas

AppVersionFloorResponse

PropertyTypeRequired
minimumstring | nullRequired
storeUrlstring | nullRequired

AppVersionResponse

PropertyTypeRequired
iosAppVersionFloorResponseRequired
androidAppVersionFloorResponseRequired

HealthResponse

PropertyTypeRequired
statusstringRequired
versionstringRequired
buildstringRequired

ProblemDetails

PropertyTypeRequired
typestring | null—
titlestring | null—
statusinteger (int32) | null—
detailstring | null—
instancestring | null—
codestring | null—

ProductEventItem

PropertyTypeRequired
occurredAtstring (date-time)Required
screenstringRequired
actionstringRequired
durationMsinteger (int32) | null—
problemCodestring | null—

ReadyAi

PropertyTypeRequired
chatstringRequired
culinarystringRequired
receiptstringRequired
importstringRequired
servingstringRequired
translationstringRequired
foodGroupsstringRequired

ReadyBilling

PropertyTypeRequired
stripebooleanRequired
reconcilebooleanRequired

ReadyDataProtection

PropertyTypeRequired
certificatebooleanRequired

ReadyResponse

PropertyTypeRequired
statusstringRequired
versionstringRequired
buildstringRequired
environmentstringRequired
storesReadyStoresRequired
billingReadyBillingRequired
aiReadyAiRequired
agentAccessbooleanRequired
clientAddressSourcestringRequired
countrystring | nullRequired
dataProtectionReadyDataProtectionRequired
maintenancebooleanRequired

ReadyStores

PropertyTypeRequired
appStorebooleanRequired
playbooleanRequired

TrackProductEventsRequest

PropertyTypeRequired
platformstringRequired
appVersionstringRequired
eventsProductEventItem[]Required
householdIdstring (uuid) | null—