# Important:
## This project has been unmaintained for over a month and does not work. See [issue #221](https://github.com/ading2210/poe-api/issues/231) for more details.
# Python Poe API
[](https://pypi.org/project/poe-api/)
This is a reverse engineered API wrapper for Quora's Poe, which allows you free access to OpenAI's ChatGPT and GPT-4, as well as Anthropic's Claude.
## Table of Contents:
- [Features](#features)
- [Installation](#installation)
- [Documentation](#documentation)
* [Finding Your Token](#finding-your-token)
* [Using the Client](#using-the-client)
+ [Downloading the Available Bots](#downloading-the-available-bots)
+ [Using 3rd Party Bots](#using-3rd-party-bots)
+ [Creating New Bots](#creating-new-bots)
+ [Editing a Bot](#editing-a-bot)
+ [Sending Messages](#sending-messages)
+ [Clearing the Conversation Context](#clearing-the-conversation-context)
+ [Downloading Conversation History](#downloading-conversation-history)
+ [Deleting Messages](#deleting-messages)
+ [Purging a Conversation](#purging-a-conversation)
+ [Purging All Conversations](#purging-all-conversations)
+ [Getting the Remaining Messages](#getting-the-remaining-messages)
* [Misc](#misc)
+ [Changing the Logging Level](#changing-the-logging-level)
+ [Setting a Custom User-Agent](#setting-a-custom-user-agent)
+ [Setting a Custom Device ID](#setting-a-custom-device-id)
- [Copyright](#copyright)
* [Copyright Notice](#copyright-notice)
*Table of contents generated with [markdown-toc](http://ecotrust-canada.github.io/markdown-toc).*
## Features:
- Log in with token
- Proxy requests + websocket
- Download bot list
- Send messages
- Stream bot responses
- Clear conversation context
- Download conversation history
- Delete messages
- Purge an entire conversation
- Create custom bots
- Edit your custom bots
- Use pre-existing third party bots
## Installation:
You can install this library by running the following command:
```
pip3 install poe-api
```
This library depends on `quickjs`, which does not have prebuilt binaries available for Python 3.11. Pip will attempt to compile it, but will fail if `python-dev` is not installed.
On Linux, you can install it via the instructions listed here: https://stackoverflow.com/questions/21530577/fatal-error-python-h-no-such-file-or-directory
On Windows and MacOS, `python-dev` should be included with your existing Python installation.
## Documentation:
Examples can be found in the `/examples` directory. To run these examples, pass in your token as a command-line argument.
```
python3 examples/temporary_message.py "TOKEN_HERE"
```
### Finding Your Token:
Log into [Poe](https://poe.com) on any desktop web browser, then open your browser's developer tools (also known as "inspect") and look for the value of the `p-b` cookie in the following menus:
- Chromium: Devtools > Application > Cookies > poe.com
- Firefox: Devtools > Storage > Cookies
- Safari: Devtools > Storage > Cookies
Note that excessive usage of this library may lead to your account getting banned. It is recommended that you set your own rate limits, and that you use an alt account that you don't value. See [issue #118](https://github.com/ading2210/poe-api/issues/118) for more details. If your requests are infrequent, the risk for a ban is very low.
### Using the Client:
To use this library, simply import `poe` and create a `poe.Client` instance. The Client class accepts the following arguments:
- `token` - The token to use.
- `proxy = None` - The proxy to use, in the format `protocol://host:port`. The `socks5h` protocol is recommended, as it also proxies the DNS queries.
- `device_id = None` - The device ID to use. If this is not specified, it will be randomly generated and stored on the disk.
- `headers = headers` - The headers to use. This defaults to the headers specified in `poe.headers`.
- `client_identifier = client_identifier` - The client identifier that will be passed into the TLS client library. This defaults to the one specified in `poe.client_identifier`.
- `formkey = None` - The formkey to use. Only supply this option if initializing the client without it fails. You can find this value by going into your browser's devtools, looking in the network tab for a `gql_POST` request, and taking the value of the `poe-formkey` request header. The formkey that you use must come from a browser that matches the headers that you've set in `poe.headers`. Keep in mind that the default browser is Chromium 112.
Regular Example:
```python
import poe
client = poe.Client("TOKEN_HERE")
```
Proxied Example:
```python
import poe
client = poe.Client("TOKEN_HERE", proxy="socks5h://178.62.100.151:59166")
```
Note that the following examples assume `client` is the name of your `poe.Client` instance. If the token is invalid, a RuntimeError will be raised.
#### Downloading the Available Bots:
The client downloads all of the available bots upon initialization and stores them within `client.bots`. A dictionary that maps bot codenames to their display names can be found at `client.bot_names`. If you want to refresh these values, you can call `client.get_bots`. This function takes the following arguments:
- `download_next_data = True` - Whether or not to re-download the `__NEXT_DATA__`, which is required if the bot list has changed.
```python
print(json.dumps(client.bot_names, indent=2))
"""
{
"chinchilla": "ChatGPT",
"a2": "Claude-instant",
"capybara": "Assistant",
"a2_100k": "Claude-instant-100k",
"llama_2_7b_chat": "Llama-2-7b",
"llama_2_13b_chat": "Llama-2-13b",
"a2_2": "Claude-2-100k",
"llama_2_70b_chat": "Llama-2-70b",
"agouti": "ChatGPT-16k",
"beaver": "GPT-4",
"vizcacha": "GPT-4-32k",
"acouchy": "Google-PaLM"
}
"""
```
Note that, on free accounts, Claude+ (a2_2) has a limit of 3 messages per day and GPT-4 (beaver) has a limit of 1 message per day. Claude-instant-100k (c2_100k) is completely inaccessible for free accounts. For all the other chatbots, there seems to be a rate limit of 10 messages per minute.
#### Using 3rd Party Bots:
To get a list of 3rd party bots, use `client.explore_bots`, which accepts the following arguments:
- `end_cursor = None` - The cursor to use when fetching the list.
- `count = 25` - The number of bots that is returned.
The function will return a dict containing a list of bots and the cursor for the next page:
```python
print(json.dumps(client.explore_bots(count=1), indent=2))
"""
{
"bots": [
{
"id": "Qm90OjEwMzI2MDI=",
"displayName": "leocooks",
"deletionState": "not_deleted",
"image": {
"__typename": "UrlBotImage",
"url": "https://qph.cf2.quoracdn.net/main-thumb-pb-1032602-200-uorvomwowfgmatdvrtwajtwwqlujmmgu.jpeg"
},
"botId": 1032602,
"followerCount": 1922,
"description": "Above average meals for average cooks, made simple by world-renowned chef, Leonardo",
"__typename": "Bot"
}
],
"end_cursor": "1000172"
}
"""
```
To get a specific third party bot, you can use `client.get_bot_by_codename`, which accept's the bot's codename as its only argument.
```python
client.get_bot_by_codename("JapaneseTutor")
```
Since display names are the same as the codenames for custom bots, you can simply pass the bot's display name into `client.send_message` to send it a message.
#### Creating New Bots:
You can create a new bot using the `client.create_bot` function, which accepts the following arguments:
- `handle` - The handle of the new bot.
- `prompt = ""` - The prompt for the new bot.
- `display_name = None` - The display name for the new bot.
- `base_model = "chinchilla"` - The model that the new bot uses. This must be either `"chinchilla"` (ChatGPT) or `"a2"` (Claude). If you've subscribed, you can use `"beaver"` (ChatGPT4) or "a2_2"` (Claude-2-100k).
- `description = ""` - The description for the new bot.
- `intro_message = ""` - The intro message for the new bot. If this is an empty string then the bot will not have an intro message.
- `prompt_public = True` - Whether or not the prompt should be publicly visible.
- `pfp_url = None` - The URL for the bot's profile picture. Currently, there is no way to actually upload a custom image using this library.
- `linkification = False` - Whether or not the bot should turn some text in the response into clickable links.
- `markdown_rendering = True` - Whether or not to enable markdown rendering for the bot's responses.
- `suggested_replies = False` - Whether or not the bot should suggest possible replies after each response.
- `private = False` - Whether or not the bot should be private.
- `temperature = None`: - The temperature for the new bot.
Use these arguments if you want the new bot to use your own API (as detailed [here](https://github.com/poe-platform/api-bot-tutorial)):
- `api_key = None` - The API key for the new bot.
- `api_bot = False` - Whether or not the bot has API functionally enabled.
- `api_url = None` - The API URL for the new bot.
A full example of how to create and edit bots is located at `examples/create_bot.py`.
```python
new_bot = client.create_bot(bot_name, "prompt goes here", base_model="a2")
```
#### Editing a Bot:
You can edit a custom bot using the `client.edit_bot` function, which accepts the following arguments:
- `bot_id` - The `botId` of the bot to edit. This can also be set to `None`.
- `handle` - The handle for the bot you're editing.
- `prompt` - The new prompt for the bot.
- `new_handle = None` - The new handle for the bot. By default the handle will not change.
- `display_name = None` - The new display name for the bot.
- `base_model = "chinchilla"` - The new model that the bot uses. This must be either `"chinchilla"` (ChatGPT) or `"a2"` (Claude). If you've subscribed, you can use `"beaver"` (ChatGPT4) or "a2_2"` (Claude-2-100k).
- `description = ""` - The new description for the bot.
- `intro_message = ""` - The new intro message for the bot. If this is an empty string then the bot will not have an intro message.
- `prompt_public = True` - Whether or not the prompt should be publicly visible.
- `pfp_url = None` - The URL for the bot's profile picture. Currently, there is no way to actually upload a custom image using this library.
- `linkification = False` - Whether or not the bot should turn some text in the response into clickable links.
- `markdown_rendering = True` - Whether or not to enable markdown rendering for the bot's responses.
- `suggested_replies = False` - Whether or not the bot should suggest possible replies after each response.
- `private = False` - Whether or not the bot should be private.
- `temperature = None`: - The new temperature for the this bot.
Bot API related arguments:
- `api_key = None` - The new API key for the bot.
- `api_url = None` - The new API URL for the bot.
A full example of how to create and edit bots is located at `examples/create_bot.py`.
```python
edit_result = client.edit_bot(1086981, "bot_handle_here", base_model="a2")
```
#### Sending Messages:
You can use the `client.send_message` function to send a message to a chatbot, which accepts the following arguments:
- `chatbot` - The codename of the chatbot. (example: `capybara`)
- `message` - The message to send to the chatbot.
- `with_chat_break = False` - Whether the conversation context should be cleared.
- `timeout = 20` - The max number of seconds in between received chunks until a `RuntimeError` is raised.
- `async_recv = True` - Whether or not to make the `receive_POST` request async. If this is disabled, then there will be an extra wait of about 3 seconds after the message is complete.
- `suggest_callback = None` - Callback for suggested replies. See `examples/send_message.py` for an example on how to use this.
The function is a generator which returns the most recent version of the generated message whenever it is updated.
Streamed Example:
```python
message = "Summarize the GNU GPL v3"
for chunk in client.send_message("capybara", message):
print(chunk["text_new"], end="", flush=True)
```
Non-Streamed Example:
```python
message = "Summarize the GNU GPL v3"
for chunk in client.send_message("capybara", message):
pass
print(chunk["text"])
```
You can also send multiple messages in parallel using `threading` and receive their responses separately, as demonstrated in `/examples/parallel_messages.py`. Note that if you send messages too fast, the server will give an error, but the request will eventually succeed.
The `client.is_busy` function can be used to check if there is currently a message being received.
#### Clearing the Conversation Context:
If you want to clear the the context of a conversation without sending a message, you can use `client.send_chat_break`. The only argument is the codename of the bot whose context will be cleared.
```python
client.send_chat_break("capybara")
```
The function returns the message which represents the chat break.
#### Downloading Conversation History:
To download past messages in a conversation, use the `client.get_message_history` function, which accepts the following arguments:
- `chatbot` - The codename of the chatbot.
- `count = 25` - The number of messages to download.
- `cursor = None` - The message ID to start at instead of the latest one.
Note that if you don't specify a cursor, the client will have to perform an extra request to determine what the latest cursor is.
The returned messages are ordered from oldest to newest.
```python
message_history = client.get_message_history("capybara", count=10)
print(json.dumps(message_history, indent=2))
"""
[
{
"node": {
"id": "TWVzc2FnZToxMDEwNzYyODU=",
"messageId": 101076285,
"creationTime": 1679298157718888,
"text": "",
"author": "chat_break",
"linkifiedText": "",
"state": "complete",
"suggestedReplies": [],
"vote": null,
"voteReason": null,
"__typename": "Message"
},
"cursor": "101076285",
"id": "TWVzc2FnZUVkZ2U6MTAxMDc2Mjg1OjEwMTA3NjI4NQ=="
},
...
]
"""
```
#### Deleting Messages:
To delete messages, use the `client.delete_message` function, which accepts a single argument. You can pass a single message ID into it to delete a single message, or you can pass a list of message IDs to delete multiple messages at once.
```python
#delete a single message
client.delete_message(96105719)
#delete multiple messages at once
client.delete_message([96105719, 96097108, 96097078, 96084421, 96084402])
```
#### Purging a Conversation:
To purge an entire conversation, or just the last few messages, you can use the `client.purge_conversation` function. This function accepts the following arguments:
- `chatbot` - The codename of the chatbot.
- `count = -1` - The number of messages to be deleted, starting from the latest one. The default behavior is to delete every single message.
```python
#purge just the last 10 messages
client.purge_conversation("capybara", count=10)
#purge the entire conversation
client.purge_conversation("capybara")
```
#### Purging All Conversations:
To purge every conversation in your account, use the `client.purge_all_conversations` function. This function doesn't need any arguments.
```python
>>> client.purge_all_conversations()
```
#### Getting the Remaining Messages:
To get the number of messages remaining in the quota for a conversation, use the `client.get_remaining_messages` function. This function accepts the following arguments:
- `chatbot` - The codename of the chatbot.
The function will return the number of messages remaining, or `None` if the bot does not have a quota.
```python
>>> client.get_remaining_messages("beaver")
1
```
### Misc:
#### Changing the Logging Level:
If you want to show debug messages, simply call `poe.logger.setLevel`.
```python
import poe
import logging
poe.logger.setLevel(logging.INFO)
```
#### Setting a Custom User-Agent:
If you want to change the headers that are spoofed, set `poe.headers` after importing the library.
To use your browser's own headers, visit [this site](https://headers.uniqueostrich18.repl.co/), and copy-paste its contents.
```python
import poe
poe.headers = {
"User-Agent": "Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Firefox/102.0",
'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*q=0.8,application/signed-exchange;v=b3;q=0.7',
"Accept-Encoding": "gzip, deflate, br",
'Accept-Language': 'zh-CN,zh;q=0.9,en;q=0.8,en-GB;q=0.7,en-US;q=0.6',
"Upgrade-Insecure-Requests": "1"
}
```
The following headers will be ignored and overwritten:
```python
{
"Referrer": "https://poe.com/",
"Origin": "https://poe.com",
"Host": "poe.com",
"Cache-Control": "no-cache",
"Sec-Fetch-Dest": "document",
"Sec-Fetch-Mode": "navigate",
"Sec-Fetch-Site": "same-origin",
"Sec-Fetch-User": "?1",
}
```
Previously, this was done through `poe.user_agent`, but that variable is now completely ignored.
You'd also want to change `poe.client_identifier` to match the user-agent that you have set. See the [Python-TLS-Client documentation](https://github.com/FlorianREGAZ/Python-Tls-Client#examples) for some sample values. Keep in mind that spoofing Chrome/Firefox versions >= 110 may be detectable.
```python
poe.client_identifier = "chrome_107"
```
### Setting a Custom Device ID:
If you want to change the device ID that is being spoofed, you can use the `poe.set_device_id`, which accepts the following arguments:
- `user_id` - The user ID of the account you want to change the device ID for. The user ID can be found at `client.viewer["poeUser"]["id"]`.
- `device_id` - The new device ID. This is a 32 character UUID string in the following format: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`
```python
poe.set_device_id("UGMlVXqlcLYyMOATMDsKNTMz", "6d659b04-043a-41f8-97c7-fb7d7fe9ad34")
```
The device IDs are saved to `~/.config/poe-api/device_id.json` on Unix-like systems, and `C:\Users\<user>\AppData\Roaming\poe-api\device_id.json` on Windows.
Additionally, the `poe.get_device_id` function or `client.device_id` can be used to retrieve the saved device ID.
```python
>>> poe.get_device_id("UGMlVXqlcLYyMOATMDsKNTMz")
#6d659b04-043a-41f8-97c7-fb7d7fe9ad34
>>> client.device_id
#6d659b04-043a-41f8-97c7-fb7d7fe9ad34
```
## Copyright:
This program is licensed under the [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.txt). Most code, with the exception of the GraphQL queries, has been written by me, [ading2210](https://github.com/ading2210).
Reverse engineering the `poe-tag-id` header has been done by [xtekky](https://github.com/xtekky) in [PR #39](https://github.com/ading2210/poe-api/pull/39).
The `client.get_remaining_messages` function was written by [Snowad14](https://github.com/Snowad14) in [PR #46](https://github.com/ading2210/poe-api/pull/46).
Detection avoidance and fetching the third party bots has been done by [acheong08](https://github.com/acheong08/) in [PR #79](https://github.com/ading2210/poe-api/pull/79).
Most of the GraphQL queries are taken from [muharamdani/poe](https://github.com/muharamdani/poe), which is licensed under the ISC License.
### Copyright Notice:
```
ading2210/poe-api: a reverse engineered Python API wrapper for Quora's Poe
Copyright (C) 2023 ading2210
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ading2210/poe-api",
"name": "poe-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "ading2210",
"author_email": "",
"download_url": "",
"platform": null,
"description": "# Important:\n\n## This project has been unmaintained for over a month and does not work. See [issue #221](https://github.com/ading2210/poe-api/issues/231) for more details.\n\n# Python Poe API\n\n[](https://pypi.org/project/poe-api/)\n\nThis is a reverse engineered API wrapper for Quora's Poe, which allows you free access to OpenAI's ChatGPT and GPT-4, as well as Anthropic's Claude.\n\n## Table of Contents:\n- [Features](#features)\n- [Installation](#installation)\n- [Documentation](#documentation)\n * [Finding Your Token](#finding-your-token)\n * [Using the Client](#using-the-client)\n + [Downloading the Available Bots](#downloading-the-available-bots)\n + [Using 3rd Party Bots](#using-3rd-party-bots)\n + [Creating New Bots](#creating-new-bots)\n + [Editing a Bot](#editing-a-bot)\n + [Sending Messages](#sending-messages)\n + [Clearing the Conversation Context](#clearing-the-conversation-context)\n + [Downloading Conversation History](#downloading-conversation-history)\n + [Deleting Messages](#deleting-messages)\n + [Purging a Conversation](#purging-a-conversation)\n + [Purging All Conversations](#purging-all-conversations)\n + [Getting the Remaining Messages](#getting-the-remaining-messages)\n * [Misc](#misc)\n + [Changing the Logging Level](#changing-the-logging-level)\n + [Setting a Custom User-Agent](#setting-a-custom-user-agent)\n + [Setting a Custom Device ID](#setting-a-custom-device-id)\n- [Copyright](#copyright)\n * [Copyright Notice](#copyright-notice)\n\n*Table of contents generated with [markdown-toc](http://ecotrust-canada.github.io/markdown-toc).*\n\n## Features:\n - Log in with token\n - Proxy requests + websocket\n - Download bot list\n - Send messages\n - Stream bot responses\n - Clear conversation context\n - Download conversation history\n - Delete messages\n - Purge an entire conversation\n - Create custom bots\n - Edit your custom bots\n - Use pre-existing third party bots\n\n## Installation:\nYou can install this library by running the following command:\n```\npip3 install poe-api\n```\nThis library depends on `quickjs`, which does not have prebuilt binaries available for Python 3.11. Pip will attempt to compile it, but will fail if `python-dev` is not installed.\n\nOn Linux, you can install it via the instructions listed here: https://stackoverflow.com/questions/21530577/fatal-error-python-h-no-such-file-or-directory\n\nOn Windows and MacOS, `python-dev` should be included with your existing Python installation.\n\n## Documentation:\nExamples can be found in the `/examples` directory. To run these examples, pass in your token as a command-line argument.\n```\npython3 examples/temporary_message.py \"TOKEN_HERE\"\n```\n\n### Finding Your Token:\nLog into [Poe](https://poe.com) on any desktop web browser, then open your browser's developer tools (also known as \"inspect\") and look for the value of the `p-b` cookie in the following menus:\n - Chromium: Devtools > Application > Cookies > poe.com\n - Firefox: Devtools > Storage > Cookies\n - Safari: Devtools > Storage > Cookies\n\nNote that excessive usage of this library may lead to your account getting banned. It is recommended that you set your own rate limits, and that you use an alt account that you don't value. See [issue #118](https://github.com/ading2210/poe-api/issues/118) for more details. If your requests are infrequent, the risk for a ban is very low.\n\n### Using the Client:\nTo use this library, simply import `poe` and create a `poe.Client` instance. The Client class accepts the following arguments:\n - `token` - The token to use. \n - `proxy = None` - The proxy to use, in the format `protocol://host:port`. The `socks5h` protocol is recommended, as it also proxies the DNS queries.\n - `device_id = None` - The device ID to use. If this is not specified, it will be randomly generated and stored on the disk. \n - `headers = headers` - The headers to use. This defaults to the headers specified in `poe.headers`.\n - `client_identifier = client_identifier` - The client identifier that will be passed into the TLS client library. This defaults to the one specified in `poe.client_identifier`.\n - `formkey = None` - The formkey to use. Only supply this option if initializing the client without it fails. You can find this value by going into your browser's devtools, looking in the network tab for a `gql_POST` request, and taking the value of the `poe-formkey` request header. The formkey that you use must come from a browser that matches the headers that you've set in `poe.headers`. Keep in mind that the default browser is Chromium 112.\n\nRegular Example:\n```python\nimport poe\nclient = poe.Client(\"TOKEN_HERE\")\n```\n\nProxied Example:\n```python\nimport poe\nclient = poe.Client(\"TOKEN_HERE\", proxy=\"socks5h://178.62.100.151:59166\")\n```\n\nNote that the following examples assume `client` is the name of your `poe.Client` instance. If the token is invalid, a RuntimeError will be raised.\n\n#### Downloading the Available Bots:\nThe client downloads all of the available bots upon initialization and stores them within `client.bots`. A dictionary that maps bot codenames to their display names can be found at `client.bot_names`. If you want to refresh these values, you can call `client.get_bots`. This function takes the following arguments:\n - `download_next_data = True` - Whether or not to re-download the `__NEXT_DATA__`, which is required if the bot list has changed. \n\n```python\nprint(json.dumps(client.bot_names, indent=2))\n\"\"\"\n{\n \"chinchilla\": \"ChatGPT\",\n \"a2\": \"Claude-instant\",\n \"capybara\": \"Assistant\",\n \"a2_100k\": \"Claude-instant-100k\",\n \"llama_2_7b_chat\": \"Llama-2-7b\",\n \"llama_2_13b_chat\": \"Llama-2-13b\",\n \"a2_2\": \"Claude-2-100k\",\n \"llama_2_70b_chat\": \"Llama-2-70b\",\n \"agouti\": \"ChatGPT-16k\",\n \"beaver\": \"GPT-4\",\n \"vizcacha\": \"GPT-4-32k\",\n \"acouchy\": \"Google-PaLM\"\n}\n\"\"\"\n```\n\nNote that, on free accounts, Claude+ (a2_2) has a limit of 3 messages per day and GPT-4 (beaver) has a limit of 1 message per day. Claude-instant-100k (c2_100k) is completely inaccessible for free accounts. For all the other chatbots, there seems to be a rate limit of 10 messages per minute.\n\n#### Using 3rd Party Bots:\nTo get a list of 3rd party bots, use `client.explore_bots`, which accepts the following arguments:\n - `end_cursor = None` - The cursor to use when fetching the list. \n - `count = 25` - The number of bots that is returned.\n\nThe function will return a dict containing a list of bots and the cursor for the next page:\n```python\nprint(json.dumps(client.explore_bots(count=1), indent=2))\n\"\"\"\n{\n \"bots\": [\n {\n \"id\": \"Qm90OjEwMzI2MDI=\",\n \"displayName\": \"leocooks\",\n \"deletionState\": \"not_deleted\",\n \"image\": {\n \"__typename\": \"UrlBotImage\",\n \"url\": \"https://qph.cf2.quoracdn.net/main-thumb-pb-1032602-200-uorvomwowfgmatdvrtwajtwwqlujmmgu.jpeg\"\n },\n \"botId\": 1032602,\n \"followerCount\": 1922,\n \"description\": \"Above average meals for average cooks, made simple by world-renowned chef, Leonardo\",\n \"__typename\": \"Bot\"\n }\n ],\n \"end_cursor\": \"1000172\"\n}\n\"\"\"\n```\n\nTo get a specific third party bot, you can use `client.get_bot_by_codename`, which accept's the bot's codename as its only argument.\n```python\nclient.get_bot_by_codename(\"JapaneseTutor\")\n```\n\nSince display names are the same as the codenames for custom bots, you can simply pass the bot's display name into `client.send_message` to send it a message.\n\n#### Creating New Bots:\nYou can create a new bot using the `client.create_bot` function, which accepts the following arguments:\n - `handle` - The handle of the new bot.\n - `prompt = \"\"` - The prompt for the new bot.\n - `display_name = None` - The display name for the new bot.\n - `base_model = \"chinchilla\"` - The model that the new bot uses. This must be either `\"chinchilla\"` (ChatGPT) or `\"a2\"` (Claude). If you've subscribed, you can use `\"beaver\"` (ChatGPT4) or \"a2_2\"` (Claude-2-100k).\n - `description = \"\"` - The description for the new bot.\n - `intro_message = \"\"` - The intro message for the new bot. If this is an empty string then the bot will not have an intro message.\n - `prompt_public = True` - Whether or not the prompt should be publicly visible. \n - `pfp_url = None` - The URL for the bot's profile picture. Currently, there is no way to actually upload a custom image using this library.\n - `linkification = False` - Whether or not the bot should turn some text in the response into clickable links.\n - `markdown_rendering = True` - Whether or not to enable markdown rendering for the bot's responses.\n - `suggested_replies = False` - Whether or not the bot should suggest possible replies after each response.\n - `private = False` - Whether or not the bot should be private.\n - `temperature = None`: - The temperature for the new bot.\n\nUse these arguments if you want the new bot to use your own API (as detailed [here](https://github.com/poe-platform/api-bot-tutorial)):\n - `api_key = None` - The API key for the new bot. \n - `api_bot = False` - Whether or not the bot has API functionally enabled.\n - `api_url = None` - The API URL for the new bot.\n\nA full example of how to create and edit bots is located at `examples/create_bot.py`.\n```python\nnew_bot = client.create_bot(bot_name, \"prompt goes here\", base_model=\"a2\")\n```\n\n#### Editing a Bot:\nYou can edit a custom bot using the `client.edit_bot` function, which accepts the following arguments:\n - `bot_id` - The `botId` of the bot to edit. This can also be set to `None`.\n - `handle` - The handle for the bot you're editing.\n - `prompt` - The new prompt for the bot.\n - `new_handle = None` - The new handle for the bot. By default the handle will not change.\n - `display_name = None` - The new display name for the bot.\n - `base_model = \"chinchilla\"` - The new model that the bot uses. This must be either `\"chinchilla\"` (ChatGPT) or `\"a2\"` (Claude). If you've subscribed, you can use `\"beaver\"` (ChatGPT4) or \"a2_2\"` (Claude-2-100k).\n - `description = \"\"` - The new description for the bot.\n - `intro_message = \"\"` - The new intro message for the bot. If this is an empty string then the bot will not have an intro message.\n - `prompt_public = True` - Whether or not the prompt should be publicly visible. \n - `pfp_url = None` - The URL for the bot's profile picture. Currently, there is no way to actually upload a custom image using this library.\n - `linkification = False` - Whether or not the bot should turn some text in the response into clickable links.\n - `markdown_rendering = True` - Whether or not to enable markdown rendering for the bot's responses.\n - `suggested_replies = False` - Whether or not the bot should suggest possible replies after each response.\n - `private = False` - Whether or not the bot should be private.\n - `temperature = None`: - The new temperature for the this bot.\n\nBot API related arguments:\n - `api_key = None` - The new API key for the bot. \n - `api_url = None` - The new API URL for the bot.\n\nA full example of how to create and edit bots is located at `examples/create_bot.py`.\n```python\nedit_result = client.edit_bot(1086981, \"bot_handle_here\", base_model=\"a2\")\n```\n\n#### Sending Messages:\nYou can use the `client.send_message` function to send a message to a chatbot, which accepts the following arguments:\n - `chatbot` - The codename of the chatbot. (example: `capybara`)\n - `message` - The message to send to the chatbot.\n - `with_chat_break = False` - Whether the conversation context should be cleared.\n - `timeout = 20` - The max number of seconds in between received chunks until a `RuntimeError` is raised. \n - `async_recv = True` - Whether or not to make the `receive_POST` request async. If this is disabled, then there will be an extra wait of about 3 seconds after the message is complete.\n - `suggest_callback = None` - Callback for suggested replies. See `examples/send_message.py` for an example on how to use this.\n\nThe function is a generator which returns the most recent version of the generated message whenever it is updated.\n\nStreamed Example:\n```python\nmessage = \"Summarize the GNU GPL v3\"\nfor chunk in client.send_message(\"capybara\", message):\n print(chunk[\"text_new\"], end=\"\", flush=True)\n```\n\nNon-Streamed Example:\n```python\nmessage = \"Summarize the GNU GPL v3\"\nfor chunk in client.send_message(\"capybara\", message):\n pass\nprint(chunk[\"text\"])\n```\n\nYou can also send multiple messages in parallel using `threading` and receive their responses separately, as demonstrated in `/examples/parallel_messages.py`. Note that if you send messages too fast, the server will give an error, but the request will eventually succeed.\n\nThe `client.is_busy` function can be used to check if there is currently a message being received.\n\n#### Clearing the Conversation Context:\nIf you want to clear the the context of a conversation without sending a message, you can use `client.send_chat_break`. The only argument is the codename of the bot whose context will be cleared.\n\n```python\nclient.send_chat_break(\"capybara\")\n```\nThe function returns the message which represents the chat break.\n\n#### Downloading Conversation History:\nTo download past messages in a conversation, use the `client.get_message_history` function, which accepts the following arguments:\n - `chatbot` - The codename of the chatbot.\n - `count = 25` - The number of messages to download.\n - `cursor = None` - The message ID to start at instead of the latest one.\n \nNote that if you don't specify a cursor, the client will have to perform an extra request to determine what the latest cursor is.\n\nThe returned messages are ordered from oldest to newest. \n\n```python\nmessage_history = client.get_message_history(\"capybara\", count=10)\nprint(json.dumps(message_history, indent=2))\n\"\"\"\n[\n {\n \"node\": {\n \"id\": \"TWVzc2FnZToxMDEwNzYyODU=\",\n \"messageId\": 101076285,\n \"creationTime\": 1679298157718888,\n \"text\": \"\",\n \"author\": \"chat_break\",\n \"linkifiedText\": \"\",\n \"state\": \"complete\",\n \"suggestedReplies\": [],\n \"vote\": null,\n \"voteReason\": null,\n \"__typename\": \"Message\"\n },\n \"cursor\": \"101076285\",\n \"id\": \"TWVzc2FnZUVkZ2U6MTAxMDc2Mjg1OjEwMTA3NjI4NQ==\"\n },\n ...\n]\n\"\"\"\n```\n\n#### Deleting Messages:\nTo delete messages, use the `client.delete_message` function, which accepts a single argument. You can pass a single message ID into it to delete a single message, or you can pass a list of message IDs to delete multiple messages at once.\n\n```python\n#delete a single message\nclient.delete_message(96105719)\n\n#delete multiple messages at once\nclient.delete_message([96105719, 96097108, 96097078, 96084421, 96084402])\n```\n\n#### Purging a Conversation:\nTo purge an entire conversation, or just the last few messages, you can use the `client.purge_conversation` function. This function accepts the following arguments:\n - `chatbot` - The codename of the chatbot.\n - `count = -1` - The number of messages to be deleted, starting from the latest one. The default behavior is to delete every single message.\n\n```python\n#purge just the last 10 messages\nclient.purge_conversation(\"capybara\", count=10)\n\n#purge the entire conversation\nclient.purge_conversation(\"capybara\")\n```\n\n#### Purging All Conversations:\nTo purge every conversation in your account, use the `client.purge_all_conversations` function. This function doesn't need any arguments.\n\n```python\n>>> client.purge_all_conversations()\n```\n\n#### Getting the Remaining Messages:\nTo get the number of messages remaining in the quota for a conversation, use the `client.get_remaining_messages` function. This function accepts the following arguments:\n - `chatbot` - The codename of the chatbot.\n\nThe function will return the number of messages remaining, or `None` if the bot does not have a quota.\n\n```python\n>>> client.get_remaining_messages(\"beaver\")\n1\n```\n\n### Misc:\n#### Changing the Logging Level:\nIf you want to show debug messages, simply call `poe.logger.setLevel`.\n\n```python\nimport poe\nimport logging\npoe.logger.setLevel(logging.INFO)\n```\n\n#### Setting a Custom User-Agent:\nIf you want to change the headers that are spoofed, set `poe.headers` after importing the library. \n\nTo use your browser's own headers, visit [this site](https://headers.uniqueostrich18.repl.co/), and copy-paste its contents.\n```python\nimport poe\npoe.headers = {\n \"User-Agent\": \"Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Firefox/102.0\",\n 'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*q=0.8,application/signed-exchange;v=b3;q=0.7',\n \"Accept-Encoding\": \"gzip, deflate, br\",\n 'Accept-Language': 'zh-CN,zh;q=0.9,en;q=0.8,en-GB;q=0.7,en-US;q=0.6',\n \"Upgrade-Insecure-Requests\": \"1\"\n}\n```\n\nThe following headers will be ignored and overwritten:\n```python\n{\n \"Referrer\": \"https://poe.com/\",\n \"Origin\": \"https://poe.com\",\n \"Host\": \"poe.com\",\n \"Cache-Control\": \"no-cache\",\n \"Sec-Fetch-Dest\": \"document\",\n \"Sec-Fetch-Mode\": \"navigate\",\n \"Sec-Fetch-Site\": \"same-origin\",\n \"Sec-Fetch-User\": \"?1\",\n}\n```\n\nPreviously, this was done through `poe.user_agent`, but that variable is now completely ignored.\n\nYou'd also want to change `poe.client_identifier` to match the user-agent that you have set. See the [Python-TLS-Client documentation](https://github.com/FlorianREGAZ/Python-Tls-Client#examples) for some sample values. Keep in mind that spoofing Chrome/Firefox versions >= 110 may be detectable. \n```python\npoe.client_identifier = \"chrome_107\"\n```\n\n### Setting a Custom Device ID:\nIf you want to change the device ID that is being spoofed, you can use the `poe.set_device_id`, which accepts the following arguments:\n - `user_id` - The user ID of the account you want to change the device ID for. The user ID can be found at `client.viewer[\"poeUser\"][\"id\"]`.\n - `device_id` - The new device ID. This is a 32 character UUID string in the following format: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`\n\n```python\npoe.set_device_id(\"UGMlVXqlcLYyMOATMDsKNTMz\", \"6d659b04-043a-41f8-97c7-fb7d7fe9ad34\")\n```\n\nThe device IDs are saved to `~/.config/poe-api/device_id.json` on Unix-like systems, and `C:\\Users\\<user>\\AppData\\Roaming\\poe-api\\device_id.json` on Windows.\n\nAdditionally, the `poe.get_device_id` function or `client.device_id` can be used to retrieve the saved device ID.\n```python\n>>> poe.get_device_id(\"UGMlVXqlcLYyMOATMDsKNTMz\")\n#6d659b04-043a-41f8-97c7-fb7d7fe9ad34\n\n>>> client.device_id\n#6d659b04-043a-41f8-97c7-fb7d7fe9ad34\n```\n\n## Copyright: \nThis program is licensed under the [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.txt). Most code, with the exception of the GraphQL queries, has been written by me, [ading2210](https://github.com/ading2210).\n\nReverse engineering the `poe-tag-id` header has been done by [xtekky](https://github.com/xtekky) in [PR #39](https://github.com/ading2210/poe-api/pull/39).\n\nThe `client.get_remaining_messages` function was written by [Snowad14](https://github.com/Snowad14) in [PR #46](https://github.com/ading2210/poe-api/pull/46).\n\nDetection avoidance and fetching the third party bots has been done by [acheong08](https://github.com/acheong08/) in [PR #79](https://github.com/ading2210/poe-api/pull/79).\n\nMost of the GraphQL queries are taken from [muharamdani/poe](https://github.com/muharamdani/poe), which is licensed under the ISC License. \n\n### Copyright Notice:\n```\nading2210/poe-api: a reverse engineered Python API wrapper for Quora's Poe\nCopyright (C) 2023 ading2210\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program. If not, see <https://www.gnu.org/licenses/>.\n```\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "A reverse engineered API wrapper for Quora's Poe",
"version": "0.5.3",
"project_urls": {
"Homepage": "https://github.com/ading2210/poe-api"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "df4e44c286df7e8d2facc6db6e06f7b6cd51b790bb9cc7fe20224688ccf0a617",
"md5": "d0ecd9d868e2dfc5576169531be2d28a",
"sha256": "2a950acdfe04fa685eaf4b63e5214a81c8b6ee48a378d961344a38eb6c404339"
},
"downloads": -1,
"filename": "poe_api-0.5.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d0ecd9d868e2dfc5576169531be2d28a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 72416,
"upload_time": "2023-09-18T04:53:02",
"upload_time_iso_8601": "2023-09-18T04:53:02.798272Z",
"url": "https://files.pythonhosted.org/packages/df/4e/44c286df7e8d2facc6db6e06f7b6cd51b790bb9cc7fe20224688ccf0a617/poe_api-0.5.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-18 04:53:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ading2210",
"github_project": "poe-api",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "poe-api"
}
JSON
