docs: add docs for the new api.

Hawk eye.