@qtsurfer/api-client
    Preparing search index...

    Type Alias StartLiveRequest

    type StartLiveRequest = {
        description?: string;
        name?: string;
        params?: { [key: string]: unknown };
        relay?: boolean;
        sources: [LiveSource];
        visibility?: "private" | "public";
    }
    Index
    description? name? params? relay? sources visibility?
    description?: string
    name?: string
    params?: { [key: string]: unknown }

    Strategy parameters to start with. Opaque key/value pairs — see this strategy's own declaredProperties (from POST /strategy) for the keys it accepts.

    relay?: boolean

    Request that this run's signals be relayed over its WebSocket channel once it reaches the live stage — see the "Live execution" guide. Has no effect while the run is still in the sandbox stage, regardless of this value.

    sources: [LiveSource]
    visibility?: "private" | "public"

    A public run appears in GET /live/public and its signal channel accepts subscriptions from anyone, not only you.

    Settings
    Member Visibility

    On This Page
    Properties