The Python SDK enables you to use IntelliProves features with ease.
- Python 3.9 or up
- Python 3.9
- Python 3.10
- Python 3.11
You can find our SDK on the PyPi package manager repository for easy installation:
More info on authentication and the API key can be found here: API docs .
Check the quality of a given video or image before uploading. Returns a Quality object with feedback on whether your video/image is usable and why it might not be usable.
- path: Path - path to the video or image you want to check the quality of
Easily upload a video to IntelliProve for analysis of the subject's biomarkers. Returns the uuid of the uploaded video, which can be used to get the results.
NOTE: The quality check needs to be successful before you can upload a video.
- video_path: Path - path to the video that needs to be uploaded
- performer: str - Optional, the name of the person who performed the capture of the video
- patient: str - Optional, the name of the person who performed the capture of the video
Returns the results of a processed video for a given uuid as a Biomarkers object.
NOTE: This uses long polling, when demand is high this call can take a while.
- uuid: str - uuid of the uploaded video
Describes the quality of a video or image.
Holds the results of an analyzed video after upload.
Contains information on why a video was unprocessable.
ImageQualityException When trying to upload a video that does not fulfill the requirements.
MediaException Invalid video or image file provided.
This exception gets raised whenever a video you uploaded was unprocessable. Contains a response property (UnprocessableVideoResponse) with more information.
ApiNotFoundException The asked-for resource could not be found. Eg. wrong UUID.
ApiForbiddenException You don't have access to this functionality, most likely due to an invalid API key.
ApiErrorException There was an error in executing your request. This could be due to various reasons, eg. no internet connection, a server error, or the IntelliProve API could not be reached.
ApiResultNotAvailable The UUID you provided is valid, but the video has not been processed yet and has no result available yet.
Provided with a valid API key and a valid image and video path, this code snippet runs from start to finish.