# Usage

> This month's learning and answers for the whole account, against your plan.

This month's learning and answers for the whole account, against your plan. This page is generated from the API's own spec, so it says exactly what the API does.

## This month's use

`GET /v1/usage`

What was learned and answered this month, against your plan. Saving, briefings and search are free and never
counted. Past the plan nothing is lost: saves are kept, found by search at once, and learned next month, or at
once with extra learning on. The same figures come with every response, in the X-Geniffy-Usage headers.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `X-Geniffy-Space` | header | string | One of your own users, for every call this client makes. Leave it out for your own memory; a blank one is refused. (up to 128 characters) |

**Returns** `200`

| Field | Type | | Description |
| --- | --- | --- | --- |
| `plan` | string | required | free, pro or max: the same plans for everyone, the API in every one |
| `trial` | boolean | required | On the 14 days of Pro every account gets once |
| `period_start` | string | required | When this month's use began counting |
| `period_end` | string | required | When it resets |
| `learned_tokens` | integer | required | Tokens learned this month from everything saved, every way in, your app's end users included (at least 100 a save; an edit counts only what is new) |
| `included_tokens` | integer | required | The tokens the plan learns in a month |
| `waiting_tokens` | integer | required | Saved and searchable, waiting to be learned next month (or at once with extra learning on) |
| `answers` | integer | required | Written answers and context blocks this month |
| `included_answers` | integer | required | Written answers the plan includes in a month |
| `extra_on` | boolean | required | Extra learning: past the plan, saves are learned and questions answered at once, $15 per million tokens and $15 per 1,000 answers, up to the cap |
| `extra_cap_usd` | number | required | The most extra learning may come to this month |
| `extra_used_usd` | number | required | What extra learning has come to so far this month |
| `state` | `ok`, `near`, `over`, `extra`, `paused` | required | Learning against the plan: near at 80%; over: new saves wait; extra: extra learning carries on; paused: what waits is so large that new saves are refused |

Source: https://docs.geniffy.com/api/usage