Updated with proper documentation for api function.