> ## 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. # Upload a file > **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). Uploads a reference, voice sample or output. Send the bytes as `multipart/form-data` for files up to 100 MB. For larger files, send JSON with the size and `sha256` and upload the bytes to the returned `upload_url`. A file is usable when its `status` is `ready`. Files expire after 24 hours unless a held generation needs them longer. Restricted keys need `files:write`. ## OpenAPI ````yaml /api-reference/openapi.yaml post /files 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: /files: post: tags: - Files summary: Upload a file 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). Uploads a reference, voice sample or output. Send the bytes as `multipart/form-data` for files up to 100 MB. For larger files, send JSON with the size and `sha256` and upload the bytes to the returned `upload_url`. A file is usable when its `status` is `ready`. Files expire after 24 hours unless a held generation needs them longer. Restricted keys need `files:write`. operationId: createFile parameters: - $ref: '#/components/parameters/ReflectionsVersion' - $ref: '#/components/parameters/ReflectionsAccount' - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: multipart/form-data: schema: type: object required: - file - purpose properties: file: type: string format: binary description: The bytes. purpose: $ref: '#/components/schemas/FilePurpose' application/json: schema: $ref: '#/components/schemas/FileCreate' examples: large_output: summary: A video output over 100 MB value: purpose: output size: 241587113 sha256: >- 2d792ec6ff98b0311e835c38449522860bc81bcf2c6919f6d60dcf7e20a55373 media_type: video/mp4 filename: ridge-trail.mp4 responses: '200': description: The file. 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/File' examples: uploading: summary: Created with JSON, waiting for its bytes value: id: file_y04rz07dh5k83ff2g4n1wtvgy7 object: file livemode: true purpose: output status: uploading sha256: >- 2d792ec6ff98b0311e835c38449522860bc81bcf2c6919f6d60dcf7e20a55373 media_type: video/mp4 size: 241587113 width: null height: null duration_ms: null upload_url: >- https://uploads.reflections.ai/file_y04rz07dh5k83ff2g4n1wtvgy7?expires=1792266127&signature=d33ef9140593995ffc3d0602234e8d46d86678cc63b expires_at: '2026-10-18T18:42:07Z' created_at: '2026-10-17T18:42:07Z' ready: summary: Uploaded as multipart, ready to use value: id: file_7h3k9m2p4q6r8s1t3v5w7x9yza object: file livemode: true purpose: reference status: ready sha256: >- 7c1e3a5b9d2f4e6a8c0b2d4f6e8a0c2e4b6d8f0a2c4e6b8d0f2a4c6e8b0d2f4a media_type: image/png size: 3284117 width: 1024 height: 1536 duration_ms: null upload_url: null expires_at: '2026-10-18T17:58:41Z' created_at: '2026-10-17T17:58:41Z' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '409': $ref: '#/components/responses/Conflict' '413': $ref: '#/components/responses/PayloadTooLarge' '422': $ref: '#/components/responses/Unprocessable' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/ServerError' '503': $ref: '#/components/responses/Unavailable' security: - SecretKey: - files:write x-codeSamples: - lang: bash label: cURL source: > # Set a unique key once per new action; persist it and reuse it for every retry. : "${REFLECTIONS_KEY:?Set REFLECTIONS_KEY before running this example}" : "${REFLECTIONS_CREATE_FILE_IDEMPOTENCY_KEY:?Set REFLECTIONS_CREATE_FILE_IDEMPOTENCY_KEY before running this example}" curl --fail-with-body --max-time 30 -X POST 'https://app.reflections.ai/v1/files' \ -H "Authorization: Bearer $REFLECTIONS_KEY" \ -H "Reflections-Version: 2026-10-15" \ -H "Idempotency-Key: $REFLECTIONS_CREATE_FILE_IDEMPOTENCY_KEY" \ -H "Content-Type: application/json" \ --data-raw '{ "purpose": "output", "size": 241587113, "sha256": "2d792ec6ff98b0311e835c38449522860bc81bcf2c6919f6d60dcf7e20a55373", "media_type": "video/mp4", "filename": "ridge-trail.mp4" }' - lang: typescript label: TypeScript source: > import { env, exit } from "node:process"; // Set a unique key once per new action; persist it and reuse it for every retry. const apiKey = env.REFLECTIONS_KEY; if (!apiKey) throw new Error("Set REFLECTIONS_KEY before running this example"); const idempotencyKey = env.REFLECTIONS_CREATE_FILE_IDEMPOTENCY_KEY; if (!idempotencyKey) throw new Error("Set REFLECTIONS_CREATE_FILE_IDEMPOTENCY_KEY before running this example"); const response = await fetch("https://app.reflections.ai/v1/files", { method: "POST", headers: { Authorization: `Bearer ${apiKey}`, "Reflections-Version": "2026-10-15", "Idempotency-Key": idempotencyKey, "Content-Type": "application/json", }, body: JSON.stringify({ "purpose": "output", "size": 241587113, "sha256": "2d792ec6ff98b0311e835c38449522860bc81bcf2c6919f6d60dcf7e20a55373", "media_type": "video/mp4", "filename": "ridge-trail.mp4" }), 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 json import os from urllib.error import HTTPError from urllib.request import Request, urlopen # Set a unique key once per new action; persist it and reuse it for every retry. apiKey = os.environ["REFLECTIONS_KEY"] if not apiKey: raise ValueError("Set REFLECTIONS_KEY before running this example") idempotencyKey = os.environ["REFLECTIONS_CREATE_FILE_IDEMPOTENCY_KEY"] if not idempotencyKey: raise ValueError("Set REFLECTIONS_CREATE_FILE_IDEMPOTENCY_KEY before running this example") headers = { "Authorization": f"Bearer {apiKey}", "Reflections-Version": "2026-10-15", "Idempotency-Key": idempotencyKey, "Content-Type": "application/json", } data = json.dumps({ "purpose": "output", "size": 241587113, "sha256": "2d792ec6ff98b0311e835c38449522860bc81bcf2c6919f6d60dcf7e20a55373", "media_type": "video/mp4", "filename": "ridge-trail.mp4", }).encode("utf-8") request = Request("https://app.reflections.ai/v1/files", method="POST", headers=headers, data=data) 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" "strings" "time" ) func main() { // Set a unique key once per new action; persist it and reuse it for every retry. apiKey := os.Getenv("REFLECTIONS_KEY") if apiKey == "" { panic("Set REFLECTIONS_KEY before running this example") } idempotencyKey := os.Getenv("REFLECTIONS_CREATE_FILE_IDEMPOTENCY_KEY") if idempotencyKey == "" { panic("Set REFLECTIONS_CREATE_FILE_IDEMPOTENCY_KEY before running this example") } body := strings.NewReader(`{ "purpose": "output", "size": 241587113, "sha256": "2d792ec6ff98b0311e835c38449522860bc81bcf2c6919f6d60dcf7e20a55373", "media_type": "video/mp4", "filename": "ridge-trail.mp4" }`) request, err := http.NewRequest("POST", "https://app.reflections.ai/v1/files", body) if err != nil { panic(err) } request.Header.Set("Authorization", "Bearer " + apiKey) request.Header.Set("Reflections-Version", "2026-10-15") request.Header.Set("Idempotency-Key", idempotencyKey) request.Header.Set("Content-Type", "application/json") 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}$ IdempotencyKey: name: Idempotency-Key in: header required: false description: > A unique key for this operation, up to 255 characters. In test mode, POST keys are scoped to your account and mode and bind the endpoint and body for 24 hours. A different endpoint or body with the same key is refused. Initial live check and generation creation require a nonempty key. Each operation has a separate account-scoped namespace; retain the same API key, body and idempotency key for retries within 24 hours of creation. A pending check returns `202` with `status: "checking"`. Completed checks replay their sealed response; successful generation POSTs replay the original accepted `202`, so use GET for current state. Live verification is a read-only query that returns a fresh verification ID on each call, without exact response caching. The broader delegated-account contract also scopes keys to `Reflections-Account`; delegated requests and the other planned live POST operations remain unsupported. schema: type: string maxLength: 255 schemas: FilePurpose: type: string description: >- `reference` and `voice_sample`: media a model receives. `mask`: an edit mask. `output`: something a model made, to submit as a generation. enum: - reference - voice_sample - mask - output FileCreate: type: object description: >- Create a file and upload its bytes to `upload_url`. For files over 100 MB, up to 5 GB. required: - purpose - size - sha256 - media_type properties: purpose: $ref: '#/components/schemas/FilePurpose' description: >- What the file is for: media a model receives, or an output to submit. size: type: integer minimum: 1 maximum: 5368709120 description: Size in bytes, up to 5 GB. sha256: $ref: '#/components/schemas/Sha256Hex' description: > SHA-256 of the bytes you will upload, in hex. Bytes that do not match are refused with `artifact_digest_mismatch`. media_type: type: string description: The file's MIME type, such as `video/mp4`. filename: type: string maxLength: 255 description: Your name for the file, such as `ridge-trail.mp4`. File: type: object required: - id - object - livemode - purpose - status - sha256 - media_type - size - expires_at - created_at properties: id: type: string pattern: ^file_[0-9a-hjkmnp-tv-z]{26}$ description: > Unique identifier, prefixed `file_`. Send it as an input's `file` or an artifact's `file`. object: type: string const: file description: Always `file`. livemode: type: boolean description: '`true` in live mode, `false` in test mode.' purpose: $ref: '#/components/schemas/FilePurpose' description: >- What the file is for: media a model receives, or an output to submit. status: type: string enum: - uploading - ready - expired description: > `uploading`: waiting for the bytes at `upload_url`. `ready`: usable in checks and generations. `expired`: deleted; upload it again. sha256: $ref: '#/components/schemas/Sha256Hex' description: SHA-256 of the file's bytes, in hex. media_type: type: string description: The file's MIME type. size: type: integer description: Size in bytes. width: type: - integer - 'null' description: > Width in pixels, for images and video. `null` for other files, and until the bytes arrive. height: type: - integer - 'null' description: > Height in pixels, for images and video. `null` for other files, and until the bytes arrive. duration_ms: type: - integer - 'null' description: > Length in milliseconds, for audio and video. `null` for other files, and until the bytes arrive. upload_url: type: - string - 'null' format: uri description: '`PUT` the bytes here. Present while `uploading`; expires in 1 hour.' expires_at: type: string format: date-time description: > When the file is deleted: 24 hours after it was created, or later while a held generation needs it. created_at: type: string format: date-time description: When the file was created. Sha256Hex: type: string description: A SHA-256 digest of bytes, as 64 lowercase hex characters. pattern: ^[0-9a-f]{64}$ 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. 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 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 Conflict: description: >- The request conflicts with the object's state or with a request still running. headers: Request-Id: $ref: '#/components/headers/RequestId' content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: type: https://docs.reflections.ai/errors/idempotency_key_in_use title: A request with this key is still running status: 409 code: idempotency_key_in_use detail: Retry with the same key after a short wait. request_id: req_8f2k4m6p8r0t2v4x6z8b0d2f4h PayloadTooLarge: description: >- The request exceeds its byte limit. Sandbox inline media is at most 7 MiB decoded and the generation JSON body at most 10 MiB. Multipart uploads are planned. headers: Request-Id: $ref: '#/components/headers/RequestId' content: application/problem+json: schema: $ref: '#/components/schemas/Problem' Unprocessable: description: The request is well formed but cannot be applied. headers: Request-Id: $ref: '#/components/headers/RequestId' content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: type: https://docs.reflections.ai/errors/idempotency_key_reused title: This key was used for a different request status: 422 code: idempotency_key_reused 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.