@videosdk.live/server-sdk
    Preparing search index...

    Interface DeployAgentOptions

    Options for AgentsResource.deploy.

    interface DeployAgentOptions {
        agentId?: string;
        env?: Record<string, string>;
        envSecretName?: string;
        image: string | DeployImage;
        name: string;
        profile?: AgentComputeProfile;
        region?: string;
        scaling?: { max?: number; min?: number };
        versionTag?: string;
        webhook?: { endPoint: string; events: string[] };
    }
    Index
    agentId? env? envSecretName? image name profile? region? scaling? versionTag? webhook?
    agentId?: string

    Attach to an existing agentId. When omitted, a new one is generated.

    env?: Record<string, string>

    Environment variables for the agent. Stored as a secret attached to the deployment.

    envSecretName?: string

    Name for the generated env secret (auto-derived from name when omitted).

    image: string | DeployImage

    A container image — either a reference string (e.g. "registry.videosdk.live/acme/agent:1.4") or a full DeployImage object.

    name: string

    Deployment name.

    profile?: AgentComputeProfile

    Compute profile: "cpu-small" | "cpu-medium" | "cpu-large". Defaults to "cpu-small".

    region?: string

    Region. Defaults to us002.

    scaling?: { max?: number; min?: number }

    Replica scaling. max must be ≤ 50 and ≥ min; out-of-range values are rejected, not clamped.

    versionTag?: string
    webhook?: { endPoint: string; events: string[] }

    Session webhook. events is effectively required — an empty list delivers no events.

    Settings
    Member Visibility

    On This Page
    Properties