{"openapi":"3.1.0","info":{"title":"auray-serverless/heygen/video-agent-0","version":"1.0.0","description":"`POST https://queue.auray.run/auray-serverless/heygen/video-agent-0` submits; the response carries a `request_id` and the three URLs to use next.\n\n`POST https://auray.run/auray-serverless/heygen/video-agent-0` is the same request run synchronously: the connection is held and the response is the model's OUTPUT, the same document the result URL would have answered. A request that usually takes longer than a run may hold its connection is refused `400 model_not_synchronous` there before anything is charged, naming `expected_seconds` and `wait_ceiling_seconds` — submit it to the queue instead. Past the deadline a run is `504 run_timed_out` with `X-Auray-Request-Timeout-Type: user` — the request is still alive, running and charged or, while it waits to start, not yet charged (`charged` says which) — so poll `status_url` rather than resending, or resend with the same `idempotency_key` to be handed this request again instead of a second one. A run holds one of the connections this platform, this product and your account may keep waiting; with all of them in use it is refused `429 wait_capacity` with `Retry-After` before anything is charged (`charged: false`), and retrying after that pause is safe.\n\nOne of Auray's catalogue models, billed once in credits. Whether it runs right now is `GET /v1/catalogue`'s `addresses` (no key needed): `connected` runs; `described` answers `501 model_not_connected` and `paused` `503 model_disabled`, both before anything is charged.\n\nPrice: Credits per megapixel-second (counted as `width*height*floor:0.9085*duration`): 8.8976. `width*height` counts as at least 0.9085 megapixels. From 9.216 to 491.52 megapixel-seconds a request. Priced up to height 1280, width 1280; past that a request is refused before any charge. Quoted when you submit, at the most the request can cost; the charge settles to what the job cost and never above the quote.\n\nFields as published for this model.\n\nEvery error code is explained at https://auray.ai/docs/api/errors.","contact":{"url":"https://auray.ai/docs"},"x-auray-model-id":"auray-serverless-heygen-video-agent-0","x-auray-hosted-by":"auray-serverless","x-auray-scope":"video:write","x-auray-scopes":["video:write","external:write"],"x-auray-price":{"kind":"quoted","note":"Credits per megapixel-second (counted as `width*height*floor:0.9085*duration`): 8.8976. `width*height` counts as at least 0.9085 megapixels. From 9.216 to 491.52 megapixel-seconds a request. Priced up to height 1280, width 1280; past that a request is refused before any charge. Quoted when you submit, at the most the request can cost; the charge settles to what the job cost and never above the quote.","rule":{"unit":"megapixel_second","counts":"width*height*floor:0.9085*duration","counts_request":true,"bands":[{"when":{},"credits_per_unit":8.8976,"min_units":9.216,"max_units":491.52,"max_inputs":{"height":1280,"width":1280}}]},"metered":true},"x-auray-surface-enabled":true},"servers":[{"url":"https://queue.auray.run"},{"url":"https://auray.run"}],"paths":{"/auray-serverless/heygen/video-agent-0":{"post":{"operationId":"submit","summary":"Run auray-serverless/heygen/video-agent-0","tags":["Queue"],"parameters":[{"name":"wait","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":300},"description":"Hold the request open until the job settles, up to 300 seconds. The answer is still a status document; `timed_out` says the wait ran out rather than the job failing. One product refuses it outright and says so with `wait_unsupported`."},{"name":"logs","in":"query","required":false,"schema":{"type":"string","enum":["1","0","true","false"]},"description":"Include the runner's log lines on a read. Off by default, because a status polled at 10 Hz that carries a growing log is the same lines paid for a hundred times."},{"name":"webhook","in":"query","required":false,"schema":{"type":"string","format":"uri"},"description":"An https address to POST this job's outcome to once, beside any endpoint the account has registered. Checked when it is stored and again before it is sent: https only, no user-info, no private or loopback host, at most 2,000 characters. Signed `Auray-Signature v2` with a `kid`; verify it against our JWKS. No ownership challenge here, so the body names the account the job belongs to in `account` (the `id` `GET /v1/me` returns), inside what the signature covers: a receiver compares it with its own and refuses anything else."},{"name":"fal_webhook","in":"query","required":false,"schema":{"type":"string","format":"uri"},"description":"An https address to POST this job's outcome to once, beside any endpoint the account has registered. Checked when it is stored and again before it is sent: https only, no user-info, no private or loopback host, at most 2,000 characters. Signed `Auray-Signature v2` with a `kid`; verify it against our JWKS. No ownership challenge here, so the body names the account the job belongs to in `account` (the `id` `GET /v1/me` returns), inside what the signature covers: a receiver compares it with its own and refuses anything else. An alias for `webhook`; sending both with different values is refused with `conflicting_options`."},{"name":"max_queue_length","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":2147483647},"description":"Refuse with 429 `queue_too_long` rather than queue behind more than this many waiting requests. `0` is a real value and means \"only if nobody is waiting\". Decided before anything is charged. On a model that does not queue — every catalogue model today, whose `lifecycle.queue` in `GET /v1/models` is `refuses` — sending it is refused 422 `queue_not_offered` before anything is charged."},{"name":"fal_max_queue_length","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":2147483647},"description":"Refuse with 429 `queue_too_long` rather than queue behind more than this many waiting requests. `0` is a real value and means \"only if nobody is waiting\". Decided before anything is charged. On a model that does not queue — every catalogue model today, whose `lifecycle.queue` in `GET /v1/models` is `refuses` — sending it is refused 422 `queue_not_offered` before anything is charged. An alias for `max_queue_length`; sending both with different values is refused with `conflicting_options`."},{"name":"X-Auray-Priority","in":"header","required":false,"schema":{"type":"string","enum":["normal","low"]},"description":"`low` puts this request behind every normal one. Nothing else changes. On a model that does not queue — every catalogue model today, whose `lifecycle.queue` in `GET /v1/models` is `refuses` — sending it is refused 422 `queue_not_offered` before anything is charged."},{"name":"X-Fal-Queue-Priority","in":"header","required":false,"schema":{"type":"string","enum":["normal","low"]},"description":"`low` puts this request behind every normal one. Nothing else changes. On a model that does not queue — every catalogue model today, whose `lifecycle.queue` in `GET /v1/models` is `refuses` — sending it is refused 422 `queue_not_offered` before anything is charged. An alias for `X-Auray-Priority`; sending both with different values is refused with `conflicting_options`."},{"name":"X-Auray-Request-Timeout","in":"header","required":false,"schema":{"type":"number","minimum":1,"maximum":86400},"description":"Seconds to wait for a seat. A request still waiting past it is failed `request_timeout` and refunded. It is a time-to-START and never a bound on inference: a job that has been dispatched is not stopped by it. On a model that does not queue — every catalogue model today, whose `lifecycle.queue` in `GET /v1/models` is `refuses` — it is accepted and has nothing to bound: such a model starts at once or refuses at once."},{"name":"X-Fal-Request-Timeout","in":"header","required":false,"schema":{"type":"number","minimum":1,"maximum":86400},"description":"Seconds to wait for a seat. A request still waiting past it is failed `request_timeout` and refunded. It is a time-to-START and never a bound on inference: a job that has been dispatched is not stopped by it. On a model that does not queue — every catalogue model today, whose `lifecycle.queue` in `GET /v1/models` is `refuses` — it is accepted and has nothing to bound: such a model starts at once or refuses at once. An alias for `X-Auray-Request-Timeout`; sending both with different values is refused with `conflicting_options`."},{"name":"X-Auray-Covered-Only","in":"header","required":false,"schema":{"type":"string","enum":["1","true"]},"description":"Run this job only if a pass or a promotion of yours pays for it. A job neither pays for is refused 409 `not_covered` before anything is held or charged — or, when your pass had ended by the time the job started, refunded and refused so — where without this header your credits would pay for it; a job your plan runs only through a pass is refused as the plan refuses it (`model_not_in_plan`, `pass_does_not_cover`). For a job it lets through, the submit's answer on `queue.auray.run` says `credits_charged: 0` and what paid in `coverage`, and so does `GET /v1/jobs/{id}`; a run on `auray.run` answers the job's output, which says neither — read `GET /v1/jobs/{id}` with its `request_id`. `true` is read as `1`; any other value as no header."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Input"}}}},"responses":{"200":{"description":"Accepted, and charged and running — or, when the platform is full, waiting in the queue and charged when it starts: `credits_charged` is what has been taken, `credits_quoted` what it costs. Always this status: a submit's outcome is in `status`, never in the status line.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/QueueStatus"},{"type":"object","properties":{"product":{"type":"string","enum":["photo","music","threed","video","external"],"description":"Which of this platform's products ran it."},"provider_job_id":{"type":["string","null"],"description":"The id the job runs under, once it has been handed to its model — possibly while still `queued`; null before. Quote it to support."},"model":{"type":"string","description":"The address that ran it, echoed back."},"engine":{"type":["string","null"],"description":"The service's own name for the model that ran, where it reports one — a catalogue model's is its `id` on GET /v1/models; null otherwise. What `model` carried before it carried the address."},"attribution":{"type":["string","null"],"description":"The credit line the model's licence requires you to show; null where none is required."},"credits_charged":{"type":"integer","examples":[1],"description":"What this job cost. 0 on a replay, or when a pass or a promotion paid for it (`coverage` says which)."},"credits_quoted":{"type":"integer","examples":[1],"description":"What this job costs, in credits: the price it was quoted at submit. Equal to `credits_charged` once it has been charged; while it waits in the queue to start, `credits_charged` is 0 and this is what it will be charged when it starts (a cancel before then costs nothing) — and a replay of a job still waiting quotes the body that job was queued with, which is the one it runs, not the replay's. For a catalogue model it is the hold, and the settle may give part of it back — a settled read's `credits_charged` says what it finally cost."},"coverage":{"type":"object","description":"Present when a pass or a promotion paid for this job — `{\"by\": \"pass\", \"pass\": \"seedance-2-5\"}` or `{\"by\": \"promotion\"}`, and `credits_charged` is 0 — or when you hold a pass for this model that did not cover this job: `{\"by\": null, \"miss\": {\"pass\": \"video\", \"why\": \"door\"}}`, `why` being `door` (the pass does not work here) or `shape` (it does not cover this kind of job). Absent otherwise. Send `X-Auray-Covered-Only: 1` to run a job only if a pass or a promotion pays for it."},"credits_remaining":{"type":"integer","examples":[1],"description":"The balance after it."},"expected_seconds":{"type":"integer","examples":[1],"description":"A rough render time, for a progress bar; 0 where nothing is published."},"give_up_after_seconds":{"type":"integer","examples":[1],"description":"The longest this job may take from its submit: the longest it may wait to start (your X-Auray-Request-Timeout, or the product's queue deadline) plus the longest it may run before it is stopped and refunded. Waiting longer is waiting for nothing; the official clients wait this long by default. For a catalogue model the part it may run is its own reap as its registry row states it (`lifecycle.stall_ceiling_seconds` on GET /v1/models); otherwise these are the published limits: we may lengthen them during an incident, never shorten them."},"replayed":{"type":"boolean","description":"`true` when your `idempotency_key` matched a job this platform already had. Nothing was charged and nothing was rendered twice."},"waited":{"type":"boolean","description":"Present when `wait` was asked for. The rest of this group comes with it."},"timed_out":{"type":"boolean","description":"The wait ran out before the job settled. Still a 2xx, never a 408 or 504 — a library that retries on those would resubmit and you would pay twice. Poll `status_url`."},"wait_declined":{"type":"string","enum":["platform_busy","product_busy","account_busy"],"description":"No seat was free to hold the connection with, so the request was answered at once. `platform_busy`: no product would have helped. `product_busy`: another product's queue might. `account_busy`: you are already waiting on every seat your plan's lanes allow. The job is running either way; poll it."},"status_url":{"type":"string","description":"Poll this."},"response_url":{"type":"string","description":"Fetch the result from this once the status is COMPLETED."},"cancel_url":{"type":"string","description":"`PUT` to this to ask for a cancellation."}}}]}}}},"202":{"description":"The dispatch could not be confirmed (`dispatch_unresolved`): the charge stands, the request exists and is `IN_QUEUE`, and the body is its status document with `message` and `docs` beside it. Poll `status_url` — never resend under a new key, which would be a second charge. If it never starts, it is declared lost and refunded.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/QueueStatus"},{"type":"object","properties":{"status_url":{"type":"string","description":"Poll this."},"response_url":{"type":"string","description":"Fetch the result from this once the status is COMPLETED."},"cancel_url":{"type":"string","description":"`PUT` to this to ask for a cancellation."},"message":{"type":"string","description":"Why the dispatch could not be confirmed, and what to do."},"docs":{"type":"string","description":"The `dispatch_unresolved` entry on the errors page."}}}]}}}},"400":{"description":"A refusal: `error_type` is ConflictError or ValidationError. The code is in `error`, and every code is explained at https://auray.ai/docs/api/errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"A refusal: `error_type` is AuthenticationError. On `auray.run`, a request that ran and failed: `error_type` is AuthenticationError. The code is in `error`, and every code is explained at https://auray.ai/docs/api/errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"A refusal: `error_type` is PaymentError. On `auray.run`, a request that ran and failed: `error_type` is PaymentError. The code is in `error`, and every code is explained at https://auray.ai/docs/api/errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A refusal: `error_type` is PermissionError. On `auray.run`, a request that ran and failed: `error_type` is PermissionError. The code is in `error`, and every code is explained at https://auray.ai/docs/api/errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"A refusal: `error_type` is NotFoundError. On `auray.run`, a request that ran and failed: `error_type` is NotFoundError. The code is in `error`, and every code is explained at https://auray.ai/docs/api/errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"405":{"description":"A refusal: `error_type` is ValidationError. The code is in `error`, and every code is explained at https://auray.ai/docs/api/errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"A refusal: `error_type` is CancellationError or ConflictError. On `auray.run`, a request that ran and failed: `error_type` is CancellationError or ConflictError. The code is in `error`, and every code is explained at https://auray.ai/docs/api/errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"A refusal: `error_type` is GoneError or NotFoundError. On `auray.run`, a request that ran and failed: `error_type` is GoneError. The code is in `error`, and every code is explained at https://auray.ai/docs/api/errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"A refusal: `error_type` is PayloadTooLargeError. On `auray.run`, a request that ran and failed: `error_type` is PayloadTooLargeError. The code is in `error`, and every code is explained at https://auray.ai/docs/api/errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"A refusal of what the request says — an option, the body, a field — decided before anything is charged, or the model's own refusal of the request as it was written (its content filter, a value or a file it would not take), refunded: `error_type` is ContentPolicyError or ValidationError, and `detail` is a list of `{loc, msg, type}`, `loc` naming where (`[\"body\"]` when the parser names no field). On `auray.run`, a request that ran and failed: `error_type` is ContentPolicyError or ValidationError. The code is in `error`, and every code is explained at https://auray.ai/docs/api/errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"428":{"description":"A refusal: `error_type` is PreconditionError. On `auray.run`, a request that ran and failed: `error_type` is PreconditionError. The code is in `error`, and every code is explained at https://auray.ai/docs/api/errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"A refusal: `error_type` is CapacityError or RateLimitError. On `auray.run`, a request that ran and failed: `error_type` is RateLimitError. The code is in `error`, and every code is explained at https://auray.ai/docs/api/errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"451":{"description":"A refusal: `error_type` is RegionError. On `auray.run`, a request that ran and failed: `error_type` is RegionError. The code is in `error`, and every code is explained at https://auray.ai/docs/api/errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"A refusal: `error_type` is ConfigurationError or InternalError. On `auray.run`, a request that ran and failed: `error_type` is ExecutionError or InternalError. The code is in `error`, and every code is explained at https://auray.ai/docs/api/errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"This address is not open yet: `model_not_connected`, before anything is charged. `GET /v1/catalogue` lists which addresses run. A refusal: `error_type` is NotImplementedError. On `auray.run`, a request that ran and failed: `error_type` is NotImplementedError. The code is in `error`, and every code is explained at https://auray.ai/docs/api/errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"A refusal: `error_type` is ContentPolicyError or UpstreamError. On `auray.run`, a request that ran and failed: `error_type` is UpstreamError. The code is in `error`, and every code is explained at https://auray.ai/docs/api/errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The model, its family or its product is paused: `model_disabled`, `vendor_disabled` or `api_disabled`, with the reason, before anything is charged. A refusal: `error_type` is CapacityError or ConfigurationError or InternalError or UpstreamError. On `auray.run`, a request that ran and failed: `error_type` is CapacityError or ConfigurationError. The code is in `error`, and every code is explained at https://auray.ai/docs/api/errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"504":{"description":"A refusal: `error_type` is TimeoutError. On `auray.run`, a request that ran and failed: `error_type` is TimeoutError. The code is in `error`, and every code is explained at https://auray.ai/docs/api/errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/auray-serverless/heygen/video-agent-0/requests/{request_id}":{"get":{"operationId":"result","summary":"The result","tags":["Queue"],"parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string"},"description":"The `request_id` the submit answered with."},{"name":"logs","in":"query","required":false,"schema":{"type":"string","enum":["1","0","true","false"]},"description":"Include the runner's log lines on a read. Off by default, because a status polled at 10 Hz that carries a growing log is the same lines paid for a hundred times."}],"responses":{"200":{"description":"The request and its output, once its status is COMPLETED.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/QueueStatus"},{"type":"object","properties":{"status_url":{"type":"string","description":"Poll this."},"response_url":{"type":"string","description":"Fetch the result from this once the status is COMPLETED."},"cancel_url":{"type":"string","description":"`PUT` to this to ask for a cancellation."}}}]}}}},"400":{"description":"The request has not finished: `request_in_progress`, with its `status` (`IN_QUEUE` or `IN_PROGRESS`), `queue_position` while it waits, and `Retry-After`. Nothing a job made part-way is its result: poll `status_url` until COMPLETED, then read this again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The request produced no output. `error_type` is AuthenticationError; the code is in `error` and the sentence in `detail`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"The request produced no output. `error_type` is PaymentError; the code is in `error` and the sentence in `detail`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The request produced no output. `error_type` is PermissionError; the code is in `error` and the sentence in `detail`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The request produced no output. `error_type` is NotFoundError; the code is in `error` and the sentence in `detail`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The request produced no output. `error_type` is ConflictError or CancellationError; the code is in `error` and the sentence in `detail`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"The request produced no output. `error_type` is GoneError; the code is in `error` and the sentence in `detail`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"The request produced no output. `error_type` is PayloadTooLargeError; the code is in `error` and the sentence in `detail`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The request produced no output. `error_type` is ValidationError or ContentPolicyError; the code is in `error` and the sentence in `detail`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"428":{"description":"The request produced no output. `error_type` is PreconditionError; the code is in `error` and the sentence in `detail`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"The request produced no output. `error_type` is RateLimitError; the code is in `error` and the sentence in `detail`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"451":{"description":"The request produced no output. `error_type` is RegionError; the code is in `error` and the sentence in `detail`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"The request produced no output. `error_type` is ExecutionError or InternalError; the code is in `error` and the sentence in `detail`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"The request produced no output. `error_type` is NotImplementedError; the code is in `error` and the sentence in `detail`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"The request produced no output. `error_type` is UpstreamError; the code is in `error` and the sentence in `detail`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The request produced no output. `error_type` is CapacityError or ConfigurationError; the code is in `error` and the sentence in `detail`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"504":{"description":"The request produced no output. `error_type` is TimeoutError; the code is in `error` and the sentence in `detail`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/auray-serverless/heygen/video-agent-0/requests/{request_id}/status":{"get":{"operationId":"status","summary":"The status","description":"The same document the result answers, and it is 200 for a failed or unfinished request where the result is not: this address reports, the result IS the output. `GET /auray-serverless/heygen/video-agent-0/requests/{request_id}/status/stream` streams this document as `text/event-stream` until it is COMPLETED; each stream closes after about five minutes with no final frame, having sent `retry:` at its top, so reconnect and keep reading until COMPLETED — every frame is the whole status, and the official clients reconnect on their own. It takes a seat from the same pool `wait` does and is 503 `stream_declined` when none is free.","tags":["Queue"],"parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string"},"description":"The `request_id` the submit answered with."},{"name":"logs","in":"query","required":false,"schema":{"type":"string","enum":["1","0","true","false"]},"description":"Include the runner's log lines on a read. Off by default, because a status polled at 10 Hz that carries a growing log is the same lines paid for a hundred times."}],"responses":{"200":{"description":"Where the request is.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/QueueStatus"},{"type":"object","properties":{"status_url":{"type":"string","description":"Poll this."},"response_url":{"type":"string","description":"Fetch the result from this once the status is COMPLETED."},"cancel_url":{"type":"string","description":"`PUT` to this to ask for a cancellation."}}}]}}}},"404":{"description":"A refusal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/auray-serverless/heygen/video-agent-0/requests/{request_id}/cancel":{"put":{"operationId":"cancel","summary":"Ask for a cancellation","description":"202 means REQUESTED, not cancelled: a model can decline to stop and keep going, so the body carries `cancelled` and the settled charge for a caller who needs to know which happened. `POST` to the same address answers this platform's own cancel envelope, unchanged.","tags":["Queue"],"parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string"},"description":"The `request_id` the submit answered with."}],"responses":{"202":{"description":"The cancellation was accepted.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","const":"CANCELLATION_REQUESTED"},"request_id":{"type":"string"},"job_id":{"type":"string","description":"The same job reference as `request_id`, under the one name every host uses."},"product":{"type":"string"},"job_status":{"type":"string"},"settled":{"type":"boolean"},"cancelled":{"type":"boolean"},"credits_charged":{"type":["integer","null"],"description":"What the job cost after the cancel's refund — the ledger's net; null, with `settled_unknown`, when it could not be read."},"credits_reserved":{"type":["integer","null"],"description":"What was taken when the job was charged."},"settled_unknown":{"type":"boolean","description":"Present, and `true`, when the cancel happened and its figures could not be read."}},"required":["status","request_id","job_id","cancelled"]}}}},"400":{"description":"A refusal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"A refusal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","bearerFormat":"auray_sk_","description":"A platform key: auray_sk_ and 62 more characters, 71 in all. `Authorization: Bearer <key>` or `Authorization: Key <key>`; both are accepted on every address, and the scheme word is case-insensitive."}},"schemas":{"Input":{"type":"object","properties":{"inputs":{"type":"object","properties":{"image":{"type":"string","format":"uri","examples":["https://v3b.auray.media/examples/samples/still-life.jpg"],"description":"Image to animate as an avatar (an http(s) URL; upload a local file first and send its read URL)."},"avatar":{"type":"string","enum":["Abigail_expressive_2024112501","Abigail_sitting_sofa_front","Abigail_sitting_sofa_side","Abigail_standing_office_front","Abigail_standing_office_side","Aditya_public_1","Aditya_public_2","Aditya_public_3","Aditya_public_4","Aditya_public_5","Adrian_public_20240312","Adrian_public_2_20240312","Adrian_public_3_20240312","Adriana_BizTalk_Front_public","Adriana_BizTalk_Side_public","Adriana_Business_Front_2_public","Adriana_Business_Front_public","Adriana_Business_Side_public","Adriana_Nurse_Front_2_public","Adriana_Nurse_Front_public","Adriana_Nurse_Side_2_public","Adriana_Nurse_Side_public","Adriana_Nurse_Sitting_Side_public","Adriana_SuitSofa_Front_public","Aiko_public","Albert_public_1","Albert_public_2","Albert_public_3","Albert_public_4","Albert_public_5","Albert_public_6","Amanda_Maintenance_Front","Amanda_Maintenance_Left","Amanda_Maintenance_Right","Amanda_in_Blue_Shirt_Front","Amanda_in_Blue_Shirt_Left","Amanda_in_Blue_Shirt_Right","Amanda_in_Grey_Shirt_Front","Amanda_in_Grey_Shirt_Left","Amanda_in_Grey_Shirt_Right","Amelia_lying_lounge_front","Amelia_lying_lounge_side","Amelia_sitting_business_training_front","Amelia_sitting_business_training_side","Amelia_sitting_yoga_front","Amelia_sitting_yoga_side","Amelia_standing_business_training_front","Amelia_standing_business_training_side","Amelia_standing_lounge_front","Amelia_standing_lounge_side","Amelia_standing_yoga_front","Amelia_standing_yoga_side","Andrew_public_pro1_20230614","Andrew_public_pro2_20230614","Andrew_public_pro3_20230614","Andrew_public_pro4_20230614","Anja_sitting_sofa_front","Anja_sitting_sofa_side","Anja_standing_office_front","Anja_standing_office_side","Ann_Business_Front_public","Ann_Business_Sitting_public","Ann_Casual_Front_public","Ann_Casual_Lying_public","Ann_Casual_Sitting_2_public","Ann_Casual_Sitting_public","Ann_Doctor_Sitting_public","Ann_Doctor_Standing2_public","Ann_Sweater_Front_public","Ann_Sweater_Side_public","Ann_Therapist_public","Anna_public_20240108","Anna_public_2_20240108","Anna_public_3_20240108","Annelise_public_1","Annelise_public_2","Annelise_public_3","Annelise_public_4","Annelore_public_1","Annelore_public_2","Annelore_public_3","Annelore_public_4","Annelore_public_5","Annie_Bar_Sitting_Front_public","Annie_Bar_Sitting_Side_public","Annie_Bar_Standing_Front_2_public","Annie_Bar_Standing_Front_3_public","Annie_Bar_Standing_Front_public","Annie_Bar_Standing_Side_2_public","Annie_Bar_Standing_Side_3_public","Annie_Bar_Standing_Side_public","Annie_Business_Casual_Standing_Front_2_public","Annie_Business_Casual_Standing_Front_public","Annie_Business_Casual_Standing_Side_2_public","Annie_Business_Casual_Standing_Side_public","Annie_Casual_Sitting_Front_2_public","Annie_Casual_Sitting_Front_public","Annie_Casual_Sitting_Side_2_public","Annie_Casual_Sitting_Side_public","Annie_Casual_Standing_Front_2_public","Annie_Casual_Standing_Front_public","Annie_Casual_Standing_Side_2_public","Annie_Casual_Standing_Side_public","Annie_Desk_Sitting_Front_2_public","Annie_Desk_Sitting_Front_public","Annie_Desk_Sitting_Side_2_public","Annie_Desk_Sitting_Side_public","Annie_Lounge_Standing_Front_public","Annie_Lounge_Standing_Side_public","Annie_Office_Sitting_Front_2_public","Annie_Office_Sitting_Front_public","Annie_Office_Sitting_Side_2_public","Annie_Office_Sitting_Side_public","Annie_Office_Standing_Front_public","Annie_Office_Standing_Side_public","Annie_Sofa_Sitting_Front_3_public","Annie_Sofa_Sitting_Front_public","Annie_Sofa_Sitting_Side1_public","Annie_Sofa_Sitting_Side_2_public","Annie_Sofa_Sitting_Side_3_public","Annie_Sofa_Sitting_Side_public","Annie_Studio_Pink_Sitting_Front_public","Annie_Studio_Pink_Sitting_Side_public","Annie_Studio_Pink_Standing_Front_public","Annie_Studio_Pink_Standing_Side_public","Annie_expressive10_public","Annie_expressive11_public","Annie_expressive12_public","Annie_expressive2_public","Annie_expressive3_public","Annie_expressive4_public","Annie_expressive5_public","Annie_expressive6_public","Annie_expressive7_public","Annie_expressive8_public","Annie_expressive9_public","Annie_expressive_public","Armando_Casual_Front_public","Armando_Casual_Side_public","Armando_Suit_Front_public","Armando_Suit_Side_public","Armando_Sweater_Front2_public","Armando_Sweater_Front_public","Armando_Sweater_Side2_public","Armando_Sweater_Side_public","Artur_sitting_office_front","Artur_sitting_office_side","Artur_sitting_sofacasual_front","Artur_sitting_sofacasual_side","Artur_standing_office_front","Artur_standing_office_side","Artur_standing_sofacasual_front","Artur_standing_sofacasual_side","Aubrey_expressive_2024112701","Aubrey_sitting_sofa_front","Aubrey_sitting_sofa_side","Aubrey_standing_night_scene_front","Aubrey_standing_outdoor_sport_front","Aubrey_standing_outdoor_sport_side","August_Casual_Front2_public","August_Casual_Front_public","August_Cool_Sitting_public","August_Cool_Style_public","August_Employee_Front_public","August_Hoodies_Front2_public","August_Hoodies_Front_public","Aurelien_public_pro1_20230601","Aurelien_public_pro2_20230601","Aurelien_public_pro3_20230601","Aurelien_public_pro4_20230601","Bahar_Business_Front_public","Bahar_Business_Side_public","Bahar_Business_Sitting_Front_public","Bahar_Business_Sitting_Side_public","Bahar_Casual_Sitting_Front2_public","Bahar_Casual_Sitting_Front_public","Bahar_Casual_Sitting_Side2_public","Bahar_Casual_Sitting_Side_public","Bahar_Denim_Casual_Front_public","Bahar_Denim_Casual_Side_public","Bahar_Denim_Front_public","Bahar_Denim_Side_public","Bahar_Jacket_Casual_Front_public","Bahar_Jacket_Casual_Side_public","Bahar_Jacket_Front_public","Bahar_Jacket_Side_public","Bahar_Suit_Front_public","Bahar_Suit_Side_public","Bahar_expressive_2024112501","Bastien_public_1","Bastien_public_2","Bastien_public_3","Bastien_public_4","Blanka_lying_outfoorreading_front","Blanka_lying_outfoorreading_side","Blanka_sitting_lounge_front","Blanka_sitting_lounge_side","Blanka_sitting_picnic_front","Blanka_sitting_picnic_side","Blanka_standing_outfoorbusiness_front","Blanka_standing_outfoorbusiness_side","Bojan_lying_lounge_front","Bojan_lying_lounge_side","Bojan_sitting_businesstraining_front","Bojan_sitting_businesstraining_side","Bojan_sitting_sport_front","Bojan_sitting_sport_side","Bojan_standing_businesstraining_front","Bojan_standing_businesstraining_side","Bojan_standing_lounge_front","Bojan_standing_lounge_side","Bojan_standing_sport_front","Bojan_standing_sport_side","Bradley_Blue_Polo_Front","Bradley_Blue_Polo_Left","Bradley_Blue_Polo_Right","Bradley_Blue_Shirt_Front","Bradley_Blue_Shirt_Left","Bradley_Blue_Shirt_Right","Bradley_Doctor_Front","Bradley_Doctor_Left","Bradley_Doctor_Right","Brandon_Business_Sitting_Front_public","Brandon_Business_Sitting_Side_public","Brandon_Business_Standing_Front_public","Brandon_Business_Standing_Side_public","Brandon_Casual_Sitting_Front_public","Brandon_Casual_Sitting_Side_public","Brandon_Kitchen_Standing_Front_public","Brandon_Kitchen_Standing_Side_public","Brandon_Lobby_Sitting_Front_public","Brandon_Lobby_Sitting_Side_public","Brandon_Lobby_Standing_Front_public","Brandon_Lobby_Standing_Side_public","Brandon_Office_Sitting_Front_public","Brandon_Office_Sitting_Side_public","Brandon_Office_Standing_Front_public","Brandon_Office_Standing_Side_public","Brandon_Sofa_Sitting_Front_public","Brandon_Sofa_Sitting_Side_public","Brandon_expressive2_public","Brandon_expressive3_public","Brandon_expressive_public","Brent_sitting_office_front","Brent_sitting_office_side","Brent_sitting_sofa_front","Brent_sitting_sofa_side","Brent_standing_office_front","Brent_standing_office_side","Brent_standing_sofa_front","Brent_standing_sofa_side","Briana_public_20240110","Briana_public_2_20240110","Briana_public_3_20240110","Bruce_public","Bryan_Casual_Front_public","Bryan_Casual_Side_public","Bryan_FitnessCoach_public","Bryan_IT_Sitting_public","Bryan_PlaidShirt_Front_public","Bryan_PlaidShirt_Side_public","Bryan_Suit_Front_public","Bryan_Suit_Side_public","Bryce_public_1","Bryce_public_2","Bryce_public_3","Bryce_public_4","Bryce_public_5","Byron_Business_Front_2_public","Byron_Business_Front_public","Byron_Business_Side_2_public","Byron_Business_Side_public","Byron_Business_Sitting_Front_public","Byron_Business_Sitting_Size_public","Byron_Casual_Front_2_public","Byron_Casual_Front_public","Byron_Casual_Side_2_public","Byron_Casual_Side_public","Byron_Casual_Sitting_Front_public","Byron_Casual_Sitting_Side_public","Byron_Jacket_Front_public","Byron_Jacket_Side_public","Byron_Sitting_Front_public","Byron_Sitting_Side_public","Byron_Suit_Front_public","Byron_Suit_Side_public","Candace_Beige_Dress_Front","Candace_Beige_Dress_Left","Candace_Beige_Dress_Right","Candace_Doctor_Front","Candace_Doctor_Left","Candace_Doctor_Right","Candace_Pink_Blazer_Front","Candace_Pink_Blazer_Left","Candace_Pink_Blazer_Right","Carla_in_Doctor_Front","Carla_in_Doctor_Left","Carla_in_Doctor_Right","Carla_in_Dress_Left","Carla_in_Shirt_Front","Carla_in_Shirt_Left","Carla_in_Shirt_Right","Carlotta_BizTalk_Front_public","Carlotta_BizTalk_Side_public","Carlotta_Business_Front_public","Carlotta_Business_Side_public","Carlotta_Casual_Front_public","Carlotta_Casual_Side_public","Carlotta_Casual_Sitting_Front_public","Carlotta_Casual_Sitting_Side_public","Carlotta_Half_Front_public","Carlotta_Pink_Jumpsuit_Front_2_public","Carlotta_Pink_Jumpsuit_Front_public","Carlotta_Pink_Jumpsuit_Side_2_public","Carlotta_Pink_Jumpsuit_Side_public","Carlotta_Pink_Jumpsuit_Sitting_Front_public","Carlotta_Pink_Jumpsuit_Sitting_Side_public","Caroline_Business_Sitting_Front_public","Caroline_Business_Sitting_Side_public","Caroline_Business_Standing_Front_public","Caroline_Business_Standing_Side_public","Caroline_Casual_Sitting_Front_public","Caroline_Casual_Sitting_Side_public","Caroline_Kitchen_Standing_Front_public","Caroline_Kitchen_Standing_Side_public","Caroline_Lobby_Sitting_Front_public","Caroline_Lobby_Sitting_Side_public","Caroline_Lobby_Standing_Front_public","Caroline_Lobby_Standing_Side_public","Caroline_Office_Sitting_Front_public","Caroline_Office_Sitting_Side_public","Caroline_Office_Standing_Front_public","Caroline_Office_Standing_Side_public","Caroline_Sofa_Sitting_Front_public","Caroline_Sofa_Sitting_Side_public","Caroline_expressive2_public","Caroline_expressive3_public","Caroline_expressive4_public","Caroline_expressive_public","Chad_Maintenance_Front","Chad_Maintenance_Left","Chad_Maintenance_Right","Chad_in_Blue_Shirt_Front","Chad_in_Blue_Shirt_Left","Chad_in_Blue_Shirt_Right","Chad_in_Grey_Shirt_Front","Chad_in_Grey_Shirt_Left","Chad_in_Grey_Shirt_Right","Chakir_headscarf_Front","Chakir_headscarf_Left","Chakir_headscarf_Right","Chakir_in_white_Shirt_Front","Chakir_in_white_Shirt_Left","Chakir_in_white_Shirt_Right","Chloe_expressive_2024120201","Chloe_standing_lounge_front","Chloe_standing_lounge_side","Chloe_standing_outdoor_side","Colin_Business_Front2_public","Colin_Business_Front_public","Colin_Jacket_Front_public","Colin_Sitting_Cool_Style2_public","Colin_Sitting_Cool_Style_public","Colin_Suit_Front_public","Colin_Sweater_Front_public","Colin_Sweater_Sitting_Front_public","Connie_Business_Front_public","Connie_Business_Sitting_Front_public","Connie_Casual_Sitting_Front_public","Connie_Casual_Sitting_Side_public","Connie_Education_Front_public","Connie_Education_Side_2_public","Connie_Education_Side_public","Connie_Skirt_Front_public","Connie_Skirt_Side_public","Connie_Skirt_Sitting_Front_public","Connie_Skirt_Sitting_Side_public","Connie_Suit_Front_public","Conrad_sitting_house_side","Conrad_sitting_sofa_front","Conrad_standing_house_front","Conrad_standing_sofa_side","Crisanto_Business_Front_public","Crisanto_Business_Side_public","Crisanto_Chef_Front_2_public","Crisanto_Chef_Front_public","Crisanto_Chef_Side_2_public","Crisanto_Chef_Side_public","Crisanto_Chef_Sitting_public","Crisanto_Education_Front_public","Crisanto_Education_Side_public","Crisanto_Nurse_Front_2_public","Crisanto_Nurse_Front_public","Crisanto_Nurse_Side_2_public","Crisanto_Nurse_Side_public","Crisanto_Nurse_Sitting_Front_public","Crisanto_Nurse_Sitting_Side_public","Crisanto_Suit_Front_public","Crisanto_Suit_Side_public","Daisy-inTshirt-20220819","Daisy-inshirt-20220818","Daisy-inskirt-20220818","Daisy-insuit-20220818","Daphne_public_1","Daphne_public_2","Daphne_public_3","Daphne_public_4","Daphne_public_5","Daphne_public_6","Darnell_Blue_Shirt_Front","Darnell_Blue_Shirt_Left","Darnell_Blue_Shirt_Right","Darnell_Bordeaux_Polo_Front","Darnell_Bordeaux_Polo_Left","Darnell_Bordeaux_Polo_Right","Darnell_Doktor_Front","Darnell_Doktor_Left","Darnell_Doktor_Right","Derya_sitting_indoor_front","Derya_sitting_indoor_side","Derya_sitting_office_front","Derya_sitting_office_side","Derya_standing_indoor_front","Derya_standing_indoor_side","Derya_standing_office_front","Derya_standing_office_side","Dexter_Casual_Front_public","Dexter_Casual_Side_public","Dexter_Doctor_Sitting2_public","Dexter_Doctor_Standing2_public","Dexter_Lawyer_Sitting_public","Dexter_Suit_Front_public","Dexter_Suit_Side_public","Dexter_Winter_Coat_Front_public","Dexter_Winter_Coat_Side_public","Diana_public_20240315","Diana_public_2_20240315","Diana_public_3_20240315","Diora_public_1","Diora_public_2","Diora_public_3","Diora_public_4","Diora_public_5","Diran_Casual_Front_public","Diran_Casual_Side_public","Diran_Jacket_Front_public","Diran_Jacket_Side_public","Diran_Macbook_Business_Front_public","Diran_Macbook_Business_Side_public","Diran_Macbook_Casual_Front_public","Diran_Macbook_Casual_Side_public","Diran_Macbook_Sitting_Front2_public","Diran_Macbook_Sitting_Front_public","Diran_Macbook_Sitting_Side2_public","Diran_Macbook_Sitting_Side_public","Diran_Suit_Front_public","Diran_Suit_Side_public","Diran_iPad_Front_public","Diran_iPad_Side_public","Diran_iPad_Sitting_Front_public","Diran_iPad_Sitting_Side_public","Elenora_Casual_Front_public","Elenora_Casual_Side_public","Elenora_FitnessCoach2_public","Elenora_FitnessCoach_public","Elenora_IT_Sitting_public","Elenora_Suit_Front_public","Elenora_Suit_Side_public","Elenora_YellowDress_Front_public","Elenora_YellowDress_Side_public","Emanuel_sitting_Sofa_side","Emanuel_sitting_sofa_front","Emanuel_standing_office_front","Emanuel_standing_office_side","Emery_public_1","Emery_public_2","Emery_public_3","Emery_public_4","Emery_public_5","Emery_public_6","Emilia_sitting_outdooryoga2_front","Emilia_sitting_outdooryoga_front","Emilia_sitting_outdooryoga_side","Emilia_sitting_picnic_front","Emilia_sitting_picnic_side","Emilia_standing_outdoorbusiness_front","Emilia_standing_outdoorbusiness_side","Eric_public_lite1_20230601","Eric_public_pro1_20230601","Eric_public_pro2_20230608","Esmond_public_1","Esmond_public_2","Esmond_public_3","Esmond_public_4","Esmond_public_5","Fernando_sitting_businessindoor_front","Fernando_sitting_businessindoor_side","Fernando_sitting_outdoorchair_front","Fernando_sitting_outdoorchair_front_close","Fernando_sitting_outdoorchair_side","Fernando_sitting_outdoortable_front","Fernando_sitting_outdoortable_side","Fernando_standing_outdoor_front","Fernando_standing_outdoor_side","Fina_Business_Sitting_Front_public","Fina_Business_Sitting_Side_public","Fina_Casual_Front_2_public","Fina_Casual_Front_public","Fina_Casual_Side_2_public","Fina_Casual_Side_public","Fina_Casual_Sitting_Front_public","Fina_Casual_Sitting_Side_public","Fina_Denim_Front_public","Fina_Denim_Side_public","Fina_Denim_Sitting_Front_public","Fina_Employee_Front_public","Fina_Employee_Side_public","Fina_Suit_Front_public","Fina_Suit_Side_public","Fina_Support_Front_public","Fina_Support_Side_public","Florin_Business_Sitting_Front_public","Florin_Business_Sitting_Side_public","Florin_Maintain_Front_2_public","Florin_Maintain_Front_public","Florin_Maintain_Side_2_public","Florin_Maintain_Side_public","Florin_Maintain_Siiting_Front_public","Florin_Maintain_Siiting_Side_public","Florin_Suit_Front_2_public","Florin_Suit_Front_public","Florin_Suit_Side_2_public","Florin_Suit_Side_public","Francis_in_Blazer_Front","Francis_in_Blazer_Left","Francis_in_Blazer_Right","Francis_in_Doctor_Front","Francis_in_Doctor_Left","Francis_in_Doctor_Right","Francis_in_Shirt_Front","Francis_in_Shirt_Left","Francis_in_Shirt_Right","Fred_in_Blue_Long_Shirt_Front","Fred_in_Blue_Long_Shirt_Left","Fred_in_Blue_Long_Shirt_Right","Fred_in_Blue_Short_Shirt_Front","Fred_in_Blue_Short_Shirt_Left","Fred_in_Blue_Short_Shirt_Right","Freja_public_1","Freja_public_2","Freja_public_3","Freja_public_5","Freja_public_6","Gabriel_public_20240308","Gabriel_public_2_20240308","Gabriel_public_3_20240308","Gala_lying_bedroom_front","Gala_lying_sofa_front","Gala_lying_sofa_side","Gala_sitting_businesssofa_front","Gala_sitting_businesssofa_side","Gala_sitting_casualsofawithipad_front","Gala_sitting_casualsofawithipad_side","Gala_sitting_casualsofawithipad_side_close","Gala_sitting_office_front","Gala_sitting_office_side","Gala_sitting_sofa_front","Gala_sitting_sofa_front_close","Gala_sitting_sofa_side","Gala_sitting_sofa_side_close","Gala_standing_businesssofa_front","Gala_standing_businesssofa_front_close","Gala_standing_businesssofa_side","Gala_standing_businesssofa_side_close","Georgia_expressive_2024112701","Georgia_sitting_office_front","Georgia_sitting_office_side","Georgia_standing_casual_front","Georgia_standing_casual_side","Gerardo_sitting_indoor_front","Gerardo_sitting_indoor_side","Gerardo_sitting_sofa_front","Gerardo_sitting_sofa_side","Gerardo_standing_nightscene2_front","Gerardo_standing_nightscene_front","Gerardo_standing_outdoorsport_front","Gerardo_standing_outdoorsport_side","Giulia_sitting_office_front","Giulia_sitting_office_side","Giulia_sitting_sofa_front","Giulia_sitting_sofa_side","Giulia_standing_office_front","Giulia_standing_office_side","Giulia_standing_sofa_front","Giulia_standing_sofa_side","Hada_Casual_Cup_Front_public","Hada_Casual_Cup_Side_public","Hada_Casual_Front_public","Hada_Casual_Side_public","Hada_Casual_Sitting_Front_2_public","Hada_Casual_Sitting_Front_public","Hada_Casual_Sitting_Side_2_public","Hada_Casual_Sitting_Side_public","Hada_LivelyGestures_Front_public","Hada_LivelyGestures_Side_public","Hada_LivelyGestures_Sitting_Front_public","Hada_LivelyGestures_Sitting_Side_public","Hada_Suit_Front_2_public","Hada_Suit_Front_public","Hada_Suit_Side2_public","Hada_Suit_Side_public","Hada_Suit_Sitting_Front_2_public","Hada_Suit_Sitting_Front_public","Hada_Suit_Sitting_Side_public","Harrison_public_20240313","Harrison_public_2_20240313","Harrison_public_3_20240313","Ian_public_20240315","Ian_public_2_20240315","Ian_public_3_20240315","Ida_sitting_lounge_front","Ida_sitting_lounge_side","Ida_sitting_sofa_front","Ida_sitting_sofa_side","Ida_standing_lounge_front","Ida_standing_lounge_side","Ida_standing_sofa_front","Ida_standing_sofa_side","Iker_public_1","Iker_public_2","Iker_public_3","Iker_public_4","Iker_public_5","Imelda_BizTalk_Front_public","Imelda_BizTalk_Side_public","Imelda_Business_Front_public","Imelda_Business_Side_public","Imelda_Business_Sitting_Front_2_public","Imelda_Business_Sitting_Front_public","Imelda_Business_Sitting_Side_2_public","Imelda_Business_Sitting_Side_public","Imelda_Casual_Front_public","Imelda_Casual_Side_public","Imelda_Coat_Front_2_public","Imelda_Coat_Front_public","Imelda_Coat_Side_public","Imelda_Customer_Support_Front_public","Imelda_Customer_Support_Side_public","Imelda_Full_Side_public","Imelda_Suit_Front_public","Imelda_Suit_Side_public","Ivan_public_20240312","Ivan_public_2_20240312","Ivan_public_3_20240312","Ivan_public_4_20240312","Jason_public_20240312","Jason_public_2_20240312","Jason_public_3_20240312","Javi_Intense_Sitting_Speaking_Front_public","Javi_Intense_Sitting_Speaking_Side_public","Javi_Intense_Sitting_Speaking_public","Javi_Intense_Speaking_Front_2_public","Javi_Intense_Speaking_Front_3_public","Javi_Intense_Speaking_Front_public","Javi_Intense_Speaking_Side_3_public","Javi_Intense_Speaking_Side_public","Javi_in_Passionate_Gestures_2_public","Javi_in_Passionate_Gestures_3_public","Javi_in_Passionate_Gestures_public","Jin_Blue_Casual_Front_public","Jin_Blue_Casual_Side_public","Jin_Business_Coffee_Mode_Front_public","Jin_Business_Coffee_Mode_Side_public","Jin_Business_Sitting_Front_public","Jin_Business_Sitting_Side_public","Jin_Casual_Coffee_Mode_Front_public","Jin_Casual_Coffee_Mode_Side_public","Jin_Casual_Sitting_Front_public","Jin_Casual_Sitting_Side_public","Jin_Suit_Front_public","Jin_Suit_Side_public","Jin_Vest_Front_public","Jin_Vest_Side_public","Jin_Vest_Sitting_Front_public","Jin_Vest_Sitting_Side_public","Jin_expressive_2024112501","Jin_in_Education_Front_public","Jin_in_Education_Side_public","Jinwoo_public_1","Jinwoo_public_2","Jinwoo_public_3","Jinwoo_public_4","Jinwoo_public_5","Jocelyn_sitting_office_front","Jocelyn_sitting_office_side","Jocelyn_sitting_sofa_front","Jocelyn_sitting_sofa_side","Jocelyn_standing_office_front","Jocelyn_standing_office_side","Jocelyn_standing_sofa_front","Jocelyn_standing_sofa_side","Joel_sitting_couch_front","Joel_sitting_couch_side","Joel_standing_gym_front","Joel_standing_gym_side","Joel_standing_mountain_front","Joel_standing_mountain_side","Jonas_expressive_2024112701","Jonas_sitting_gym_front","Jonas_sitting_gym_side","Jonas_standing_gym_front","Jonas_standing_gym_side","Juan_sitting_office_front","Juan_sitting_office_side","Juan_sitting_sofa_front","Juan_sitting_sofa_side","Juan_sitting_sofacasual_front","Juan_standing_office_front","Juan_standing_office_side","Juan_standing_sofa_front","Juan_standing_sofa_side","Juan_standing_sofacasual_front","Judita_expressive_2024112701","Judita_sitting_yoga_front","Judita_sitting_yoga_side","Judita_standing_yoga_front","Judita_standing_yoga_side","Judith_Business_Front2_public","Judith_Business_Front_public","Judith_Business_Sitting_Front_public","Judith_Casual_Front_public","Judith_Casual_Sitting_Front_public","Judith_Suit_Front_public","Judith_expressive_2024120201","Judy_Business_Front_public","Judy_Business_Side_public","Judy_Business_Sitting_Front_public","Judy_Casual_Front_public","Judy_Casual_Side_public","Judy_Casual_Sitting_public","Judy_ConfidentSpeaking_Front_public","Judy_ConfidentSpeaking_Side_public","Judy_Doctor_Sitting2_public","Judy_Doctor_Standing2_public","Judy_Lawyer_Sitting2_public","Judy_NurseSitting_Front_2_public","Judy_NurseSitting_Front_public","Judy_NurseSitting_Side_2_public","Judy_NurseSitting_Side_public","Judy_Nurse_Front2_public","Judy_Nurse_Front_public","Judy_Nurse_OnDuty_Front_public","Judy_Nurse_OnDuty_Side_public","Judy_Nurse_Side2_public","Judy_Nurse_Side_public","Judy_Suit_Front_public","Judy_Suit_Side_public","Judy_Teacher_Sitting2_public","Judy_Teacher_Sitting_public","Judy_Teacher_Standing_public","June_HR_public","June_expressive_2024112701","June_sitting_office_front","June_sitting_office_side","June_sitting_sofacasual_side","June_standing_office_side","June_standing_sofacasual_side","Justin_public_20240308","Justin_public_2_20240308","Justin_public_3_20240308","Justo_Business_Front_2_public","Justo_Business_Front_public","Justo_Business_Side_2_public","Justo_Business_Side_public","Justo_Casual_Sitting_public","Justo_CustomerService_Front_2_public","Justo_CustomerService_Front_public","Justo_CustomerService_Side_public","Justo_CustomerService_Sitting_Front_public","Justo_CustomerService_Sitting_Side_public","Justo_EmployeeTraining_Front_public","Justo_Suit_Casual_Front_public","Justo_Suit_Casual_Side_public","Karolin_public_20230109","Karolin_public_2_20230109","Karolin_public_3_20230109","Kavya_sitting_sofa_front","Kavya_sitting_sofa_side","Kavya_standing_indoor_front","Kavya_standing_indoor_side","Kavya_standing_outdoor_side","Kavya_standing_outdoorsport_front","Kavya_standing_outdoorsport_side","Kelly_Blue_Shirt_Front","Kelly_Blue_Shirt_Left","Kelly_Blue_Shirt_Right","Kelly_Doctor_Front","Kelly_Doctor_Left","Kelly_Doctor_Right","Kelly_Pink_Shirt_Front","Kelly_Pink_Shirt_Left","Kelly_Pink_Shirt_Right","Klara_public_1","Klara_public_2","Klara_public_3","Klara_public_4","Klara_public_5","Klara_public_6","Kristin_public_20240108","Kristin_public_2_20240108","Kristin_public_3_20240108","Leos_sitting_office_front","Leos_sitting_office_side","Leos_sitting_sofa_front","Leos_sitting_sofa_side","Leos_standing_office_front","Leos_standing_office_side","Leos_standing_sofa_front","Leos_standing_sofa_side","Leszek_sitting_lounge_front","Leszek_sitting_lounge_side","Leszek_sitting_sofa_front","Leszek_sitting_sofa_side","Leszek_standing_outdoorbusiness_front","Leszek_standing_outdoorbusiness_side","Leszek_standing_outdoorcasual_front","Leszek_standing_outdoorcasual_side","Lily_public_lite1_20230601","Lily_public_pro1_20230614","Lina_Casual_Front_2_public","Lina_Casual_Front_public","Lina_Casual_Side_2_public","Lina_Casual_Side_public","Lina_Casual_Sitting_Front_public","Lina_Casual_Sitting_Side_public","Lina_Dress_Front_public","Lina_Dress_Side_2_public","Lina_Dress_Side_public","Lina_Dress_Sitting_Front_public","Lina_Dress_Sitting_Side_public","Lina_Sweater_Front_2_public","Lina_Sweater_Front_public","Lina_Sweater_Side_2_public","Lina_Sweater_Side_public","Lina_Sweater_Sitting_Front_2_public","Lina_Sweater_Sitting_Front_public","Lina_Sweater_Sitting_Side_2_public","Lina_Sweater_Sitting_Side_public","Lisa_public","Luca_public","Lucien_public_1","Lucien_public_2","Lucien_public_3","Lucien_public_4","Lucien_public_5","Lucien_public_6","Luke_public_20240306","Luke_public_2_20240306","Luke_public_3_20240306","Marcus_Casual_Front_public","Marcus_Casual_Side_public","Marcus_Casual_Sitting_Front_2_public","Marcus_Casual_Sitting_Front_public","Marcus_Casual_Sitting_Side_2_public","Marcus_Casual_Sitting_Side_public","Marcus_Coffee_Front_2_public","Marcus_Coffee_Front_public","Marcus_Coffee_Side_2_public","Marcus_Coffee_Side_public","Marcus_Denim_Jacket_Front_public","Marcus_Denim_Jacket_Side_public","Marcus_Education_Front_public","Marcus_Education_Side_public","Marcus_Sitting_Front_public","Marcus_Sitting_Side_public","Marcus_Suit_Front_public","Marcus_Suit_Side_public","Marcus_expressive_2024120201","Maria_public_20240111","Maria_public_2_20240111","Maria_public_3_20240111","Martina_sitting_office_front","Martina_sitting_office_side","Martina_sitting_sofa_front","Martina_sitting_sofa_side","Martina_standing_office_front","Martina_standing_office_side","Martina_standing_sofa_front","Martina_standing_sofa_side","Masha_sitting_office_front","Masha_sitting_office_side","Masha_sitting_sofacasual_front","Masha_sitting_sofacasual_side","Masha_standing_office_front","Masha_standing_office_side","Masha_standing_sofacasual_front","Masha_standing_sofacasual_side","Mason_public_20240304","Mason_public_2_20240304","Mason_public_3_20240304","Matteo_sitting_office_front","Matteo_sitting_office_side","Matteo_sitting_sofa_front","Matteo_sitting_sofa_side","Matteo_standing_office_front","Matteo_standing_office_side","Matteo_standing_sofa_front","Matteo_standing_sofa_side","Max_expressive_2024112701","Max_sitting_indoor_front","Max_sitting_indoor_side","Max_standing_outdoorsport_front","Max_standing_outdoorsport_side","Mido-lite-20221128","Mido-pro-flowershirt-20221208","Mido-pro-greysweater-20221209","Mido-pro-insuit-20221208","Milena_sitting_office_front","Milena_sitting_office_side","Milena_sitting_sofa_front","Milena_sitting_sofa_side","Milena_standing_office_front","Milena_standing_office_side","Milena_standing_sofa_front","Milena_standing_sofa_side","Miles_expressive_2024112701","Miles_sitting_sofa_front","Miles_sitting_sofa_side","Miles_standing_outdoor_front","Miles_standing_outdoor_side","Miles_standing_sofa_front","Miles_standing_sofa_side","Minho_public_1","Minho_public_2","Minho_public_3","Minho_public_4","Minho_public_5","Minho_public_6","Mireia_sitting_businessindoor_front","Mireia_sitting_businessindoor_side","Mireia_sitting_outdoorchair_front","Mireia_sitting_outdoortable_front","Mireia_sitting_outdoortable_side","Mireia_standing_outdoor_front","Mireia_standing_outdoor_side","Miyu_sitting_office_front","Miyu_sitting_office_side","Miyu_sitting_sofabusiness_front","Miyu_sitting_sofabusiness_side","Miyu_sitting_sofacasual_front","Miyu_sitting_sofacasual_side","Miyu_standing_office_front","Miyu_standing_office_side","Miyu_standing_sofacasual_front","Miyu_standing_sofacasual_side","Nadim_public_1","Nadim_public_2","Nadim_public_3","Nadim_public_4","Nadim_public_5","Neil_public_20240328","Neil_public_2_20240328","Neil_public_3_20240328","Nico_public","Noah_sitting_lobby_front","Noah_sitting_lobby_side","Noah_sitting_office_front","Noah_sitting_office_side","Noah_sitting_sofa_front","Noah_sitting_sofa_side","Noah_standing_lobby_front","Noah_standing_lobby_side","Noah_standing_office_front","Noah_standing_office_side","Noah_standing_sofa_front","Noah_standing_sofa_side","Nour_public_1","Nour_public_2","Nour_public_3","Nour_public_4","Nour_public_5","Odelia_public_20240326","Odelia_public_2_20240326","Odelia_public_3_20240326","Onat_Casual_Front_public","Onat_Casual_Side_public","Onat_Casual_Sitting_Front_public","Onat_Casual_Sitting_Side_public","Onat_Macbook_Front2_public","Onat_Macbook_Front_public","Onat_Macbook_Side2_public","Onat_Macbook_Side_public","Onat_Suit_Front_public","Onat_Suit_Side_public","Onat_Suit_Sitting_Front_public","Onat_Suit_Sitting_Side_public","Onat_expressive_2024120201","Onat_iPad_Front_public","Onat_iPad_Side_public","Onat_iPad_Sitting_Front_public","Onat_iPad_Sitting_Side_public","Oxana_2_expressive_2024112701","Oxana_expressive_2024112701","Oxana_sitting_gym_front","Oxana_sitting_gym_side","Oxana_sitting_office_front","Oxana_sitting_office_side","Oxana_sitting_sofa_front","Oxana_sitting_sofa_side","Oxana_sitting_yoga_front","Oxana_sitting_yoga_side","Oxana_standing_gym_front","Oxana_standing_gym_side","Oxana_standing_office_front","Oxana_standing_office_side","Oxana_standing_sofa_front","Oxana_standing_sofa_side","Oxana_standing_yoga_front","Oxana_standing_yoga_side","Patrizio_sitting_office_front","Patrizio_sitting_office_side","Patrizio_sitting_sofa_front","Patrizio_sitting_sofa_side","Patrizio_standing_businesstraining_front","Patrizio_standing_businesstraining_side","Patrizio_standing_office_side","Piper_sitting_businesssofa_front","Piper_sitting_businesssofa_side","Piper_standing_education_front","Piper_standing_education_side","Rasmus_sitting_lounge_front","Rasmus_sitting_lounge_side","Rasmus_sitting_sofa_front","Rasmus_sitting_sofa_side","Rasmus_standing_lounge_front","Rasmus_standing_lounge_side","Rasmus_standing_sofa_front","Rasmus_standing_sofa_side","Raul_Sitting_businesssofa_front","Raul_Sitting_businesssofa_front_close","Raul_expressive_2024112501","Raul_sitting_businesssofa_side","Raul_sitting_casualsofanoipad_front","Raul_sitting_casualsofanoipad_side","Raul_sitting_casualsofawithipad_front","Raul_sitting_casualsofawithipad_side","Raul_sitting_office_front","Raul_sitting_office_side","Raul_sitting_sofa_front","Raul_sitting_sofa_front_close","Raul_sitting_sofa_side","Raul_sitting_sofa_side_close","Raul_standing_businesssofa_side","Raul_standing_casualsofa_front","Raul_standing_casualsofa_front_close","Raul_standing_casualsofa_side","Raul_standing_casualsofa_side_close","Raul_standing_office_front","Rebecca_public","Ren_expressive_2024112701","Ren_sitting_office_front","Ren_sitting_office_side","Ren_sitting_sofabusiness_front","Ren_sitting_sofabusiness_side","Ren_sitting_sofacasual_front","Ren_sitting_sofacasual_side","Ren_standing_office_front","Ren_standing_office_side","Ren_standing_sofacasual_front","Ren_standing_sofacasual_side","Riley_expressive_2024112501","Riley_siting_casual_front","Riley_sitting_casual_side","Riley_sitting_office_front","Riley_sitting_office_side","Roman_standing_outdoorsport_front","Roman_standing_outdoorsport_side","Sabine_sitting_office_front","Sabine_sitting_sofa_side","Sabine_standing_office_front","Sabine_standing_office_side","Salma_headscarf_Front","Salma_headscarf_Left","Salma_headscarf_Right","SantaAvatar_Sitting_public","Santa_Avatar_Present_Standing_public","Santa_Avatar_Sitting_2_public","Santa_Avatar_Sitting_Side_public","Santa_Avatar_Standing_public","Santa_Fireplace_Front_public","Santa_Fireplace_Side_public","Saskia_public_1","Saskia_public_2","Saskia_public_3","Saskia_public_4","Saskia_public_5","Scarlett_siiting_fireplace_front","Scarlett_sitting_couch2_front","Scarlett_sitting_couch2_side","Scarlett_sitting_couch_front","Scarlett_sitting_couch_side","Scarlett_sitting_fireplace_side","Scarlett_sitting_yoga_front","Scarlett_sitting_yoga_side","Scarlett_standing_hall_front","Scarlett_standing_hall_side","Seema_Business_Front_public","Seema_Business_Side_public","Seema_Business_Sitting_Side_public","Seema_Casual_Front_public","Seema_Casual_Side_public","Seema_Casual_Sitting_Front_public","Seema_Casual_Sitting_Side_public","Seema_Nurse_Front_2_public","Seema_Nurse_Front_public","Seema_Nurse_Side_2_public","Seema_Nurse_Side_public","Shawn_Business_Front_public","Shawn_Business_Side_public","Shawn_Casual_Sitting_Front_public","Shawn_Casual_Sitting_Side_public","Shawn_Sitting_Front_public","Shawn_Sitting_Side_public","Shawn_Suit_Front_public","Shawn_Suit_Side_public","Shawn_Therapist_public","Shirley_Business_Front_public","Shirley_Business_Side_public","Shirley_Casual_Front_2_public","Shirley_Casual_Front_public","Shirley_Casual_Side_public","Shirley_Casual_Sitting_Front_2_public","Shirley_Casual_Sitting_Front_public","Shirley_Casual_Sitting_Side_2_public","Shirley_Casual_Sitting_Side_public","Shirley_Education_Front_public","Shirley_Education_Side_2_public","Shirley_Education_Side_public","Shirley_Sitting_Front_public","Shirley_Sitting_Side_public","Shirley_Skirt_Front_public","Shirley_Skirt_Side_public","Shirley_Suit_Front_public","Shirley_Suit_Side_public","SilasHR_public","Silas_CustomerSupport_public","Silas_expressive_2024120201","Silas_sitting_lounge_front","Silas_sitting_lounge_side","Silas_sitting_sofa_side","Silas_sitting_sofa_side_close","Sloane_public_2","Sloane_public_4","Sloane_public_5","Sophia_public_20240320","Sophia_public_2_20240320","Sophia_public_3_20240320","Sophie_public","Stacy_in_Doctor_Front","Stacy_in_Doctor_Left","Stacy_in_Doctor_Right","Stacy_in_Dress_Front","Stacy_in_Dress_Left","Stacy_in_Dress_Right","Stacy_in_Shirt_Front","Stacy_in_Shirt_Left","Stacy_in_Shirt_Right","Susan_public_20240328","Susan_public_2_20240328","Susan_public_3_20240328","Tahlia_public_1","Tahlia_public_2","Tahlia_public_3","Tahlia_public_4","Tahlia_public_5","Teodor_expressive_2024112701","Teodor_sitting_office_front","Teodor_sitting_office_side","Teodor_sitting_sofa_front","Teodor_sitting_sofa_side","Teodor_standing_office_front","Teodor_standing_office_side","Teodor_standing_sofa_front","Teodor_standing_sofa_side","Timothy_expressive_2024112701","Timothy_sitting_casual_front","Timothy_sitting_casual_side","Timothy_sitting_office_front","Timothy_sitting_office_side","Tito_Casual_Front_2_public","Tito_Casual_Front_public","Tito_Casual_Side_2_public","Tito_Casual_Side_public","Tito_Casual_Sitting_Front_public","Tito_Casual_Sitting_Side_public","Tito_Coat_Front_2_public","Tito_Coat_Front_public","Tito_Coat_Full_Side_public","Tito_Coat_Side_2_public","Tito_Coat_Side_public","Tito_Painter_Front_public","Tito_Painter_Full_Side_public","Tito_Painter_Side_public","Tito_Painter_Sitting_Front_public","Tito_Painter_Sitting_Side_public","Travis_public_20240301","Travis_public_2_20240301","Travis_public_3_20240301","Trevor_public_20240409","Trevor_public_2_20240409","Trevor_public_3_20240409","Trevor_public_4_20240409","Tuba_Business_Chair_Front_public","Tuba_Business_Chair_Side_public","Tuba_Business_Front_public","Tuba_Business_Side_public","Tuba_Business_Sofa_Front_public","Tuba_Business_Sofa_Side_public","Tuba_Casual_Front_public","Tuba_Casual_Side_public","Tuba_Casual_Sitting_Front_public","Tuba_Casual_Sitting_Side_public","Tuba_Macbook_Front_public","Tuba_Macbook_Side_public","Tyler-incasualsuit-20220721","Tyler-inshirt-20220721","Tyler-insuit-20220721","Veit_sitting_sofa_front","Veit_sitting_sofa_side","Veit_standing_office_front","Veit_standing_office_side","Vemon_sitting_office_front","Vemon_sitting_office_side","Vemon_standing_office_front","Vemon_standing_office_side","Verena_sitting_sofa_front","Verena_sitting_sofa_side","Verena_standing_office_front","Verena_standing_office_side","Vernon_expressive_2024112501","Vernon_sitting_lounge_side","Vernon_standing_lounge_front","Vernon_standing_lounge_side","Vince_expressive_2024112701","Vince_sitting_businesssofa_front","Vince_sitting_businesssofa_side","Vince_sitting_sofacasual_front","Vince_sitting_sofacasual_side","Vince_standing_businesstraining_front","Vince_standing_businesstraining_side","Vince_standing_sofacasual_front","Vince_standing_sofacasual_side","Violante_Brown_Suit_Front_2_public","Violante_Brown_Suit_Front_public","Violante_Business_Sitting_Front_public","Violante_Business_Sitting_Side_public","Violante_Casual_Sitting_Front_public","Violante_Casual_Sitting_Side_public","Violante_Sport_Front_2_public","Violante_Sport_Front_public","Violante_Sport_Side_public","Violante_Sport_Sitting_Side_public","Violante_Suit_Front_public","Vivianna_public_20230110","Wade_public_20240228","Wade_public_2_20240228","Wade_public_3_20240228","Yola_Active_Speaking_Front_public","Yola_Active_Speaking_Side_public","Yola_Business_Front_public","Yola_Business_Side_public","Yola_Calm_Speaking_Front_public","Yola_Calm_Speaking_Side_public","Yola_Casual_Front_public","Yola_Casual_Side_public","Yola_Employee_Badge_Front_public","Yola_Employee_Badge_Side_public","Zosia_public_1","Zosia_public_2","Zosia_public_3","Zosia_public_4","Zosia_public_5","candace_expressive_20240910","chad_expressive_20240910","francis_expressive_20240910","nik_blue_expressive_20240910","nik_expressive_20240910"],"description":"HeyGen avatar ID for a photo or video avatar."}}},"positivePrompt":{"type":"string","description":"Text prompt describing elements to include in the generated output. Documented range: 1 to 10,000 characters."},"width":{"type":"integer","default":1280,"description":"Width of the generated media in pixels."},"height":{"type":"integer","default":720,"description":"Height of the generated media in pixels."},"duration":{"type":"integer","examples":[5],"description":"Length of the generated video in seconds. The total number of frames produced is determined by duration multiplied by the model's frame rate (fps). Documented range: 5 to 300."},"outputType":{"type":"string","enum":["URL"],"default":"URL","description":"Video output type."},"outputFormat":{"type":"string","enum":["MP4","WEBM","MOV"],"default":"MP4","description":"Specifies the file format of the generated output. The available values depend on the task type and the specific model's capabilities. - \\`JPG\\`: Best for photorealistic images with smaller file sizes (no transparency). - \\`PNG\\`: Lossless compression, supports high quality and transparency (alpha channel). - \\`WEBP\\`: Modern format providing superior compression and transparency support. - \\`MP4\\`: Widely supported video container (H.264), recommended for general use. - \\`WEBM\\`: Optimized for web delivery. - \\`MOV\\`: QuickTime format, common in professional workflows (Apple ecosystem). - \\`GIF\\`: Animated image format (no audio), suitable for short loops or previews. - \\`MP3\\`: Compressed audio, smaller file size. - \\`WAV\\`: Uncompressed, high-quality audio. - \\`FLAC\\`: Lossless compression. - \\`OGG\\`: Open-source compressed audio format (Vorbis codec). - \\`SVG\\`: Scalable Vector Graphics. - \\`TIFF\\`: High-quality output supporting layers. - \\`GLB\\`: Binary glTF format for 3D models, including geometry, textures, and PBR materials. > [!NOTE] > \\*\\*Transparency\\*\\*: If you are using features like background removal or LayerDiffuse that require transparency, you must select a format that supports an alpha channel (e.g., \\`PNG\\`, \\`WEBP\\`, \\`TIFF\\`). \\`JPG\\` does not support transparency."},"outputQuality":{"type":"integer","default":95,"description":"Compression quality of the output. Higher values preserve quality but increase file size. Documented range: 20 to 99."},"safety":{"type":"object","properties":{"checkContent":{"type":"boolean","description":"Enable or disable content safety checking. Increases total generation time. Always on: a false is sent as true."},"mode":{"type":"string","enum":["fast","full"],"default":"fast","description":"Safety checking mode for video generation. Only `fast` or `full` is sent here: any other value is sent as `fast`."}}},"idempotency_key":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9._-]{1,64}$","description":"Your own name for this request. Send the same one twice and the second call is answered with the first request rather than charged again. `Idempotency-Key:` as a header is accepted as an alias — that is the spelling a retrying proxy replays, and the one to use when running a model on `auray.run`, where a request that outlives its connection is answered 504 and recovered by replay. Omit it and the platform mints one."}},"required":["positivePrompt"],"additionalProperties":false,"x-auray-rules":[{"dependentRequired":{"width":["height"],"height":["width"]}},{"if":{"anyOf":[{"required":["width"]},{"required":["height"]}]},"then":{"oneOf":[{"title":"720p (16:9)","properties":{"width":{"const":1280},"height":{"const":720}}},{"title":"720p (9:16)","properties":{"width":{"const":720},"height":{"const":1280}}}]}}],"description":"The model's own fields, in the shape the model reads them, plus `idempotency_key`. Rules across fields, as the model's documentation states them, judged by this API before any charge (warned with a Deprecation header until enforcement starts): (1) Send `height` whenever `width` is sent. Send `width` whenever `height` is sent. (2) When `width` is sent or `height` is sent, `width` and `height` must be one of these: 720p (16:9): width 1280, height 720; 720p (9:16): width 720, height 1280."},"QueueStatus":{"oneOf":[{"type":"object","title":"IN_QUEUE","properties":{"status":{"type":"string","const":"IN_QUEUE"},"request_id":{"type":"string","description":"This request's job reference — `<product>_<your idempotency key>`. It is the id every other address on this platform takes, and it is what the three URLs below are built from. The id of the HTTP call itself is in `X-Request-Id` (and `x-fal-request-id` beside it)."},"job_id":{"type":"string","description":"The same job reference under the one name every host uses for it — `id` on `/v1`. `request_id` is the queue protocol's name for it on this host, and means the HTTP call on every other body this API sends."},"logs":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"timestamp":{"type":"string"}},"required":["message","timestamp"]},"description":"Empty unless `?logs=1` asked for them, and empty is a statement."},"metrics":{"type":"object","properties":{"inference_time":{"type":"number","description":"Seconds spent computing, when the runner reported it."}},"description":"`{}` when nothing was reported, which is what the queue protocol sends and what its clients test for."},"give_up_after_seconds":{"type":"integer","description":"Present while the request is open: the longest it may take from its submit — the longest it may wait to start plus the longest it may run before it is stopped and refunded, the figure the submit answered. Waiting longer is waiting for nothing; the official clients wait this long by default."},"queue_position":{"type":"integer","description":"How many requests are ahead of this one. `0` on a read today: the read path looks a job up by credit key and never selects the row id a position needs."}},"required":["status","request_id","job_id","logs","metrics","queue_position"]},{"type":"object","title":"IN_PROGRESS","properties":{"status":{"type":"string","const":"IN_PROGRESS"},"request_id":{"type":"string","description":"This request's job reference — `<product>_<your idempotency key>`. It is the id every other address on this platform takes, and it is what the three URLs below are built from. The id of the HTTP call itself is in `X-Request-Id` (and `x-fal-request-id` beside it)."},"job_id":{"type":"string","description":"The same job reference under the one name every host uses for it — `id` on `/v1`. `request_id` is the queue protocol's name for it on this host, and means the HTTP call on every other body this API sends."},"logs":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"timestamp":{"type":"string"}},"required":["message","timestamp"]},"description":"Empty unless `?logs=1` asked for them, and empty is a statement."},"metrics":{"type":"object","properties":{"inference_time":{"type":"number","description":"Seconds spent computing, when the runner reported it."}},"description":"`{}` when nothing was reported, which is what the queue protocol sends and what its clients test for."},"give_up_after_seconds":{"type":"integer","description":"Present while the request is open: the longest it may take from its submit — the longest it may wait to start plus the longest it may run before it is stopped and refunded, the figure the submit answered. Waiting longer is waiting for nothing; the official clients wait this long by default."}},"required":["status","request_id","job_id","logs","metrics"]},{"type":"object","title":"COMPLETED","properties":{"status":{"type":"string","const":"COMPLETED"},"request_id":{"type":"string","description":"This request's job reference — `<product>_<your idempotency key>`. It is the id every other address on this platform takes, and it is what the three URLs below are built from. The id of the HTTP call itself is in `X-Request-Id` (and `x-fal-request-id` beside it)."},"job_id":{"type":"string","description":"The same job reference under the one name every host uses for it — `id` on `/v1`. `request_id` is the queue protocol's name for it on this host, and means the HTTP call on every other body this API sends."},"logs":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"timestamp":{"type":"string"}},"required":["message","timestamp"]},"description":"Empty unless `?logs=1` asked for them, and empty is a statement."},"metrics":{"type":"object","properties":{"inference_time":{"type":"number","description":"Seconds spent computing, when the runner reported it."}},"description":"`{}` when nothing was reported, which is what the queue protocol sends and what its clients test for."},"error":{"type":["string","null"],"description":"The failure code, or `null` when the request produced its output."},"error_type":{"type":["string","null"],"enum":["AuthenticationError","PermissionError","PaymentError","ValidationError","ContentPolicyError","PayloadTooLargeError","NotFoundError","GoneError","ConflictError","CancellationError","PreconditionError","RegionError","RateLimitError","CapacityError","ConfigurationError","TimeoutError","UpstreamError","ExecutionError","InternalError","NotImplementedError",null],"description":"The class of the failure, or `null`. One of twenty; the code is in `error`."}},"required":["status","request_id","job_id","logs","metrics","error","error_type"]}],"discriminator":{"propertyName":"status"}},"Error":{"type":"object","properties":{"error":{"type":"string","description":"The code. Every one is explained at https://auray.ai/docs/api/errors."},"error_type":{"type":"string","enum":["AuthenticationError","PermissionError","PaymentError","ValidationError","ContentPolicyError","PayloadTooLargeError","NotFoundError","GoneError","ConflictError","CancellationError","PreconditionError","RegionError","RateLimitError","CapacityError","ConfigurationError","TimeoutError","UpstreamError","ExecutionError","InternalError","NotImplementedError"],"description":"The class of the code, also sent as the `X-Auray-Error-Type` header."},"message":{"type":"string","description":"What went wrong and what to do about it."},"detail":{"oneOf":[{"type":"string","description":"The same sentence as `message`. The queue protocol's key; its clients print it."},{"type":"array","description":"A refusal about the input, answered 422: one entry per problem, `loc` naming where it was spelt (`[\"query\", \"max_queue_length\"]`, `[\"header\", \"x-fal-request-timeout\"]`, or `[\"body\"]` when the parser reports no field).","items":{"type":"object","properties":{"loc":{"type":"array","items":{"type":"string"}},"msg":{"type":"string"},"type":{"type":"string","description":"The code, which is this platform's own taxonomy."}},"required":["loc","msg","type"]}}]},"docs":{"type":"string","description":"A link to this code's explanation."},"request_id":{"type":"string","description":"The HTTP call's id. Quote it."}},"required":["error","error_type","message","detail"]}}},"security":[{"apiKey":[]}],"request_id":"7a04b052-f87f-42f6-9211-c1d4004f82bf"}