Skip to content

Commit 4dbb336

Browse files
authored
Update README.md
1 parent 55fc0d7 commit 4dbb336

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

+21
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,27 @@ YouShell >
295295
> Detected a Cloudflare version 2 Captcha challenge, This feature is not available in the opensource (free) version.
296296
> ```
297297
298+
299+
300+
301+
302+
## API
303+
Welcome to the YouDotCom Python library! Our library now features an easy-to-use public API that allows you to interact with YouChat. With this API, you can easily integrate YouChat into your own projects and applications, providing a convenient and user-friendly way for your users to access and utilize the capabilities of the chat bot.
304+
305+
~~To get started, you will first need to register for an API key on our website. This key will be required to authenticate each API request.~~
306+
307+
base url: api.betterapi.net
308+
309+
To send a message to YouChat and receive a JSON response, you can make an HTTP GET request to the endpoint "/youdotcom/chat", including the message to be sent as a query parameter. The key is "message" and the value should be the message text encoded in URL format. For example, to send the message "hello there", the endpoint would be "/youdotcom/chat?message=hello%20there". The JSON response will include the message sent by YouChat, time, v2Captcha, and type of the request.
310+
311+
Another endpoint is provided to convert the output text into speech, the endpoint is '/youdotcom/cts'. The message to be converted should be included as a query parameter in the URL, with the key "message" and the value being the message text. For example, to convert the message "hello there" into speech, the endpoint would be "/youdotcom/cts?message=hello%20there"
312+
313+
~~Make sure to include the API key in the header of each request to authenticate it.~~
314+
315+
316+
We are constantly improving and updating the YouDotCom library and API, so make sure to check back for new features and updates. If you have any questions or need assistance, feel free to reach out in the Discusions tab. I'm always happy to help.
317+
318+
298319
## YouDotCom roadmap
299320
* [x] add youchat
300321
* [x] add youcode

0 commit comments

Comments
 (0)