account

Return the caller's account: identity, plan, entitlements, cost ceilings

Returns the org this key is bound to (server-resolved from auth, never the body), the current plan, a per-feature entitlements map, and costCeilings (e.g. the generate_media per-call USD ceiling). Read it BEFORE a metered call (create_render / compose / generate_media / create_brand_kit) to budget without burning a round-trip on a 402. READ balance, NOT included: most capabilities are credit-funded — rendering, generation, previews, the judge and the Director carry no separate per-plan allowance and instead spend the shared wallet named in fundedBy, so each balance is that one wallet restated in the feature's own unit. Generation is also bounded by the disclosed generationLimit for accounts that have not purchased credits; included:false means the plan genuinely lacks the feature. Plan/entitlement values come from the billing backend best-effort; unknown values are null and billingConfigured:false flags an environment where billing isn't configured.

get/v1/me

Request

  • Base URL: https://api.cueframe.ai
  • URL: https://api.cueframe.ai/v1/me
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.cueframe.ai/api/auth/mcp/authorize, token URL https://api.cueframe.ai/api/auth/mcp/token)
    • API key in header PAYMENT-SIGNATURE

Response

The caller's account, plan, entitlements, and cost ceilings.

orgIdstring required

The org this API key is bound to — resolved server-side from the Authorization credential, NEVER from the request body/query.

displayNamestring nullable required

Org/customer display name from the billing record; null when not set or unknown.

entitlementsobject required

Per-feature entitlements keyed by featureId. Covers the billing-gated capabilities: exports gates create_render AND generate_media output; compose gates compose; brand_kits gates create_brand_kit; resource_import gates import_resource (a boolean grant: listUsdPerUnit 0 — stock search and import cost no credits for a keyed caller); plus ai_tokens/storage/compose_verify/compose_capture/etc. Read listUsdPerUnit for what one unit costs before you spend it. Most capabilities are CREDIT-FUNDED — included is true and the real limit is balance, drawn from the shared wallet named in fundedBy (credits — generation included; a free org is additionally bounded by a generation cap). So read balance, not included, to decide whether you can afford a call; included:false means the plan genuinely lacks the feature. Check BEFORE a metered call to avoid a mid-workflow 402 billing_required (whose error details.featureId names the gating feature).

billingConfiguredboolean required

false = billing is not configured in this environment, so plan/entitlement values are best-effort and may be null (unknown), not authoritative.

Changes

No recorded changes to this operation across all 1 revision of this API.