Interfaces

Interfaces are services that allows third party applications to interact with Newelle. Interfaces can be added by Newelle Extensions and can be used to connect external services (like messaging apps), provide alternative UIs, use Newelle remotely or integrate it somewhere else.

By default, Newelle provides these interfaces:

• OpenAI Compatible API: allows Newelle integration with services that need an OpenAI compatible API (Supports LLM, TTS and STT)
• Newelle GUI API: Allows deeper integration and interaction with Newelle, seeing chats, switching profiles, changing settings etc.
• Telegram Bot: Chat with Newelle on Telegram

Starting an interface

Interfaces can be started via GUI or Terminal.

Starting an interface via GUI

TODO

Starting an interface via Terminal

Warning

The following commands will consider Newelle installed as a package. If you installed Newelle as a flatpak, run flatpak run io.github.qwersyk.Newelle instead of newelle

• Listing the available interfaces

newelle --interfaces

• Running an interface in headless mode

newelle --interface interface

For example, to start the telegram interface without the gui,

newelle --interface telegram