A Python wrapper for the SplitticAPI
Project description
The SplitticAPI Library provides a convenient Python interface for interacting with the Splittic API, enabling users to seamlessly integrate Splittic’s AI functionality into their applications. The library is designed to be user-friendly and versatile, supporting both asynchronous and synchronous programming.
Installation
To install the SplitticAPI Library, use the following command:
pip install SplitticAPI
Getting Started
Obtain API Key:
Visit the FreeAI Discord server.
Retrieve your API key from the #api channel.
Initialize ChatModule:
Import the ChatModule class from SplitticAPI.meowgpt.
Set the global API key using ChatModule.initialize(api_key).
Create a Chat Instance:
Create a new chat instance using ChatModule.create_chat(api_key).
Each instance automatically generates a unique chat ID.
Send Messages:
Use the reply(message) method to send a synchronous message and receive a reply.
Optionally, use the async_reply(message) method for asynchronous interactions.
Generate Images with DiffusionModule:
Import the DiffusionModule class from SplitticAPI.interdiffusion.
Initialize DiffusionModule with your API key.
Use the generate() method for synchronous image generation.
Alternatively, use async_generate() for asynchronous image generation.
The generated image is saved as “output.png” by default.
Example
from SplitticAPI.meowgpt import ChatModule
from SplitticAPI.interdiffusion import DiffusionModule
# Set the global API key
api_key = "your_api_key_here"
ChatModule.initialize(api_key)
# Create a ChatModule instance with a unique chat ID
chat_instance = ChatModule.create_chat(api_key)
# Send a synchronous message and get a reply
def main():
reply = chat_instance.reply("Hi")
print(reply)
# Generate an image synchronously
diffusion_module = DiffusionModule(api_key)
diffusion_module.generate("cat")
# Run the program
if __name__ == "__main__":
main()
For more detailed information, refer to the official Splittic API documentation.
License
This library is released under the MIT License. Feel free to use, modify, and distribute it according to your needs.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file SplitticAPI-1.4.2.tar.gz
.
File metadata
- Download URL: SplitticAPI-1.4.2.tar.gz
- Upload date:
- Size: 4.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4917049c04e47f71765aaae75e3e19a911a3af5983dfc307cc989e10bee780fb |
|
MD5 | dcc11d5089737d6786e7e9e11f11b1b7 |
|
BLAKE2b-256 | cc560993764bb7e9ba9935497d30b4cc09fa0f237f618c7a9b473db3de1e35ab |
File details
Details for the file SplitticAPI-1.4.2-py3-none-any.whl
.
File metadata
- Download URL: SplitticAPI-1.4.2-py3-none-any.whl
- Upload date:
- Size: 5.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef20b01402e74101474201b53d7df1aa8acdf8d0d5cecced47940e46a51b1ded |
|
MD5 | 26f6c516ee0c679187f0a607917838c4 |
|
BLAKE2b-256 | e13adef3df7734b3fe3df3dd5eb1b2a75a22d40dd098209fc3ecddfc57957a82 |