kittycad.api.file.create_file_volume

Functions

asyncio(output_unit, src_format, body, *, client)	We assume any file given to us has one consistent unit throughout.
asyncio_detailed(output_unit, src_format, ...)	rtype: Response[Union[FileVolume, Error, None]]
sync(output_unit, src_format, body, *, client)	We assume any file given to us has one consistent unit throughout.
sync_detailed(output_unit, src_format, body, ...)	rtype: Response[Union[FileVolume, Error, None]]

kittycad.api.file.create_file_volume._build_response(*, response)

Return type:

Response[Union[FileVolume, Error, None]]

kittycad.api.file.create_file_volume._get_kwargs(output_unit, src_format, body, *, client)

Return type:

Dict[str, Any]

kittycad.api.file.create_file_volume._parse_response(*, response)

Return type:

Union[FileVolume, Error, None]

async kittycad.api.file.create_file_volume.asyncio(output_unit, src_format, body, *, client)

We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale. This endpoint returns the cubic measure units. In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported. Get the volume of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously. If the operation is performed asynchronously, the id of the operation will be returned. You can use the id returned from the request to get status information about the async operation from the /async/operations/{id} endpoint.

Return type:

Union[FileVolume, Error, None]

async kittycad.api.file.create_file_volume.asyncio_detailed(output_unit, src_format, body, *, client)

Return type:

Response[Union[FileVolume, Error, None]]

kittycad.api.file.create_file_volume.sync(output_unit, src_format, body, *, client)

We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale. This endpoint returns the cubic measure units. In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported. Get the volume of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously. If the operation is performed asynchronously, the id of the operation will be returned. You can use the id returned from the request to get status information about the async operation from the /async/operations/{id} endpoint.

Return type:

Union[FileVolume, Error, None]

kittycad.api.file.create_file_volume.sync_detailed(output_unit, src_format, body, *, client)

Return type:

Response[Union[FileVolume, Error, None]]