/** * January AI - Nutrition Intelligence APIs * Build food and metabolic intelligence into your product — one API for understanding what people eat and how food may affect them. **Clinical-grade precision, consumer-grade experiences.** January builds the infrastructure underneath the product: turning messy health and nutrition data into reliable intelligence, so your team spends its time on the experience instead of the foundation. **Security & compliance** — **SOC 2 Type II** · **HIPAA-aligned practices** · **BAA** and **Zero Data Retention (ZDR)** available **What you can build** - **Scan food** — photo and text food recognition: detect foods and nutrition, then correct results conversationally - **Search the food database** — by name or barcode — and get healthier alternatives for any food - **Log food, water and weight** — per-user diaries with day-range queries - **Predict glucose response** to any meal — no sensor required **Getting started** 1. Create an API key in the [Developer Dashboard](https://dashboard.january.ai) — the full key is shown once, at creation. 2. Send it as `Authorization: Bearer sk-…` — click **Authorize** here to make every example below a live request. 3. On the endpoints that read or write an end user\'s logs, say whose with the `January-End-User-ID` header — each one documents it. No other endpoint takes it: everything else either asks the shared food database a question or works on the body you send, and neither depends on who the food is for. **Calling from a mobile app** — your `sk-` key must never ship inside an app. Instead, exchange it on your backend for a *client token*: a credential that lasts up to two hours, acts as exactly one of your end users, and carries only the scopes you grant it (see the **authentication** section). Your app then calls these endpoints directly, with no proxy of your own in the request path. Both credentials travel in the same `Authorization: Bearer` header, and every endpoint below opens by saying which it accepts — **API key or client token**, or **API key only**. **Support** — [support@january.ai](mailto:support@january.ai) · [Discord community](https://discord.gg/cYQeh3UnC) · [docs.january.ai](https://docs.january.ai) * * The version of the OpenAPI document: 1.2 * Contact: support@january.ai * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface CreditBalance */ export interface CreditBalance { /** * The plan this allowance comes from. `unlimited` is a partner with no ceiling, for whom both ceiling fields are `null`. * @type {string} * @memberof CreditBalance */ plan: string; /** * First day of the current billing period (UTC), inclusive. * @type {Date} * @memberof CreditBalance */ periodStart: Date; /** * Last day of the current billing period (UTC), inclusive. * @type {Date} * @memberof CreditBalance */ periodEnd: Date; /** * When the allowance resets and `used_credits` returns to 0. * @type {Date} * @memberof CreditBalance */ resetsAt: Date; /** * Credits included in the plan for this period, or `null` when the plan has no ceiling. * @type {number} * @memberof CreditBalance */ includedCredits: number | null; /** * Credits used so far this period. Billable operations consume credits — how many depends on the operation and your plan — while failed calls cost nothing. * @type {number} * @memberof CreditBalance */ usedCredits: number; /** * Credits left in this period, or `null` when the plan has no ceiling. * @type {number} * @memberof CreditBalance */ remainingCredits: number | null; } /** * Check if a given object implements the CreditBalance interface. */ export declare function instanceOfCreditBalance(value: object): value is CreditBalance; export declare function CreditBalanceFromJSON(json: any): CreditBalance; export declare function CreditBalanceFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreditBalance; export declare function CreditBalanceToJSON(json: any): CreditBalance; export declare function CreditBalanceToJSONTyped(value?: CreditBalance | null, ignoreDiscriminator?: boolean): any; //# sourceMappingURL=CreditBalance.d.ts.map