Member Junction
    Preparing search index...

    Interface AIAvatarVideoRunParams

    Parameters for AIVideoRunner.RunAvatarVideo: the driver's own AvatarVideoParams (avatar, audio and background assets, layout and size), plus the runner's options.

    Avatar and asset IDs belong to one provider account, so pin ModelID (or use a prompt whose failover stays on one model) when more than one video model is bound.

    interface AIAvatarVideoRunParams {
        AgentID?: string;
        AgentRunID?: string;
        APIKeys?: AIAPIKey[];
        audioAssetId: string;
        avatarId: string;
        avatarStyle: string;
        CancellationToken?: AbortSignal;
        caption?: boolean;
        ContextUser: UserInfo;
        CredentialScope?: AICredentialScope;
        imageAssetId: string;
        ModelID?: string;
        offsetX: number;
        offsetY: number;
        OnPromptRunCreated?: (promptRunId: string) => void | Promise<void>;
        outputHeight: number;
        outputWidth: number;
        ParentRunID?: string;
        PromptID?: string;
        scale: number;
        TimeoutMS?: number;
        title: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    AgentID? AgentRunID? APIKeys? audioAssetId avatarId avatarStyle CancellationToken? caption? ContextUser CredentialScope? imageAssetId ModelID? offsetX offsetY OnPromptRunCreated? outputHeight outputWidth ParentRunID? PromptID? scale TimeoutMS? title

    Properties

    AgentID?: string

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

    AgentRunID?: string

    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.

    APIKeys?: AIAPIKey[]

    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.

    audioAssetId: string
    avatarId: string
    avatarStyle: string
    CancellationToken?: AbortSignal

    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.

    caption?: boolean

    Generate captions for the video if true, otherwise do not generate captions

    ContextUser: UserInfo

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

    CredentialScope?: AICredentialScope

    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.

    imageAssetId: string
    ModelID?: string

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

    offsetX: number
    offsetY: number
    OnPromptRunCreated?: (promptRunId: string) => void | Promise<void>

    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.

    outputHeight: number

    Height of the requested video such as 720 for 720 pixels

    outputWidth: number

    Width of the requested video such as 1280 for 1280 pixels

    ParentRunID?: string

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

    PromptID?: string

    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.

    scale: number
    TimeoutMS?: number

    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.

    title: string

    Title of the video for storage in the provider's history

    Settings

    Member Visibility

    On This Page

    Properties