Run

Start a protein design run, wait for completion, and download results.

This is SDK workflow behavior, not a standalone REST endpoint. It composes generated API methods from this resource to submit work, wait for completion, and persist local results.

client.protein.design.run(
    *,
    binder_specification: protein_design_start_params.BinderSpecification,
    num_proteins: int,
    target: protein_design_start_params.Target,
    root_dir: str | PathLike[str] = 'boltz-experiments',
    name: str | None = None,
    workspace_id: str | Omit = omit,
    download_mode: DownloadMode | str | None = None,
    quiet: bool = False,
    poll_interval_seconds: float = 5.0,
) -> Path

Parameters

Parameter	Type	Default
binder_specification	protein_design_start_params.BinderSpecification	Required
num_proteins	int	Required
target	protein_design_start_params.Target	Required
root_dir	str | PathLike[str]	'boltz-experiments'
name	str | None	None
workspace_id	str | Omit	omit
download_mode	DownloadMode | str | None	None
quiet	bool	False
poll_interval_seconds	float	5.0

Returns

Path