> ## Documentation Index > Fetch the complete documentation index at: https://docs.reflections.ai/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > The OpenAPI document at /api-reference/openapi.yaml defines the target contract. Its x-reflections-availability field and each operation's availability notice identify supported test and live forms. Do not infer implementation from a schema or code sample. Live keys support account details, reads of the licenses the calling account holds as licensee or issued as talent (GET /v1/licenses?role=issuer), and GET /v1/generations?license=… for the state of outputs under such a license (summaries only: no prompt, reference, bytes or metadata). Live image checks, submissions and receipts are built but not activated: until activation, a live POST /v1/checks or /v1/generations returns 403 live_not_activated, which must not be retried. Discovery and JWKS are at the origin root (https://app.reflections.ai/.well-known/...), not under /v1. > Three rules hold everywhere: a decision is never an error (deny and escalate are 200 responses, and a live check still evaluating is a 202 with status checking); generate nothing for a named talent without an allow; deliver nothing until the generation is allow. > The sandbox accepts personal rk_test_ keys. Persist a separate Idempotency-Key and body for each logical /v1 POST; retry an unknown outcome with the same key and body. OAuth and Talent API MCP remain planned. # List usage records > **Planned contract — unavailable in test and live modes.** This operation is a protocol reference, not a callable endpoint. Start with the [working sandbox quickstart](/quickstart). Lists the usage records you reported. A representative whose mandate has `receive_statements` sees every usage record under the talent's licenses. Restricted keys need `usage:write` or `usage:read`. ## OpenAPI ````yaml /api-reference/openapi.yaml get /usage_records openapi: 3.1.0 info: title: Reflections Talent API version: '2026-10-15' summary: The license server for a person's name, likeness and voice in generative AI. description: > This document defines the target Talent API contract. Each operation declares its current test and live availability. Test mode serves a limited fictional sandbox. Live keys support account details and reading the caller's own licenses. The initial live image check, submission and receipt implementation is deployed, but requires separate live signing activation and production acceptance. Start at https://docs.reflections.ai/quickstart for test mode. The target API lets any product that can generate a real person check whether a use is licensed, verify the output it made, prove that verification to anyone downstream, report usage, and honor revocations. Protected requests use a secret key in the `Authorization` header. The target contract defines test keys (`rk_test_…`) and live keys (`rk_live_…`) use the same base URL; the key decides the mode. A decision is never an error. `deny` and `escalate` are `200` responses that carry a decision. Errors use RFC 9457 problem details. contact: name: Reflections developer support url: https://docs.reflections.ai/production/support email: developers@reflections.ai servers: - url: https://app.reflections.ai/v1 description: >- Fictional test sandbox and conditional live support; availability and activation are separate security: - SecretKey: [] tags: - name: Account description: The account that owns the calling key. - name: Talent description: >- People whose name, likeness and voice are protected and licensed through Reflections. - name: Facets description: >- The parts of a talent's identity a license can cover, such as a voice or a likeness. - name: Resolutions description: Find which talent a prompt, image or voice sample invokes. - name: Licenses description: Signed licenses and their revisions. - name: License requests description: Ask a talent for a new license or a wider one. - name: Connections description: A licensee's permission for a platform to use its licenses. - name: Files description: References and outputs uploaded for checks and generations. - name: Checks description: Decide whether a use may proceed, before anything is generated. - name: Generations description: Check an output against the license its check relied on. - name: Sessions description: Authorize live voice and video with short-lived tokens and sampled checks. - name: Receipts description: Signed, portable proof of a decision. - name: Verifications description: Verify a file, manifest or receipt. - name: Revocations description: Every narrowing of consent, and the platform's acknowledgement of it. - name: Usage records description: Report usage for settlement and audit. - name: Statements description: Monthly amounts owed under a license, reconciled against observed usage. - name: Mandates description: A representative's authority to act for a talent, and its powers. - name: Escalations description: >- The review queue. Checks and held outputs waiting for the talent's side to decide. - name: License drafts description: Terms prepared for a talent's signature. Only a person signs. - name: Webhook endpoints description: Where Reflections sends events. - name: Events description: The record of everything that happened to your objects. - name: Test helpers description: Act as a talent or reviewer in test mode. - name: Discovery description: The public discovery document and signing keys. Neither needs a key. - name: OAuth description: > Authorization for connections, MCP clients and RSL clients, and the metadata that describes it. paths: /usage_records: get: tags: - Usage records summary: List usage records description: > **Planned contract — unavailable in test and live modes.** This operation is a protocol reference, not a callable endpoint. Start with the [working sandbox quickstart](/quickstart). Lists the usage records you reported. A representative whose mandate has `receive_statements` sees every usage record under the talent's licenses. Restricted keys need `usage:write` or `usage:read`. operationId: listUsageRecords parameters: - $ref: '#/components/parameters/ReflectionsVersion' - $ref: '#/components/parameters/ReflectionsAccount' - name: talent in: query description: Only records under this talent's licenses. schema: type: string pattern: ^tal_[0-9a-hjkmnp-tv-z]{26}$ - name: license in: query description: Only records that count against this license. schema: type: string pattern: ^lic_[0-9a-hjkmnp-tv-z]{26}$ - name: status in: query description: Only `accepted` or only `rejected` records. schema: type: string enum: - accepted - rejected - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Cursor' responses: '200': description: A page of usage records. headers: Request-Id: $ref: '#/components/headers/RequestId' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimitPolicy' content: application/json: schema: $ref: '#/components/schemas/UsageRecordList' examples: one_license: summary: Usage records for one license value: object: list data: - id: ur_8c0e2g4j6m8p0r2t4w6y8b0d2f object: usage_record livemode: true subject: gen_2q8v1m3n7p4r6s9t0wxyhk5zba units: seconds quantity: 3.4 occurred_at: '2026-10-17T18:06:03Z' status: rejected rejection: code: duplicate detail: >- ur_4y6a8c0e2g4j6m8p0r2t4w6y8b already reports this generation in seconds. license: lic_ba2q8v1m3n7p4r6s9t0wxyhk5z statement: null created_at: '2026-10-17T19:00:04Z' - id: ur_6a8c0e2g4j6m8p0r2t4w6y8b0d object: usage_record livemode: true subject: ses_q8v1m3n7p4r6s9t0wxyhk5zba2 units: seconds quantity: 412 occurred_at: '2026-10-17T18:07:00Z' status: accepted rejection: null license: lic_ba2q8v1m3n7p4r6s9t0wxyhk5z statement: stmt_3d5f7h9k1m3p5r7t9w1y3a5c7e created_at: '2026-10-17T19:00:04Z' - id: ur_4y6a8c0e2g4j6m8p0r2t4w6y8b object: usage_record livemode: true subject: gen_2q8v1m3n7p4r6s9t0wxyhk5zba units: seconds quantity: 3.4 occurred_at: '2026-10-17T18:06:03Z' status: accepted rejection: null license: lic_ba2q8v1m3n7p4r6s9t0wxyhk5z statement: stmt_3d5f7h9k1m3p5r7t9w1y3a5c7e created_at: '2026-10-17T18:06:30Z' has_more: false next_cursor: null '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/ServerError' '503': $ref: '#/components/responses/Unavailable' security: - SecretKey: - usage:write - SecretKey: - usage:read x-codeSamples: - lang: bash label: cURL source: > : "${REFLECTIONS_KEY:?Set REFLECTIONS_KEY before running this example}" curl --fail-with-body --max-time 30 'https://app.reflections.ai/v1/usage_records?limit=10' \ -H "Authorization: Bearer $REFLECTIONS_KEY" \ -H "Reflections-Version: 2026-10-15" - lang: typescript label: TypeScript source: > import { env, exit } from "node:process"; const apiKey = env.REFLECTIONS_KEY; if (!apiKey) throw new Error("Set REFLECTIONS_KEY before running this example"); const response = await fetch("https://app.reflections.ai/v1/usage_records?limit=10", { method: "GET", headers: { Authorization: `Bearer ${apiKey}`, "Reflections-Version": "2026-10-15", }, signal: AbortSignal.timeout(30_000), }); const responseBody = await response.text(); if (!response.ok) { console.error(`HTTP ${response.status}: ${responseBody}`); exit(1); } console.log(responseBody); - lang: python label: Python source: > import os from urllib.error import HTTPError from urllib.request import Request, urlopen apiKey = os.environ["REFLECTIONS_KEY"] if not apiKey: raise ValueError("Set REFLECTIONS_KEY before running this example") headers = { "Authorization": f"Bearer {apiKey}", "Reflections-Version": "2026-10-15", } request = Request("https://app.reflections.ai/v1/usage_records?limit=10", method="GET", headers=headers) try: with urlopen(request, timeout=30) as response: print(response.read().decode("utf-8")) except HTTPError as error: error_body = error.read().decode("utf-8") raise RuntimeError(f"HTTP {error.code}: {error_body}") from error - lang: go label: Go source: | package main import ( "fmt" "io" "net/http" "os" "time" ) func main() { apiKey := os.Getenv("REFLECTIONS_KEY") if apiKey == "" { panic("Set REFLECTIONS_KEY before running this example") } request, err := http.NewRequest("GET", "https://app.reflections.ai/v1/usage_records?limit=10", nil) if err != nil { panic(err) } request.Header.Set("Authorization", "Bearer " + apiKey) request.Header.Set("Reflections-Version", "2026-10-15") client := &http.Client{Timeout: 30 * time.Second} response, err := client.Do(request) if err != nil { panic(err) } defer response.Body.Close() responseBody, err := io.ReadAll(response.Body) if err != nil { panic(err) } if response.StatusCode < 200 || response.StatusCode >= 300 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, responseBody)) } fmt.Print(string(responseBody)) } components: parameters: ReflectionsVersion: name: Reflections-Version in: header required: false description: >- The dated API version. Defaults to the version your account is pinned to. schema: type: string example: '2026-10-15' ReflectionsAccount: name: Reflections-Account in: header required: false description: > Act for a connected licensee. The value is the licensee's account ID. Requires an active connection between that account and yours. schema: type: string pattern: ^acct_[0-9a-hjkmnp-tv-z]{26}$ Limit: name: limit in: query description: Number of objects to return, 1 to 100. schema: type: integer minimum: 1 maximum: 100 default: 20 Cursor: name: cursor in: query description: The `next_cursor` from the previous page. schema: type: string headers: RequestId: description: Identifies this request. Include it when you contact support. schema: type: string example: req_8f2k4m6p8r0t2v4x6z8b0d2f4h RateLimit: description: >- Remaining quota and seconds until it resets, as IETF RateLimit header fields. schema: type: string example: '"checks";r=184;t=1' RateLimitPolicy: description: The policy the RateLimit field reports against. schema: type: string example: '"checks";q=200;w=1' RetryAfter: description: Seconds to wait before retrying. schema: type: integer schemas: UsageRecordList: allOf: - $ref: '#/components/schemas/ListBase' - type: object properties: data: type: array items: $ref: '#/components/schemas/UsageRecord' description: > Usage records. Report usage returns them in the order you sent; List usage records returns them newest first. ListBase: type: object required: - object - has_more properties: object: type: string const: list description: Always `list`. has_more: type: boolean description: Whether another page exists. next_cursor: type: - string - 'null' description: Pass as `cursor` to read the next page. UsageRecord: allOf: - $ref: '#/components/schemas/UsageRecordCreate' - type: object required: - id - object - livemode - status - license - created_at properties: id: type: string pattern: ^ur_[0-9a-hjkmnp-tv-z]{26}$ description: >- The record's ID. Name it in `correction_of` to replace the record. object: type: string const: usage_record description: Always `usage_record`. livemode: type: boolean description: >- `true` in live mode, `false` for an object created with a test key. status: type: string enum: - accepted - rejected description: > `accepted`: counted in reconciliation. `rejected`: not counted; `rejection` says why. rejection: type: - object - 'null' description: Why the record was rejected. Null when `accepted`. properties: code: type: string enum: - unknown_subject - exceeds_observed - outside_scope - duplicate - period_closed description: > `unknown_subject`: no such generation or session under your licenses. `exceeds_observed`: more units than Reflections recorded. `outside_scope`: the placement is outside the license's channels or territories. `duplicate`: this subject, license and unit are already reported. `period_closed`: the statement for that period was already issued. detail: type: string description: What was wrong, in words. license: type: - string - 'null' pattern: ^lic_[0-9a-hjkmnp-tv-z]{26}$ description: > The license the record counts against, as you sent it or as Reflections found it. Null when no license was found for `subject`. statement: type: - string - 'null' pattern: ^stmt_[0-9a-hjkmnp-tv-z]{26}$ description: The statement the record counts in. Null when `rejected`. created_at: type: string format: date-time description: When Reflections received the record. Problem: type: object description: An RFC 9457 problem detail. Every error has this shape. required: - type - title - status - code - request_id properties: type: type: string format: uri description: A URL for this error, under `https://docs.reflections.ai/errors/`. title: type: string description: A short summary of the error. status: type: integer description: The HTTP status. detail: type: string description: What happened in this request. code: $ref: '#/components/schemas/ErrorCode' description: The stable error code. Branch on it, then on `status`. param: type: string description: The field at fault, as a path such as `use.territories[1]`. request_id: type: string description: > `req_…`, the same value as the `Request-Id` header. Include it when you contact support. doc_url: type: string format: uri description: A link to the documentation for this error. UsageRecordCreate: type: object required: - subject - units - quantity - occurred_at properties: subject: type: string pattern: ^(gen|ses)_[0-9a-hjkmnp-tv-z]{26}$ description: The generation or session this record settles. license: type: string pattern: ^lic_[0-9a-hjkmnp-tv-z]{26}$ description: >- The license the usage counts against. Required when the subject was decided under more than one license; send one record per license. units: $ref: '#/components/schemas/UsageUnits' description: > The unit `quantity` counts. Report the `units` the `usage_report` obligation names. quantity: type: number minimum: 0 description: How many `units`. May be fractional, such as `3.4` seconds. occurred_at: type: string format: date-time description: When the use happened. placement: type: object description: For `placements` and `impressions`. properties: channel: $ref: '#/components/schemas/Channel' description: Where the output was placed. territory: $ref: '#/components/schemas/Territory' description: The country where the output was placed or shown. url: type: string format: uri description: The placement's address, when it has one. correction_of: type: string pattern: ^ur_[0-9a-hjkmnp-tv-z]{26}$ description: The record this one replaces. metadata: $ref: '#/components/schemas/Metadata' description: Your own keys, such as your batch ID. Returned on the record. ErrorCode: type: string description: A stable error code. See the error code catalog. enum: - invalid_request - parameter_missing - parameter_invalid - unsupported_modality - unsupported_media_type - media_unreadable - version_unsupported - authorization_code_invalid - authentication_required - invalid_api_key - token_invalid - insufficient_scope - account_not_connected - mandate_required - livemode_mismatch - live_not_activated - platform_not_permitted - resource_not_found - idempotency_key_in_use - generation_already_submitted - authorization_consumed - check_not_allowed - check_expired - escalation_closed - license_draft_closed - invalid_state_transition - session_not_active - payload_too_large - idempotency_key_reused - artifact_digest_mismatch - rate_limited - internal_error - service_unavailable - evaluation_timeout UsageUnits: type: string enum: - outputs - seconds - characters - placements - impressions Channel: type: string description: Where the output will appear. enum: - social - web - in_app - streaming - tv - cinema - out_of_home - print - audio - email - retail - games - private Territory: type: string description: An ISO 3166-1 alpha-2 country code, or `WW` for worldwide. pattern: ^([A-Z]{2})$ example: US Metadata: type: object description: >- Up to 50 keys of your own, each up to 40 characters, values up to 500 characters. Never put personal data here. additionalProperties: type: string maxLength: 500 maxProperties: 50 responses: BadRequest: description: The request was malformed or a parameter was invalid. headers: Request-Id: $ref: '#/components/headers/RequestId' content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: type: https://docs.reflections.ai/errors/parameter_invalid title: A parameter is invalid status: 400 code: parameter_invalid param: use.territories[1] detail: '"UK" is not an ISO 3166-1 alpha-2 code. Use "GB".' request_id: req_8f2k4m6p8r0t2v4x6z8b0d2f4h Unauthorized: description: The key is missing, unknown or revoked. headers: Request-Id: $ref: '#/components/headers/RequestId' content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: type: https://docs.reflections.ai/errors/invalid_api_key title: The API key is not valid status: 401 code: invalid_api_key request_id: req_8f2k4m6p8r0t2v4x6z8b0d2f4h Forbidden: description: >- The key may not do this, the licensee is not connected, or live mode is not activated for this operation (`live_not_activated`). headers: Request-Id: $ref: '#/components/headers/RequestId' content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: type: https://docs.reflections.ai/errors/account_not_connected title: The licensee has not connected your platform status: 403 code: account_not_connected detail: >- acct_2q8v1m3n7p4r6s9t0wxyhk5zba has no active connection with your account. request_id: req_8f2k4m6p8r0t2v4x6z8b0d2f4h RateLimited: description: Too many requests. headers: Request-Id: $ref: '#/components/headers/RequestId' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: type: https://docs.reflections.ai/errors/rate_limited title: Too many requests status: 429 code: rate_limited request_id: req_8f2k4m6p8r0t2v4x6z8b0d2f4h ServerError: description: Something failed on our side. Retry with the same idempotency key. headers: Request-Id: $ref: '#/components/headers/RequestId' content: application/problem+json: schema: $ref: '#/components/schemas/Problem' Unavailable: description: > Reflections is temporarily unavailable. Do not generate a named talent without a valid authorization. Retry with the same idempotency key. headers: Request-Id: $ref: '#/components/headers/RequestId' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/problem+json: schema: $ref: '#/components/schemas/Problem' securitySchemes: SecretKey: type: http scheme: bearer description: > Your secret key, `rk_test_…` or `rk_live_…`, sent as `Authorization: Bearer `. Keep it on your server. Restricted keys carry only the scopes you give them. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.