> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Report consumption over a period > Token and cost consumption between two instants, grouped by model. ## OpenAPI ````yaml /en/openapi/v3-current/narya.yaml get /v1/records/usage openapi: 3.1.0 info: title: Narya Host API version: 1.0.0 description: >- The contract between the Narya host and every client. One long-lived host runs on your machine and serves this API over a Unix socket in your Narya home. Narya creates the socket owner-only, and file permissions are the whole authorization. There is no password, no token and no TLS. The terminal client and the one-shot command that Lerian ships drive this API, and a client you write drives the same one. Results never arrive on the response of the request that caused them. Submitting a message returns 202 with a turn id. Everything the turn produces streams over GET /v1/events as server-sent events with a typed envelope, and a stream resumes from a Last-Event-ID header. One error envelope: code, title, message, and fields on 422. Codes are NRY- followed by four digits. A paged list answers items, limit and a nextCursor when more remains. Cursors are opaque. servers: [] security: [] tags: - name: host description: The host process itself — version, uptime, mode, store. - name: sessions description: Durable conversation containers. Archive, never destroy. - name: messages description: Submitting work into a session and interrupting it. - name: events description: The server-sent event stream every client consumes. - name: lanes description: Parallel tracks inside a session — main, subagent, side. - name: agents description: Named recipes — instructions, tools, model, policy. Read-only in v1. - name: ladder description: >- What a person can type: the skills and command files in force for one repository, and expanding one into text. Five origins merged, nearest winning a name, the repository's own rungs gated on trust. - name: permissions description: Pending permission asks, decisions, and the decision audit. - name: intercom description: Sessions on one machine finding and messaging each other. - name: packages description: The one thing a user installs — resources, Go code, or both. - name: workflows description: Deterministic multi-agent orchestration runs. - name: providers description: Model suppliers, their auth state, and the model catalogue. - name: monitors description: >- Long-running watchers a session keeps beside its conversation — a test runner in watch mode, a build, a log being followed. Started by the model or by the person, always listed, always killable. - name: records description: The queryable local record of everything that happened. - name: schedules description: >- Work the host's own clock starts with nobody present — a repository, a prompt, a rule and what one fire may spend. Cancel, never destroy. paths: /v1/records/usage: get: tags: - records summary: Report consumption over a period description: Token and cost consumption between two instants, grouped by model. operationId: getRecordUsage parameters: - name: from in: query required: true description: Start of the period, inclusive. schema: type: string format: date-time - name: to in: query required: true description: End of the period, exclusive. schema: type: string format: date-time - name: groupBy in: query required: false description: >- Grouping dimension. Only model in v1; new dimensions may be added without breaking clients. schema: type: string enum: - model default: model responses: '200': description: The usage report. content: application/json: schema: $ref: '#/components/schemas/UsageReport' '400': $ref: '#/components/responses/BadRequest' '500': $ref: '#/components/responses/InternalServerError' components: schemas: UsageReport: type: object description: Consumption over a period, broken down by the requested dimension. required: - from - to - groupBy - rows properties: from: type: string format: date-time to: type: string format: date-time groupBy: type: string enum: - model rows: type: array items: $ref: '#/components/schemas/UsageRow' examples: - from: '2026-08-01T00:00:00.000Z' to: '2026-08-08T00:00:00.000Z' groupBy: model rows: - group: claude-sonnet-4-5 inputTokens: 2400000 outputTokens: 130000 costUsd: 9.15 UsageRow: type: object description: Consumption for one group over the queried period. required: - group - inputTokens - outputTokens - costUsd properties: group: type: string description: The group key — a model id when groupBy is model. inputTokens: type: integer minimum: 0 outputTokens: type: integer minimum: 0 cacheReadTokens: type: integer minimum: 0 description: >- Tokens served from the provider's prompt cache over the period. Absent for a period whose rows recorded none. cacheWriteTokens: type: integer minimum: 0 description: >- Tokens written into the provider's prompt cache over the period. Absent for a period whose rows recorded none. costUsd: type: number minimum: 0 costComplete: type: boolean description: >- False when at least one model round in this group recorded no cost at all, which makes costUsd a floor rather than the bill. Pricing is not resolved for every model, so a zero here can mean "free" or "unknown" — this field is what tells them apart, and a reader showing money must say so rather than print a total it cannot stand behind. Absent means the same as true. examples: - group: claude-sonnet-4-5 inputTokens: 2400000 outputTokens: 130000 costUsd: 9.15 costComplete: true Error: type: object description: >- The single error envelope every operation returns. Codes are NRY- followed by four digits and are catalogued in the top-level x-error-catalog extension. fields appears only on 422 validation errors, mapping each offending property to its problem. required: - code - title - message properties: code: type: string pattern: ^NRY-[0-9]{4}$ description: Machine-readable error code from the NRY catalogue. title: type: string maxLength: 256 description: Short human-readable summary of the error class. message: type: string maxLength: 4096 description: Specific, actionable description of what went wrong. fields: type: object description: Per-field validation problems. Present on 422 only. additionalProperties: type: string examples: - code: NRY-0002 title: Session not found message: >- No session with id 6b9f6d2e-1c3a-4f5b-9d7e-2a8c4e6f0b1d exists on this host. responses: BadRequest: description: Malformed request — invalid parameter, cursor, or JSON body. content: application/json: schema: $ref: '#/components/schemas/Error' InternalServerError: description: The host failed — including a store that refuses writes (NRY-0012). content: application/json: schema: $ref: '#/components/schemas/Error' ````