document the api methods