Interface AIVideoGenerationRunParams

The agent the call is made for, recorded as the run row's AgentID.

The agent run this call belongs to. MJ: AI Prompt Runs has no agent-run column, so it is recorded in the row's Messages, for reading only. To join the row to the run, use OnPromptRunCreated.

Keys by driver class, passed through as the base runner's apiKeys. A key reaches only the candidates of its own driver class. They rank as they do for chat prompts, just above the environment keys: a credential bound to the prompt-model, the model-vendor or the vendor, or a default credential of the vendor's credential type, wins over them.

Aspect ratio in width:height form (for example, '16:9', '9:16', '1:1', '4:5').

Optional signal for cancelling the request. The driver is responsible for honoring it: it passes the signal to the provider's SDK or HTTP call, so an aborted request is torn down rather than left running. A driver that stops because the signal fired reports the failure classified as Cancelled (see BuildCancellationErrorInfo), which is never failed over.

The user the run is made and recorded for. Required.

Passed through as the base runner's CredentialScope. 'RuntimeOnly' restricts the run to APIKeys: a candidate whose driver class has no key there is skipped, never run on the platform's credentials.

Requested output clip duration in seconds.

Optional timestamped keyframe images anchoring motion across the clip.

Generation mode selecting how input references/video are used.

Pins the model by ID. Failover then stays within that model's vendors. Leave it unset to let the carrier prompt's bindings choose.

Called with the run row's ID as soon as the row exists, before the model call: the hook an agent step uses to point its TargetLogID at the row. An error it throws is logged, never raised.

A parent MJ: AI Prompt Runs row, recorded as this run's ParentID.

Text prompt describing the scene, motion, and visual style to generate.

The MJ: AI Prompts row whose bindings choose the model and whose failover settings apply. Defaults to the runner's default carrier prompt, found by name.

Vendor-neutral quality tier ('draft' | 'standard' | 'high').

Optional reference images guiding subject, style, or initial frame.

Optional deterministic seed when supported by the provider.

Optional source video for 'VideoToVideo' or 'Continuation' modes.

A bound, in milliseconds, on each driver call, as AIPromptParams.timeoutMS bounds each chat call: every failover candidate gets its own. A call that runs longer fails with an AIPromptTimeoutError, which reads as a network error and so fails over. For audio a driver splits, the bound covers the whole transcription. Unset or not positive means no bound, unless the runner declares a DefaultPromptTimeoutMS.

The timeout is composed into the signal the driver is handed as its params' CancellationToken, so a request that times out is torn down by a driver that honors it, not left running.

Whether synchronized ambient/generated audio is requested with the video clip.