SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias CreateScriptRequest

    CreateScriptRequest: Message<"soulfire.v1.CreateScriptRequest"> & {
        description: string;
        edges: ScriptEdge[];
        instanceId: string;
        name: string;
        nodes: ScriptNode[];
        paused: boolean;
        quotas?: ScriptQuotas;
    }

    Request to create a new script.

    Type Declaration

    • description: string

      Optional description of what the script does.

      from field: string description = 3;

    • edges: ScriptEdge[]

      Initial edges for the script graph. Can be empty to create a blank script.

      from field: repeated soulfire.v1.ScriptEdge edges = 6;

    • instanceId: string

      The instance to create the script in. Format: UUID string.

      from field: string instance_id = 1;

    • name: string

      The human-readable name for the script.

      from field: string name = 2;

    • nodes: ScriptNode[]

      Initial nodes for the script graph. Can be empty to create a blank script.

      from field: repeated soulfire.v1.ScriptNode nodes = 5;

    • paused: boolean

      Whether the script should be created in paused state. If false (default), the script starts running immediately after creation.

      from field: bool paused = 7;

    • Optionalquotas?: ScriptQuotas

      Optional resource quotas for this script.

      from field: soulfire.v1.ScriptQuotas quotas = 8;

    from message soulfire.v1.CreateScriptRequest