[doc] add information on the api