Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kramcat/CharacterAI
Unofficial Python API for character.ai
https://github.com/kramcat/CharacterAI
api characterai client python wrapper
Last synced: 3 months ago
JSON representation
Unofficial Python API for character.ai
- Host: GitHub
- URL: https://github.com/kramcat/CharacterAI
- Owner: kramcat
- License: mit
- Created: 2023-04-28T16:47:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-17T07:54:04.000Z (8 months ago)
- Last Synced: 2024-10-01T21:47:45.249Z (4 months ago)
- Topics: api, characterai, client, python, wrapper
- Language: Python
- Homepage: https://docs.kram.cat
- Size: 238 KB
- Stars: 434
- Watchers: 10
- Forks: 61
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Support: docs/support.rst
Awesome Lists containing this project
README
[](https://pepy.tech/project/characterai)
[](https://opensource.org/licenses/MIT)
[](https://github.com/kramcat/characterai)
[](https://discord.com/invite/ZHJe3tXQkf)
Welcome to the documentation for a synchronous/asynchronous unofficial library for CharacterAI using [curl_cff](https://github.com/yifeikong/curl_cffi)
### 💻 Installation
```bash
pip install git+https://github.com/kramcat/CharacterAI.git
```
### ⚠️ Warning
This version of the library is in alpha version, there may be bugs and errors. The library was developed without the participation of Character AI developers or their knowledge. To work with the library you need to know how to work with [asyncio](https://docs.python.org/3/library/asyncio.html)
### 🔥 Features
- Supports logging in via email or as a guest
- Does not use web browsers like: Pypeeter, Playwright, etc.
- Supports uploading/downloading pictures
- Has detailed documentation
- Uses Pydantic
- Asynchronous
### 📙 Simple Example
You need an account to use the library. To find out your token, you must [log in through the library](https://docs.kram.cat/auth.html)
```python
from characterai import aiocai
import asyncio
async def main():
char = input('CHAR ID: ')
client = aiocai.Client('TOKEN')
me = await client.get_me()
async with await client.connect() as chat:
new, answer = await chat.new_chat(
char, me.id
)
print(f'{answer.name}: {answer.text}')
while True:
text = input('YOU: ')
message = await chat.send_message(
char, new.chat_id, text
)
print(f'{message.name}: {message.text}')
asyncio.run(main())
```
### 📚 Documentation
The documentation contains all the detailed information about functions and types. If you have any questions, first of all read whether there is an answer in the documentation
**[docs.kram.cat](https://docs.kram.cat)**
### 👥 Community
If you have any questions about our library or would like to discuss CharacterAI, LLM, or Neural Networks topics, please visit our Discord channel
**[discord.gg/ZHJe3tXQkf](https://discord.com/invite/ZHJe3tXQkf)**
### 📝 TODO List
- [ ] Character voice work
- [ ] Community tab support
- [ ] Add logging
- [ ] Group chat support
- [ ] Improved work with uploading pictures
### 💵 Support
TON - `EQCSMftGsV4iU2b9H7tuEURIwpcWpF_maw4yknMkVxDPKs6v`
BTC - `bc1qghtyl43jd6xr66wwtrxkpe04sglqlwgcp04yl9`
ETH - `0x1489B0DDCE07C029040331e4c66F5aA94D7B4d4e`
USDT (TRC20) - `TJpvALv9YiL2khFBb7xfWrUDpvL5nYFs8u`
You can contact me via [Telegram](https://t.me/kramcat) or [Discord](https://discordapp.com/users/480976972277874690) if you need help with parsing services or want to write a library. I can also create bots and userbots for Telegram