[Feature Request] published API documentation

published API documentation

## Why the solution needed
API users who do not have access to the source code need example code to interact with the Bot effectively. Providing example code will facilitate better understanding and usage of the API, enhancing user experience and reducing support requests.
## Additional context

Add any other context or screenshots about the feature request here.

## Implementation feasibility
Anyone can help me understand how to use public API

- [ ] Yes
- [ x ] No

The issue names no files, tests, or API entry points. First identify the public API surface and its supported usage examples, then document those examples and verify that a user without source access can follow them.

Written by the indexing model from the issue text.