> ## 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. # Create a session > **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). Starts a live voice or video session. Reflections runs a check on the session's inputs and, if it allows, returns a session token that expires in 5 minutes. Renew it every `renew_every`, submit samples at the `sampling` rate, and stay connected to `stream_url` to receive `session.terminated`. Sessions never escalate: anything that would escalate is `deny`. A license that holds every output for release cannot start a session (`session_not_permitted`). Restricted keys need `sessions:write`. ## OpenAPI ````yaml /api-reference/openapi.yaml post /sessions 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: /sessions: post: tags: - Sessions summary: Create a session 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). Starts a live voice or video session. Reflections runs a check on the session's inputs and, if it allows, returns a session token that expires in 5 minutes. Renew it every `renew_every`, submit samples at the `sampling` rate, and stay connected to `stream_url` to receive `session.terminated`. Sessions never escalate: anything that would escalate is `deny`. A license that holds every output for release cannot start a session (`session_not_permitted`). Restricted keys need `sessions:write`. operationId: createSession parameters: - $ref: '#/components/parameters/ReflectionsVersion' - $ref: '#/components/parameters/ReflectionsAccount' - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SessionCreate' examples: fan_voice_chat: summary: A live fan voice chat value: talent: - tal_9t0wxyhk5zba2q8v1m3n7p4r6s facet: fct_v1m3n7p4r6s9t0wxyhk5zba2q8 use: modality: speech kind: impersonation purpose: personal commercial: false channels: - in_app territories: - US inputs: - role: system text: >- You are a fan voice chat. Speak as Maya Okafor in a friendly tone. end_user: id: usr_48213 execution: provider: example-voice-provider model: realtime-voice-2 responses: '200': description: >- The session. If `status` is `denied`, the check's reasons explain why and no token is issued. 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/Session' examples: active: $ref: '#/components/examples/SessionActive' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '409': $ref: '#/components/responses/Conflict' '422': $ref: '#/components/responses/Unprocessable' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/ServerError' '503': $ref: '#/components/responses/Unavailable' security: - SecretKey: - sessions: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_SESSION_IDEMPOTENCY_KEY:?Set REFLECTIONS_CREATE_SESSION_IDEMPOTENCY_KEY before running this example}" curl --fail-with-body --max-time 30 -X POST 'https://app.reflections.ai/v1/sessions' \ -H "Authorization: Bearer $REFLECTIONS_KEY" \ -H "Reflections-Version: 2026-10-15" \ -H "Idempotency-Key: $REFLECTIONS_CREATE_SESSION_IDEMPOTENCY_KEY" \ -H "Content-Type: application/json" \ --data-raw '{ "talent": [ "tal_9t0wxyhk5zba2q8v1m3n7p4r6s" ], "facet": "fct_v1m3n7p4r6s9t0wxyhk5zba2q8", "use": { "modality": "speech", "kind": "impersonation", "purpose": "personal", "commercial": false, "channels": [ "in_app" ], "territories": [ "US" ] }, "inputs": [ { "role": "system", "text": "You are a fan voice chat. Speak as Maya Okafor in a friendly tone." } ], "end_user": { "id": "usr_48213" }, "execution": { "provider": "example-voice-provider", "model": "realtime-voice-2" } }' - 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_SESSION_IDEMPOTENCY_KEY; if (!idempotencyKey) throw new Error("Set REFLECTIONS_CREATE_SESSION_IDEMPOTENCY_KEY before running this example"); const response = await fetch("https://app.reflections.ai/v1/sessions", { method: "POST", headers: { Authorization: `Bearer ${apiKey}`, "Reflections-Version": "2026-10-15", "Idempotency-Key": idempotencyKey, "Content-Type": "application/json", }, body: JSON.stringify({ "talent": [ "tal_9t0wxyhk5zba2q8v1m3n7p4r6s" ], "facet": "fct_v1m3n7p4r6s9t0wxyhk5zba2q8", "use": { "modality": "speech", "kind": "impersonation", "purpose": "personal", "commercial": false, "channels": [ "in_app" ], "territories": [ "US" ] }, "inputs": [ { "role": "system", "text": "You are a fan voice chat. Speak as Maya Okafor in a friendly tone." } ], "end_user": { "id": "usr_48213" }, "execution": { "provider": "example-voice-provider", "model": "realtime-voice-2" } }), 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_SESSION_IDEMPOTENCY_KEY"] if not idempotencyKey: raise ValueError("Set REFLECTIONS_CREATE_SESSION_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({ "talent": ["tal_9t0wxyhk5zba2q8v1m3n7p4r6s"], "facet": "fct_v1m3n7p4r6s9t0wxyhk5zba2q8", "use": { "modality": "speech", "kind": "impersonation", "purpose": "personal", "commercial": False, "channels": ["in_app"], "territories": ["US"], }, "inputs": [ { "role": "system", "text": "You are a fan voice chat. Speak as Maya Okafor in a friendly tone.", }, ], "end_user": {"id": "usr_48213"}, "execution": {"provider": "example-voice-provider", "model": "realtime-voice-2"}, }).encode("utf-8") request = Request("https://app.reflections.ai/v1/sessions", 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_SESSION_IDEMPOTENCY_KEY") if idempotencyKey == "" { panic("Set REFLECTIONS_CREATE_SESSION_IDEMPOTENCY_KEY before running this example") } body := strings.NewReader(`{ "talent": [ "tal_9t0wxyhk5zba2q8v1m3n7p4r6s" ], "facet": "fct_v1m3n7p4r6s9t0wxyhk5zba2q8", "use": { "modality": "speech", "kind": "impersonation", "purpose": "personal", "commercial": false, "channels": [ "in_app" ], "territories": [ "US" ] }, "inputs": [ { "role": "system", "text": "You are a fan voice chat. Speak as Maya Okafor in a friendly tone." } ], "end_user": { "id": "usr_48213" }, "execution": { "provider": "example-voice-provider", "model": "realtime-voice-2" } }`) request, err := http.NewRequest("POST", "https://app.reflections.ai/v1/sessions", 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: SessionCreate: type: object required: - inputs - use properties: talent: type: array items: type: string pattern: ^tal_[0-9a-hjkmnp-tv-z]{26}$ maxItems: 4 description: > Talent your user picked, up to 4. The inputs are still resolved for anyone else. facet: type: string pattern: ^fct_[0-9a-hjkmnp-tv-z]{26}$ description: A specific facet, such as one of several voices. license: type: string pattern: ^lic_[0-9a-hjkmnp-tv-z]{26}$ description: > Use this license. By default the narrowest license that allows the use is chosen. inputs: type: array minItems: 1 items: $ref: '#/components/schemas/Input' description: > What the model receives when the session starts, such as your system text, in order. use: $ref: '#/components/schemas/Use' description: How the session's output will be used. end_user: $ref: '#/components/schemas/EndUser' description: The person the session is for. execution: $ref: '#/components/schemas/Execution' description: The model that runs the session. max_duration: $ref: '#/components/schemas/Duration' description: > The longest the session may run, such as `PT30M`. The stream sends a `max_duration` warning before it is reached. metadata: $ref: '#/components/schemas/Metadata' description: Your own keys, returned on the session. Session: type: object required: - id - object - livemode - status - check - created_at properties: id: type: string pattern: ^ses_[0-9a-hjkmnp-tv-z]{26}$ description: The session's ID, `ses_` followed by 26 characters. object: type: string const: session description: Always `session`. livemode: type: boolean description: '`true` in live mode, `false` in test mode.' status: type: string enum: - active - denied - ended - terminated description: > `active`: renew and submit samples. `denied`: the check did not allow it; `reasons` say why. `ended`: you ended it. `terminated`: Reflections ended it; `termination` says why. check: type: string pattern: ^chk_[0-9a-hjkmnp-tv-z]{26}$ description: The check Reflections ran on the session's inputs when it started. license: type: - string - 'null' pattern: ^lic_[0-9a-hjkmnp-tv-z]{26}$ description: The license the session runs under. Null when none applies. talent: type: array items: type: string pattern: ^tal_[0-9a-hjkmnp-tv-z]{26}$ description: The talent the session covers. token: type: - string - 'null' description: >- A JWS with `typ` `tlp-session+jwt`. Null when the session is not active. expires_at: type: - string - 'null' format: date-time description: > When the current token expires, 5 minutes after it was issued. Null when the session is not active. renew_every: $ref: '#/components/schemas/Duration' description: 'How often to renew the token: `PT60S`.' sampling: $ref: '#/components/schemas/Sampling' description: Which samples to submit, and how often. obligations: type: array items: $ref: '#/components/schemas/Obligation' description: What you must do for the whole session, such as show the disclosure. reasons: type: array items: $ref: '#/components/schemas/Reason' description: Why the session was denied. Empty otherwise. stream_url: type: - string - 'null' format: uri description: > The session stream's WebSocket URL. Stay connected to receive `session.terminated`. Null when the session is denied. termination: type: - object - 'null' description: > Why and when Reflections ended the session. Null unless `status` is `terminated`. The session stream's `session.terminated` message carries the same fields. required: - reason - sentence - revocation - sample - at properties: reason: $ref: '#/components/schemas/ReasonCode' description: >- A reason code, such as `license_revoked` or `prohibited_custom_term`. sentence: type: string description: >- The reason in the license's own words. Show it to your user as written. talent: type: string pattern: ^tal_[0-9a-hjkmnp-tv-z]{26}$ description: The talent it concerns, when the session has several. term: $ref: '#/components/schemas/Address' description: The license term or standing rule it rests on, as an address. revocation: type: - string - 'null' pattern: ^rvk_[0-9a-hjkmnp-tv-z]{26}$ description: >- The revocation that ended the session, for `license_revoked` and `license_suspended`. sample: type: - string - 'null' pattern: ^smp_[0-9a-hjkmnp-tv-z]{26}$ description: The sample that was denied, if one was. at: type: string format: date-time description: >- When Reflections ended the session. Report usage up to this time. ended_at: type: - string - 'null' format: date-time description: > When you ended the session with `POST /v1/sessions/{session_id}/end`. Null until then. metadata: $ref: '#/components/schemas/Metadata' description: Your metadata from the request. created_at: type: string format: date-time description: When the session started. Input: type: object description: > One part of the request a model receives, in order. Send text inline; send media as a file ID, or as `sha256` with a `url` Reflections can fetch. required: - role properties: role: type: string enum: - prompt - system - negative_prompt - rewritten_prompt - script - reference - voice_sample - mask - context description: > `prompt`: the user's words. `system`: instructions you add. `rewritten_prompt`: your expansion of the prompt, if the model receives that instead. `script`: words to be spoken. `reference`, `voice_sample`, `mask`: media the model receives. `context`: conversation history the model receives. text: type: string maxLength: 32000 description: >- The text, for every role except `reference`, `voice_sample` and `mask`. file: type: string pattern: ^file_[0-9a-hjkmnp-tv-z]{26}$ description: > A file ID from `POST /v1/files`, for a `reference`, `voice_sample` or `mask` input. url: type: string format: uri description: > A URL Reflections can fetch the media from. Send `sha256` and `media_type` with it. sha256: $ref: '#/components/schemas/Sha256Hex' description: > SHA-256 of the bytes, in hex: of the media at `url`, or of a text input's UTF-8 bytes when `prompt_handling.mode` is `withheld`. media_type: type: string example: image/png description: > The MIME type of the media at `url`, or `text/plain` for a withheld text input. Use: type: object required: - modality - kind - purpose - commercial properties: modality: $ref: '#/components/schemas/Modality' description: What will be generated. kind: $ref: '#/components/schemas/UseKind' description: How the talent appears in the output. purpose: $ref: '#/components/schemas/Purpose' description: What the output is for. commercial: type: boolean description: >- Whether anyone earns money from the output, including through advertising. channels: type: array items: $ref: '#/components/schemas/Channel' maxItems: 20 description: Required when `commercial` is true. territories: type: array items: $ref: '#/components/schemas/Territory' maxItems: 50 description: Required when `commercial` is true. EndUser: type: object description: > The person your product acts for. Send a stable ID scoped to your platform, never an email or a name. Reflections stores only an HMAC of it. required: - id properties: id: type: string maxLength: 200 description: > Your stable ID for the person, up to 200 characters. Never an email or a name. type: type: string enum: - consumer - business default: consumer description: > `consumer` for a person acting for themselves, `business` for one acting for a company. 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. Duration: type: string description: An ISO 8601 duration, such as `PT60S` or `P30D`. example: P30D 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 Sampling: type: object properties: audio_window_max: $ref: '#/components/schemas/Duration' description: > Submit an `audio` sample for every window of generated speech, each no longer than this, such as `PT15S`. transcript: type: string enum: - every_turn - none description: > `every_turn`: submit a `transcript` sample with the words of each turn. `none`: no transcript samples. frame_interval: $ref: '#/components/schemas/Duration' description: For video, submit one `frame` sample per interval. 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. 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. 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 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 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. Sha256Hex: type: string description: A SHA-256 digest of bytes, as 64 lowercase hex characters. pattern: ^[0-9a-f]{64}$ Modality: type: string description: >- What will be generated. `speech` is a voice speaking words; `audio` is any other sound. enum: - image - video - speech - audio - text UseKind: type: string description: > How the talent appears. `depiction`: shown or heard. `impersonation`: speaks or writes as the talent. `endorsement`: implies the talent approves something. `reference`: talked about, without synthesis; needs no license. enum: - depiction - impersonation - endorsement - reference Purpose: type: string enum: - advertising - branded_content - entertainment - editorial - personal - education - political 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 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 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 examples: SessionActive: summary: An active session value: id: ses_q8v1m3n7p4r6s9t0wxyhk5zba2 object: session livemode: true status: active check: chk_n7p4r6s9t0wxyhk5zba2q8v1m3 license: lic_ba2q8v1m3n7p4r6s9t0wxyhk5z talent: - tal_9t0wxyhk5zba2q8v1m3n7p4r6s token: >- eyJhbGciOiJFUzI1NiIsImtpZCI6InJmbC0yMDI2LTEwLWRvY3MzIiwidHlwIjoidGxwLXNlc3Npb24rand0In0.eyJhdWQiOiJhY2N0XzdwNHI2czl0MHd4eWhrNXpiYTJxOHYxbTNuIiwiZXhwIjoxNzkyMjYwMzAwLCJpYXQiOjE3OTIyNjAwMDAsImlzcyI6Imh0dHBzOi8vYXBwLnJlZmxlY3Rpb25zLmFpIiwianRpIjoic2VzX3E4djFtM243cDRyNnM5dDB3eHloazV6YmEyIiwic3ViIjoiYWNjdF83cDRyNnM5dDB3eHloazV6YmEycTh2MW0zbiIsInRscCI6eyJjaGVjayI6ImNoa19uN3A0cjZzOXQwd3h5aGs1emJhMnE4djFtMyIsImV1IjoiM2Y5YzFhN2U1YjJkOGY0MDYxYzNlOWE3YjVkMmY4MDE2ZTRjOWEzYjdkMWY1ZTJjOGE2YjRkMGY5ZTNjN2ExNSIsImZhY2V0cyI6WyJmY3RfdjFtM243cDRyNnM5dDB3eHloazV6YmEycTgiXSwibGljZW5zZXMiOlt7ImxpY2Vuc2UiOiJsaWNfYmEycTh2MW0zbjdwNHI2czl0MHd4eWhrNXoiLCJyZXZpc2lvbiI6Imxydl83cDRyNnM5dDB3eHloazV6YmEycTh2MW0zbiIsInRhbGVudCI6InRhbF85dDB3eHloazV6YmEycTh2MW0zbjdwNHI2cyIsInRlcm1zX2RpZ2VzdCI6InNoYTI1Njo4ZTBhMmM0ZTZiOGQwZjJhNGM2ZThiMGQyZjRhNmM4ZTBiMmQ0ZjZhOGMwZTJiNGQ2ZjhhMGMyZTRiNmQ4ZjBhIn1dLCJzYW1wbGluZyI6eyJhdWRpb193aW5kb3dfbWF4IjoiUFQxNVMiLCJ0cmFuc2NyaXB0IjoiZXZlcnlfdHVybiJ9LCJzZXNzaW9uIjoic2VzX3E4djFtM243cDRyNnM5dDB3eHloazV6YmEyIiwidGFsZW50IjpbInRhbF85dDB3eHloazV6YmEycTh2MW0zbjdwNHI2cyJdLCJ1c2UiOnsiY2hhbm5lbHMiOlsiaW5fYXBwIl0sImNvbW1lcmNpYWwiOmZhbHNlLCJraW5kIjoiaW1wZXJzb25hdGlvbiIsIm1vZGFsaXR5Ijoic3BlZWNoIiwicHVycG9zZSI6InBlcnNvbmFsIiwidGVycml0b3JpZXMiOlsiVVMiXX0sInZlciI6IjEuMCJ9fQ.RD_dRcXCqGHhYvg-PV3b1JIAoAX-WzVp02x6j-eSzmhYFxuZvniuJVrhJuHmzlFq_FYr6smqYXHQzb5p8DI0gA expires_at: '2026-10-17T18:05:00Z' renew_every: PT60S sampling: audio_window_max: PT15S transcript: every_turn obligations: - type: disclosure level: licensed placement: visible text: AI voice of Maya Okafor, licensed. - type: generation_instructions instructions: - Do not discuss politics or religion. - Do not make promises on her behalf. term: license:lic_ba2q8v1m3n7p4r6s9t0wxyhk5z/terms.voiceLineGrant.never - type: usage_report units: seconds within: P1D reasons: [] stream_url: >- wss://app.reflections.ai/v1/sessions/ses_q8v1m3n7p4r6s9t0wxyhk5zba2/stream termination: null ended_at: null metadata: {} created_at: '2026-10-17T18:00:00Z' 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 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.