docs: update README

README.md

@@ -48,3 +48,64 @@ curl -X POST -H "Content-Type: application/json" -d '{"content": "YOUR_PROMPT",
 
 > [!NOTE]
 > If you want to use the Hosted API, it's live at [https://gpt-flask.onrender.com](https://gpt-flask.onrender.com/). For the API key, email me at [[email protected]](mailto:[email protected]).
+
+## Available Endpoints
+
+| Endpoint | Description | Method | Example Body |
+| -------------------- | -------------------------------------------------- | ------ | ----------------------------------------------------------------------------------- |
+| `/chat_completion` | Generates text using LLM & Model based on Provider | POST | `{"content": "YOUR_PROMPT", "provider": "PROVIDER_NAME","api_key": "API_KEY_HERE"}` |
+| `/working_providers` | Retrieves a list of Working Providers | GET | `{}` |
+
+## Providers Testing Results
+
+> (Last Tested on 9-12-2023)
+
+> To test it yourself, run `python3 test.py` script.
+
+> [!NOTE]
+> To know the Providers and their Models refer [this](https://github.com/xtekky/gpt4free?tab=readme-ov-file#-providers-and-models).
+
+**Status Values**
+- **Both:** The provider works successfully on both the local and hosted API.
+- **Local:** The provider works successfully only on the local API.
+- **Hosted:** The provider works successfully only on the hosted API.
+- **None:** The provider did not return a successful response on either the local or hosted API.
+
+| Provider | Local/Hosted/Both | Average Response Time |
+| -------------- | ----------------- | --------------------- |
+| AItianhuSpace | None | 0.0000 |
+| AiChatOnline | Both | 1.7481 |
+| Bard | None | 0.0000 |
+| Bing | Both | 7.1729 |
+| ChatBase | Both | 10.5962 |
+| ChatForAi | Local | 1.6945 |
+| Chatgpt4Online | None | 0.0000 |
+| ChatgptAi | Both | 4.0908 |
+| ChatgptNext | Both | 1.5508 |
+| DeepInfra | Both | 3.6010 |
+| FakeGpt | None | 0.0000 |
+| GPTalk | None | 0.0000 |
+| GeekGpt | Local | 2.3581 |
+| GptChatly | Local | 20.6423 |
+| GptForLove | None | 0.0000 |
+| GptGo | Local | 1.1042 |
+| GptTalkRu | Both | 1.2230 |
+| Hashnode | Both | 12.7480 |
+| HuggingChat | None | 0.0000 |
+| Koala | Local | 5.4211 |
+| Liaobots | None | 0.0000 |
+| Llama2 | None | 0.0000 |
+| MyShell | Local | 9.9238 |
+| OnlineGpt | Both | 2.1422 |
+| OpenaiChat | None | 0.0000 |
+| PerplexityAi | Local | 7.9256 |
+| Phind | Both | 0.4448 |
+| Pi | Local | 9.1299 |
+| Poe | None | 0.0000 |
+| Raycast | None | 0.0000 |
+| RetryProvider | None | 0.0000 |
+| TalkAi | Local | 11.4960 |
+| Theb | None | 0.0000 |
+| ThebApi | None | 0.0000 |
+| You | Local | 1.1193 |
+| Yqcloud | None | 0.0000 |