Volume

VolumeService

Service which can be used to communicate with Volume type in UGC API.

To use this service, you need to instantiate it with a valid Move UGC client.

from move_ugc import MoveUgc
ugc = MoveUgc(api_key="my-api-key")

# Call volume service methods directly
ugc.volumes.retrieve(id="volume-<guid>")

# Or use the volume service as a mixin
volume_service = ugc.volumes
volume_service.retrieve(id="volume-<guid>")

create_human_volume

create_human_volume(sources: List[SourceIn], human_height: float, area_type: AreaType, sync_method: Optional[SyncMethodInput] = None, metadata: Optional[Dict[str, Any]] = None, name: Optional[str] = None, expand: Optional[List[ALLOWED_EXPAND_ATTRS]] = None) -> HumanVolumeType

Create a human volume with given sources in MoveUGC.

Parameters:

Name	Type	Description	Default
sources	List[SourceIn]	list of sources to be used for creating the volume.	required
human_height	float	height of the human in the volume.	required
area_type	AreaType	area type of the volume.	required
sync_method	Optional[SyncMethodInput]	sync method to be used for creating the volume.	None
metadata	Optional[Dict[str, Any]]	metadata to be used for creating the volume. This should be a valid json string.	None
name	Optional[str]	name of the volume.	None
expand	Optional[List[ALLOWED_EXPAND_ATTRS]]	list of fields to be expanded. Currently only client and sources are supported.	None

Returns:

Type	Description
HumanVolumeType	Volume instance of Pydantic model type.

retrieve_human_volume

retrieve_human_volume(id: str, expand: Optional[List[ALLOWED_EXPAND_ATTRS]] = None) -> HumanVolumeType

Retrieve a human volume with given id from MoveUGC.

The unique id for volume will usually be in the format: volume-{uuid}

Parameters:

Name	Type	Description	Default
id	str	unique identifier for the volume. This should typically be something like volume-{uuid}.	required
expand	Optional[List[ALLOWED_EXPAND_ATTRS]]	list of fields to be expanded. Currently only client and sources are supported.	None

Returns:

Type	Description
HumanVolumeType	HumanVolumeType instance of Pydantic model type.