> ## 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 generations > **Test mode available. Live mode available for one license.** Test keys use fictional sandbox data; see [Sandbox](/sandbox) for the supported forms and limits. A live key must send `license`, for a license it holds or issued as talent, and may not filter by `talent`, `check` or `status`. `release_status=awaiting_release` lists only the finals waiting for the talent's release. Releasing or declining a final through the API is planned, with the talent-side escalation queue; today she decides in the Talent Portal. Live results are `generation_summary` objects for the outputs submitted through the API under that license: their state, decision, receipt ID and release status, with no prompt, reference, bytes, execution or metadata. The public receipt a summary names shows its `request_digest` and `artifact_sha256`. `status` is the recorded state: a decision the licensee has not yet read stays `checking` until it is sealed. Retrieve a generation by ID, as its licensee, for the full object. A summary outlives that detail: after the 24-hour private window the retrieve returns `404`, and the summary stays listed. A license nobody has accepted lists no outputs. Lists your generations. A representative whose mandate has `review_outputs` or `receive_statements` sees every generation under the talent's licenses, for audit. Restricted keys need `generations:write` or `generations:read`. ## OpenAPI ````yaml /api-reference/openapi.yaml get /generations 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: /generations: get: tags: - Generations summary: List generations description: > **Test mode available. Live mode available for one license.** Test keys use fictional sandbox data; see [Sandbox](/sandbox) for the supported forms and limits. A live key must send `license`, for a license it holds or issued as talent, and may not filter by `talent`, `check` or `status`. `release_status=awaiting_release` lists only the finals waiting for the talent's release. Releasing or declining a final through the API is planned, with the talent-side escalation queue; today she decides in the Talent Portal. Live results are `generation_summary` objects for the outputs submitted through the API under that license: their state, decision, receipt ID and release status, with no prompt, reference, bytes, execution or metadata. The public receipt a summary names shows its `request_digest` and `artifact_sha256`. `status` is the recorded state: a decision the licensee has not yet read stays `checking` until it is sealed. Retrieve a generation by ID, as its licensee, for the full object. A summary outlives that detail: after the 24-hour private window the retrieve returns `404`, and the summary stays listed. A license nobody has accepted lists no outputs. Lists your generations. A representative whose mandate has `review_outputs` or `receive_statements` sees every generation under the talent's licenses, for audit. Restricted keys need `generations:write` or `generations:read`. operationId: listGenerations parameters: - $ref: '#/components/parameters/ReflectionsVersion' - $ref: '#/components/parameters/ReflectionsAccount' - name: talent in: query description: Only generations checked for this talent. schema: type: string pattern: ^tal_[0-9a-hjkmnp-tv-z]{26}$ - name: license in: query description: Only generations made under this license. Required in live mode. schema: type: string pattern: ^lic_[0-9a-hjkmnp-tv-z]{26}$ - name: check in: query description: Only generations made under this check. schema: type: string pattern: ^chk_[0-9a-hjkmnp-tv-z]{26}$ - name: status in: query description: Only generations with this status, such as `held`. schema: $ref: '#/components/schemas/GenerationStatus' - name: release_status in: query description: > Live mode only, with `license`: `awaiting_release` lists only the finals waiting for the talent to release or decline them. Test mode filters with `status=held` instead. schema: type: string enum: - awaiting_release - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Cursor' responses: '200': description: A page of generations. 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/GenerationList' examples: live_license: summary: 'Live: outputs under a license the talent issued' value: object: list data: - id: gen_27anw6frbr27snr28r4rtby65t object: generation_summary livemode: true license: lic_k5zba2q8v1m3n7p4r6s9t0wxyh status: held decision: escalate receipt: null release_status: awaiting_release created_at: '2026-10-17T18:04:10Z' decided_at: null - id: gen_t6v8w0x2y4z6a8b0c2d4e6f8g0 object: generation_summary livemode: true license: lic_k5zba2q8v1m3n7p4r6s9t0wxyh status: released decision: allow receipt: rcpt_w0x2y4z6a8b0c2d4e6f8g0h2j4 release_status: released created_at: '2026-10-17T18:02:40Z' decided_at: '2026-10-17T19:12:05Z' has_more: false next_cursor: null by_check: summary: Outputs submitted under one check value: object: list data: - id: gen_t6v8w0x2y4z6a8b0c2d4e6f8g0 object: generation livemode: true check: chk_3m7p4r6s9t0wxyhk5zba2q8v1n session: null candidate_index: 1 status: denied decision: deny artifact: file: file_3t5v7x9z1b3d5f7h9k1m3p5r7s sha256: >- 4c6e8a0b2d4f6a8c0e2b4d6f8a0c2e4b6d8f0a2c4e6b8d0f2a4c6e8b0d2f4a6c media_type: image/png duration_ms: null execution: provider: example-image-provider model: image-model-3 job_id: job_88214 findings: - term: >- license:lic_k5zba2q8v1m3n7p4r6s9t0wxyh/terms.requiredAttributes attribute: identity.samePerson result: preserved - term: >- license:lic_k5zba2q8v1m3n7p4r6s9t0wxyh/terms.neverExtras rule: Do not show alcohol or tobacco. result: violated detail: A wine glass on the café table. unchecked_terms: [] reasons: - code: prohibited_custom_term stage: generation talent: tal_9t0wxyhk5zba2q8v1m3n7p4r6s term: >- license:lic_k5zba2q8v1m3n7p4r6s9t0wxyh/terms.neverExtras sentence: Do not show alcohol or tobacco. obligations: [] escalation: null assurance: observed receipt: rcpt_w0x2y4z6a8b0c2d4e6f8g0h2j4 c2pa: null watermark: null metadata: {} created_at: '2026-10-17T18:08:40Z' decided_at: '2026-10-17T18:08:41Z' - id: gen_27anw6frbr27snr28r4rtby65t object: generation livemode: true check: chk_3m7p4r6s9t0wxyhk5zba2q8v1n session: null candidate_index: 3 status: held decision: escalate artifact: file: file_qd3fjw5kzmxmsej34ccjbb3te2 sha256: >- 1f515e0ac5910efaf0ed6a4477f38775ad9dcc6ccb5070f421a0fe85d49867d7 media_type: image/png duration_ms: null execution: provider: example-image-provider model: image-model-3 job_id: job_88216 findings: - term: >- license:lic_k5zba2q8v1m3n7p4r6s9t0wxyh/terms.requiredAttributes attribute: identity.samePerson result: preserved - term: >- license:lic_k5zba2q8v1m3n7p4r6s9t0wxyh/terms.adjustments attribute: appearance.wardrobe result: preserved - term: >- license:lic_k5zba2q8v1m3n7p4r6s9t0wxyh/terms.neverExtras rule: Do not show alcohol or tobacco. result: preserved unchecked_terms: [] reasons: [] obligations: - type: hold_until_release reviewer: talent - type: draft_watermark escalation: id: esc_fxr2jmbkavw2sqhgjp78qw9nt7 reason: release_review reviewer: talent status: open expires_at: '2026-10-24T18:04:10Z' resolved_at: null note: null assurance: observed receipt: null c2pa: null watermark: null metadata: {} created_at: '2026-10-17T18:04:10Z' decided_at: null - id: gen_0syye78tm8qdvre87y0wnvmfcs object: generation livemode: true check: chk_3m7p4r6s9t0wxyhk5zba2q8v1n session: null candidate_index: 2 status: held decision: escalate artifact: file: file_cf9vex7e3amaf4ph46kks9mp4w sha256: >- a75e83bb3668a35e7ecf2c2ad75f65999ac134519348cc4d2981030353c0930b media_type: image/png duration_ms: null execution: provider: example-image-provider model: image-model-3 job_id: job_88215 findings: - term: >- license:lic_k5zba2q8v1m3n7p4r6s9t0wxyh/terms.requiredAttributes attribute: identity.samePerson result: preserved - term: >- license:lic_k5zba2q8v1m3n7p4r6s9t0wxyh/terms.adjustments attribute: appearance.wardrobe result: preserved - term: >- license:lic_k5zba2q8v1m3n7p4r6s9t0wxyh/terms.neverExtras rule: Do not show alcohol or tobacco. result: preserved unchecked_terms: [] reasons: [] obligations: - type: hold_until_release reviewer: talent - type: draft_watermark escalation: id: esc_f5zx603y7xn526k4asxrdtasxj reason: release_review reviewer: talent status: open expires_at: '2026-10-24T18:03:05Z' resolved_at: null note: null assurance: observed receipt: null c2pa: null watermark: null metadata: {} created_at: '2026-10-17T18:03:05Z' decided_at: null has_more: true next_cursor: Z2VuXzBzeXllNzh0bThxZHZyZTg3eTB3bnZtZmNz '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: - generations:write - SecretKey: - generations: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/generations?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/generations?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/generations?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/generations?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 schemas: GenerationStatus: type: string description: > `checking`: not decided yet. `allowed`: deliver. `denied`: never deliver. `held`: waiting for release. `released`: a reviewer released it; deliver. `expired`: never reviewed. `withdrawn`: you withdrew it. enum: - checking - allowed - denied - held - released - expired - withdrawn GenerationList: allOf: - $ref: '#/components/schemas/ListBase' - type: object properties: data: type: array items: oneOf: - $ref: '#/components/schemas/Generation' - $ref: '#/components/schemas/GenerationSummary' description: > The generations on this page, newest first: `generation` objects in test mode, `generation_summary` objects in live mode. 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. Generation: type: object required: - id - object - livemode - status - assurance - created_at properties: id: type: string pattern: ^gen_[0-9a-hjkmnp-tv-z]{26}$ description: The generation's ID, `gen_` followed by 26 characters. object: type: string const: generation description: Always `generation`. livemode: type: boolean description: '`true` in live mode, `false` in test mode.' check: type: - string - 'null' pattern: ^chk_[0-9a-hjkmnp-tv-z]{26}$ description: >- The check the output was made under. Null for an output made in a session. session: type: - string - 'null' pattern: ^ses_[0-9a-hjkmnp-tv-z]{26}$ description: >- The session the output was made in. Null for an output made under a check. candidate_index: type: - integer - 'null' description: > Which of the check's candidates this is, from 0. Null under `reuse` and for an output made in a session. status: $ref: '#/components/schemas/GenerationStatus' description: Where the output is. Deliver only on `allowed` or `released`. decision: description: > `allow`, `deny`, or `escalate` while a reviewer must release the output. Null while `status` is `checking`. oneOf: - $ref: '#/components/schemas/Decision' - type: 'null' artifact: type: - object - 'null' description: The output that was checked. properties: file: type: - string - 'null' description: > The file the output was uploaded as. Null when it was sent as `url` or `data`. sha256: $ref: '#/components/schemas/Sha256Hex' description: > The SHA-256 of the checked bytes. The receipt carries it as `artifact_sha256`. media_type: type: string description: The output's media type, such as `image/png`. duration_ms: type: - integer - 'null' description: Length in milliseconds, for audio and video. Null otherwise. execution: $ref: '#/components/schemas/Execution' description: The run that made the output, as you stated it. findings: type: array items: $ref: '#/components/schemas/Finding' description: Each rule checked on the bytes, with its result. unchecked_terms: type: array items: $ref: '#/components/schemas/Address' description: > Addresses of rules the talent wrote that could not be checked on these bytes. They do not withhold the output. reasons: type: array items: $ref: '#/components/schemas/Reason' description: Why the output was denied or expired. Empty otherwise. obligations: type: array items: $ref: '#/components/schemas/Obligation' description: > What you must do with this output, such as embed `c2pa` and show the disclosure, or keep it private while `held`. escalation: description: >- The release review, when a person must release the output. Null otherwise. oneOf: - $ref: '#/components/schemas/Escalation' - type: 'null' assurance: type: string enum: - observed - attested description: >- `observed`: Reflections checked these bytes. `attested`: Reflections recorded what you stated without checking it. receipt: type: - string - 'null' pattern: ^rcpt_[0-9a-hjkmnp-tv-z]{26}$ description: > The receipt that records the decision. Null while the output is `checking` or `held`, and after a withdrawal from review. c2pa: description: > The assertion to embed in the output's C2PA manifest before you deliver it. Null unless `decision` is `allow`. oneOf: - $ref: '#/components/schemas/C2paAssertion' - type: 'null' watermark: type: - object - 'null' description: The watermark you registered on the generation. Null if none. properties: algorithm: type: string description: The watermarking method you used. id: type: string description: The watermark's identifier, as embedded in the output. metadata: $ref: '#/components/schemas/Metadata' description: Your metadata from the request. created_at: type: string format: date-time description: When the output was submitted. decided_at: type: - string - 'null' format: date-time description: >- When the output was allowed, released, denied or expired. Null otherwise. GenerationSummary: type: object description: > The recorded state of one output submitted through the API, as its licensee and the issuing talent may both read it. It carries no prompt, reference, bytes, execution or metadata. Its `receipt` names a public receipt, which shows the request and artifact digests. required: - id - object - livemode - license - status - decision - receipt - release_status - created_at - decided_at properties: id: type: string pattern: ^gen_[0-9a-hjkmnp-tv-z]{26}$ description: The generation's ID. object: type: string const: generation_summary description: Always `generation_summary`. livemode: type: boolean description: Always `true`. license: type: string pattern: ^lic_[0-9a-hjkmnp-tv-z]{26}$ description: The license the output was made under. status: $ref: '#/components/schemas/GenerationStatus' description: > `checking` until a decision is recorded, `held` while the talent reviews it, then `released`, `denied` or `expired`. decision: description: > `allow`, `deny`, or `escalate` while held. Null while `status` is `checking`. oneOf: - $ref: '#/components/schemas/Decision' - type: 'null' receipt: type: - string - 'null' pattern: ^rcpt_[0-9a-hjkmnp-tv-z]{26}$ description: The receipt, once the decision is sealed. Anyone may read it. release_status: type: - string - 'null' enum: - awaiting_release - released - declined - expired - withdrawn - null description: > The talent's release review: `awaiting_release` while the final waits for her to release or decline it, then `released`, `declined`, `expired` when nobody released it in time, or `withdrawn` when the license or account authority changed. Null when the output never reached review. created_at: type: string format: date-time description: When the output was submitted. decided_at: type: - string - 'null' format: date-time description: When it was decided, or null. 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. Decision: type: string description: > `allow`: proceed and meet the obligations. `deny`: do not proceed. `escalate`: wait; a person with authority will decide, and an unanswered escalation becomes `deny`. enum: - allow - deny - escalate Sha256Hex: type: string description: A SHA-256 digest of bytes, as 64 lowercase hex characters. pattern: ^[0-9a-f]{64}$ Execution: type: object description: > Which model will run, or ran, the request. Reflections records it as stated by the platform (`assurance: attested`). properties: provider: type: string maxLength: 100 description: The model provider. model: type: string maxLength: 100 description: The model's name at the provider. candidates: type: integer minimum: 1 maximum: 16 description: Outputs this request will produce. job_id: type: string maxLength: 200 description: The provider's ID for the job. Finding: type: object required: - term - result properties: term: $ref: '#/components/schemas/Address' description: The term's address, such as `license:lic_…/terms.neverExtras`. attribute: type: string description: A protected attribute, such as `identity.samePerson`. rule: type: string description: A rule the talent wrote, as written. result: type: string enum: - preserved - violated - unchecked description: >- `unchecked`: the check could not read this rule. Talent-written rules that are unchecked are delivered and recorded; protected attributes never are. detail: type: string description: What the check saw, for a `violated` result. Address: type: string description: > Where a reason or finding rests, written as an address: `license:/terms.` for a term, `talent:` for a talent's standing boundary. example: license:lic_k5zba2q8v1m3n7p4r6s9t0wxyh/terms.channels Reason: type: object required: - code - stage - sentence properties: code: $ref: '#/components/schemas/ReasonCode' description: A stable reason code. Branch on it. stage: type: string enum: - check - generation - session description: 'Where it was decided: `check`, `generation` or `session`.' talent: type: string pattern: ^tal_[0-9a-hjkmnp-tv-z]{26}$ description: The talent the reason concerns. term: $ref: '#/components/schemas/Address' description: >- The license term or standing rule the reason rests on, as an address. sentence: type: string description: >- The reason in the license's own words. Show it to your user as written. Obligation: type: object description: >- Something you must do to proceed. Each type uses only the fields listed for it. required: - type properties: type: $ref: '#/components/schemas/ObligationType' description: > The kind of obligation. Treat a type you do not know as unmet: do not generate or deliver. required: type: string enum: - all - sampled description: >- `generation_check`: submit every output, or the sampled share in `sample_rate`. sample_rate: type: number minimum: 0 maximum: 1 description: > `generation_check` with `required: sampled`: the share of outputs to submit, from 0 to 1, chosen at random. reviewer: type: string enum: - talent - representative - reflections description: '`hold_until_release`: who releases each output.' instructions: type: array items: type: string description: '`generation_instructions`: include these in what the model receives.' level: type: string enum: - licensed - brand - scope description: >- `disclosure`: `licensed` says the person's likeness is licensed; `brand` adds who licensed it; `scope` adds the use. text: type: string description: '`disclosure` and `attribution`: the words to show.' placement: type: string enum: - visible - metadata - both description: '`disclosure`: where the label goes.' material: type: string enum: - references - voice - outputs description: '`delete_material` and `no_training`: what the obligation covers.' within: allOf: - $ref: '#/components/schemas/Duration' description: >- The deadline. `delete_material`: counted from the decision. `usage_report`: from the generation's decision or the session's end. units: type: string enum: - outputs - seconds - characters - placements - impressions description: '`usage_report`: the unit to report.' term: $ref: '#/components/schemas/Address' description: The address of the license term the obligation comes from. Escalation: type: object required: - id - reason - reviewer - status - expires_at properties: id: type: string pattern: ^esc_[0-9a-hjkmnp-tv-z]{26}$ description: The escalation's ID, `esc_` followed by 26 characters. reason: type: string enum: - judgment - unverifiable - evaluation_unavailable - release_review description: > `judgment`: a rule needs a person to read it. `unverifiable`: a protected attribute could not be confirmed. `evaluation_unavailable`: the check could not finish. `release_review`: every output under this license is released by a person. reviewer: type: string enum: - talent - representative - reflections description: > `talent`: the talent, or a representative whose mandate has `review_outputs`. `representative`: only the talent's representatives. `reflections`: Reflections trust and safety, under a platform license. status: type: string enum: - open - allowed - denied - expired - cancelled description: > `open` until it closes: `allowed` or `denied` by the reviewer, `expired` at `expires_at`, or `cancelled` when you cancel the check, withdraw the output, or another talent's escalation decides the check. expires_at: type: string format: date-time description: > When an unanswered escalation becomes `deny`: 7 days after it opens, or the license's shorter `escalation_window`. resolved_at: type: - string - 'null' format: date-time description: >- When the escalation was decided, expired or cancelled. Null while `open`. note: type: - string - 'null' maxLength: 500 description: The reviewer's note, if they wrote one. C2paAssertion: type: object description: Add this assertion to the output's C2PA manifest, under `label`. required: - label - data properties: label: type: string const: ai.reflections.license description: Always `ai.reflections.license`. Use it as the assertion's label. data: type: object description: >- The assertion's data, copied unchanged: the receipt JWS and its public page. required: - receipt - verify_url properties: receipt: type: string description: The receipt JWS. verify_url: type: string format: uri description: >- The receipt's public page, `https://app.reflections.ai/r/{receipt_id}`. 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 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 ReasonCode: type: string description: >- Why a use was denied or escalated, or a session terminated. See the reason code catalog. enum: - no_license - license_pending_acceptance - license_revoked - license_suspended - window_not_started - window_ended - terms_unreadable - account_not_licensee - material_unavailable - adjustment_not_licensed - facet_not_licensed - kind_not_licensed - modality_not_licensed - purpose_not_licensed - channel_not_licensed - territory_not_licensed - commercial_use_not_licensed - platform_not_licensed - delivery_limit_reached - monthly_limit_reached - talent_prohibits - prohibited_appearance_change - prohibited_endorsement - prohibited_custom_term - identity_not_preserved - prohibited_speech - prohibited_motion - narration_mismatch - voice_rule - unsupported_rule - attribute_unverifiable - output_unverifiable - ambiguous_talent - review_required - unverifiable_request - evaluation_unavailable - authority_changed - provenance_failed - hold_expired - review_declined - review_expired - session_not_permitted - renewal_missed - sample_missed ObligationType: type: string description: > `generation_check`: submit outputs before delivery. `hold_until_release`: deliver nothing until the reviewer releases it. `draft_watermark`: mark drafts shown while held. `generation_instructions`: pass the instructions to the model. `disclosure`, `attribution`: label the output as stated. `c2pa_manifest`: embed the `c2pa` assertion. `no_training`: never train on the material. `delete_material`: delete it within `within`. `usage_report`: report usage within `within`. enum: - generation_check - hold_until_release - draft_watermark - generation_instructions - disclosure - attribution - c2pa_manifest - no_training - delete_material - usage_report Duration: type: string description: An ISO 8601 duration, such as `PT60S` or `P30D`. example: P30D 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 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.