SoulFire TypeScript SDK 2.10.3
    Preparing search index...
    DownloadRequest: Message<"soulfire.v1.DownloadRequest"> & {
        headers: HeaderPair[];
        instanceId: string;
        proxy?: ProxyProto;
        uri: string;
    }

    Request message for downloading content from a URL through the SoulFire server. This allows clients to fetch remote resources using the server's network connection, optionally through a proxy, which is useful for accessing resources that may be blocked or rate-limited from the client's network.

    Type Declaration

    • headers: HeaderPair[]

      Optional HTTP headers to include in the request to the target server. These headers are added on top of the default headers set by the server (Accept, Accept-Language, User-Agent). Custom headers can override defaults.

      from field: repeated soulfire.v1.HeaderPair headers = 3;

    • instanceId: string

      The UUID of the SoulFire instance to associate this download with. Used for permission checking - the caller must have DOWNLOAD_URL permission for this instance. Must be a valid UUID string (e.g., "550e8400-e29b-41d4-a716-446655440000").

      from field: string instance_id = 1;

    • Optionalproxy?: ProxyProto

      Optional proxy configuration for the download request. If not provided, the request will be made directly from the server. Supports HTTP, SOCKS4, and SOCKS5 proxies with optional authentication.

      from field: optional soulfire.v1.ProxyProto proxy = 4;

    • uri: string

      The URI to download content from. Must be a valid, fully-formed URI (e.g., "https://example.com/resource.json"). The server will make an HTTP GET request to this URI.

      from field: string uri = 2;

    from message soulfire.v1.DownloadRequest