documents the api call