semvec/pypi-packages huggingface dataset:
characterai 1.0.1
An unofficial API for Character AI for Python
License: MIT
Keywords: ai wrapper api library

######
AioCAI
######

|tag1| |tag2| |tag3| |tag4|

.. |tag1| image:: https://img.shields.io/pepy/dt/characterai?style=flat-square
    :target: https://pypi.org/project/characterai
    :alt: Total Downloads

.. |tag2| image:: https://img.shields.io/pypi/l/characterai?style=flat-square
    :target: https://opensource.org/licenses/MIT
    :alt: MIT License

.. |tag3| image:: https://img.shields.io/github/stars/kramcat/characterai?style=flat-square
    :target: https://github.com/kramcat/characterai
    :alt: Discord

.. |tag4| image:: https://img.shields.io/discord/1120066151515422772?style=flat-square
    :target: https://discord.com/invite/ZHJe3tXQkf
    :alt: Stars


Welcome to the documentation for a synchronous/asynchronous unofficial library for CharacterAI using `curl_cffi <https://github.com/yifeikong/curl_cffi>`_

⚠️ 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
-----------------
.. code-block:: python3

    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())


👥 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 - ``UQBlGz8aw5tWaocR8gPppQe6SgTx-kkh5keInKtEzVOqPhdY``
| 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