Skip to content

briskapi.pull

Python · CLI

Download one of your recordings from your archive, verify it and make it the default source. Without output, downloads are cached.

Parameters

prefix str required

The recording's archive prefix, from briskapi.recordings().

output str | Path | None optional

Keep it in this folder instead of the cache.

Returns

Recording

The Recording.

API method
briskapi.pull(
    prefix: str,
    output: str | Path | None = None,
) -> Recording
Example usage
1
2
3
4
5
import briskapi

prefix = briskapi.recordings()[0]["prefix"]
rec = briskapi.pull(prefix)
print(rec)

1
brisk pull PREFIX --output recordings/s1
Example response (Python)Illustrative
Illustrative values: this call needs your broker's BRiSK, or your own uploads, to run.
Recording('/Users/you/.cache/brisk/archive/3f…/20261013/085800-153512-7c14…')