Reference for top-level functions in the Lume Python SDK.
LUME_API_KEY
environment variable.Parametersapi_key
(str): Your Lume API key.request_timeout
(int, optional): The timeout in seconds for API requests. Defaults to 60
.flow_version
(str): The name and version of the flow to execute (e.g., "my_flow:v2"
).source_path
(str): A unique identifier pointing to the source data for this run.run_metadata
(dict, optional): A dictionary of custom key-value pairs to associate with the run, retrievable via webhook or run_status()
.force_rerun
(bool, optional): If True
, bypasses the idempotency check to re-process a source_path
that has already succeeded. Defaults to False
.LumeRun
: An object representing the newly created run.run_id
(str): The unique identifier of the run (e.g., "run_01HY..."
).LumeRun
: An object representing the run, with its status
and metadata
attributes populated.source_path
for use in lume.run()
.Parameterslocal_file_path
(str): Path to the local file to upload.flow_version
(str): The Flow Version this file is for, used to determine the correct upload location.str
: The source_path
corresponding to the uploaded file.pandas
.Parametersrun_id
(str): The ID of the completed run.result_type
(str, optional): The result set to download, either "mapped"
or "rejects"
. Defaults to "mapped"
.pandas.DataFrame
: A DataFrame containing the requested result data.