Skip to main content
Use this to fetch the bytes behind a stored reference: a document attached to a test case, or any other URI this organization uploaded. datasets.download() calls this method for its own dataset file. To see it inside a whole workflow, see Evaluate Document Inputs.

Returns

Returns the path the file was saved to.

Example

Parameters

string | InputFile
required
The file to fetch: an InputFile read from test_case.input_files, or the URI of any file this organization uploaded.
string
default:"the current directory"
Directory to write into, created when it does not exist. Defaults to the current directory.
string
Name to save the file under. Defaults to the InputFile’s own filename, and otherwise to the name the object is stored at, which is a random id rather than the name the file was uploaded with.

Errors

A failed download raises instead of returning None, and the message never contains the presigned link.