forked from PawanOsman/ChatGPT
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9e266f5
commit 46f92f5
Showing
1 changed file
with
106 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,116 @@ | ||
|
||
# Welcome to ChatGPT API | ||
|
||
**ChatGPT** is a free api to the ChatGPT from OpenAI without Authentication. | ||
**ChatGPT** is a free API that allows users to access the ChatGPT machine learning model from OpenAI without the need for authentication. | ||
|
||
# How to use ChatGPT API? | ||
you can use it by sending `HTTP GET` Request to endpoints below: | ||
## How to use ChatGPT API | ||
|
||
| Query | Definition | | ||
|--|--| | ||
| text | Your Message| | ||
| lang | your text language (Default is English) [\[Language Codes\]](https://cloud.google.com/translate/docs/languages) | | ||
To use the ChatGPT API, send an `HTTP GET` request to the following endpoint: | ||
|
||
``` | ||
GET https://api.pawan.krd/chat/gpt | ||
``` | ||
|
||
### Query Parameters | ||
|
||
The following query parameters can be included in the request: | ||
|
||
|
||
|Parameter|Description|Required|Default| | ||
|--|--|--|--| | ||
|`text`|Your message|Yes|| | ||
|`lang`|The language of your text. Default is English. Supported languages can be found [here](https://cloud.google.com/translate/docs/languages).|No|`en`| | ||
|`id`|A unique identifier for your conversation.|No|`default`| | ||
|`cache`|A boolean value indicating whether to use cached responses, if available.|No|`true`| | ||
|
||
|
||
### Example Request | ||
|
||
``` | ||
GET https://api.pawan.krd/chat/gpt?text=Hello&lang=en | ||
``` | ||
|
||
### Example Response | ||
|
||
A successful response will return a JSON object with the following fields: | ||
|
||
```json | ||
{ | ||
"state": true, | ||
"reply": "Hello! How can I help you today?", | ||
"markdown": "Hello! How can I help you today?", | ||
"html": "<p>Hello! How can I help you today?</p>" | ||
} | ||
``` | ||
|
||
## Limitations | ||
|
||
It is important to note that ChatGPT API is provided on a best-effort basis and may not always be available. Additionally, the API may be rate-limited or have other usage restrictions in place. It is recommended to use the API responsibly and in accordance with any terms of service that may be in place. | ||
|
||
## Examples | ||
Here are example codes for using the API in Node.js, Python, and C#: | ||
|
||
### Node.js | ||
|
||
To use the ChatGPT API in Node.js, you can use the `axios` library to send an HTTP GET request to the API endpoint. Here is an example of how to do this: | ||
|
||
```javascript | ||
const axios = require('axios'); | ||
|
||
async function getResponse(text, lang) { | ||
try { | ||
const response = await axios.get('https://api.pawan.krd/chat/gpt', { | ||
params: { | ||
text, | ||
lang | ||
} | ||
}); | ||
return response.data; | ||
} catch (error) { | ||
console.error(error); | ||
} | ||
} | ||
|
||
getResponse('Hello', 'en').then(response => { | ||
console.log(response); | ||
}); | ||
``` | ||
|
||
### Python | ||
|
||
To use the ChatGPT API in Python, you can use the `requests` library to send an HTTP GET request to the API endpoint. Here is an example of how to do this: | ||
|
||
```python | ||
import requests | ||
|
||
def get_response(text, lang): | ||
params = {'text': text, 'lang': lang} | ||
response = requests.get('https://api.pawan.krd/chat/gpt', params=params) | ||
return response.json() | ||
|
||
response = get_response('Hello', 'en') | ||
print(response) | ||
``` | ||
|
||
### C# | ||
|
||
To use the ChatGPT API in C#, you can use the `HttpClient` class to send an HTTP GET request to the API endpoint. Here is an example of how to do this: | ||
|
||
```csharp | ||
using System.Net.Http; | ||
using Newtonsoft.Json; | ||
|
||
async Task<Response> GetResponse(string text, string lang) { | ||
using (var client = new HttpClient()) { | ||
var queryString = $"text={text}&lang={lang}"; | ||
var response = await client.GetAsync($"https://api.pawan.krd/chat/gpt?{queryString}"); | ||
var responseData = await response.Content.ReadAsStringAsync(); | ||
return JsonConvert.DeserializeObject<Response>(responseData); | ||
} | ||
} | ||
|
||
**Response** | ||
You will get json response like this: | ||
var response = await GetResponse("Hello", "en"); | ||
Console.log(response); | ||
``` | ||
|
||
{"status":true,"reply":"chat gpt reply","html":chat gpt reply in html format} | ||
Note that these are just basic examples, and you may need to add additional error handling and other functionality as needed for your use case. |