Requirements.

Installation & Usage

pip install

pip install cheshire-cat-api

importcheshire_cat_apiasccat

Interact with the HTTP Endpoints

Available APIs

Instantiate connection

importcheshire_cat_apiasccat# A config is necessary to set up base parameters like# URL, port, user_id, etc.config=ccat.Config(user_id="my_user_42")# Connect to the APIcat_client=ccat.CatClient(config=config)

Plugin API - Retrieve plugins

# Now retrieve a list of the available pluginsplugins=cat_client.plugins.get_available_plugins()

RabbitHole API - Upload a URL

fromcheshire_cat_api.models.body_upload_urlimportBodyUploadUrl# Please note that interacting with the RabbitHole to upload# a URL requires structuring the body like thisbody_upload_url=BodyUploadUrl(url="https://cheshire-cat-ai.github.io/docs/conceptual/cheshire_cat/rabbit_hole/")# then you can make the request as followsresponse=cat_client.rabbit_hole.upload_url(body_upload_url)

Send a WebSocket message

importtimeimportcheshire_cat_apiasccat# A config is necessary to set up base parameters like# URL, port, user_id, etc.config=ccat.Config(user_id="my_user_42")cat_client=ccat.CatClient(config=config)# Connect to the WebSocket APIcat_client.connect_ws()whilenotcat_client.is_ws_connected:# A better handling is strongly advised to avoid an infinite looptime.sleep(1)# Send the messagecat_client.send(message="Hello Cat!")# Close connectioncat_client.close()

Documentation for Config

fromcheshire_cat_apiimportConfig

Low-level API