An unofficial API Client for CharacterAI, written in Golang, ported over from Python.
Original Python source code in this repo: https://github.com/kramcat/CharacterAI
Original Readme kept for reference: Original Readme
This repo is currently very barebone and not optimized for productive usage in golang applications yet. Any support with testing, verifying functionality and adding proper golang struct handling is heavily appreciated.
You have questions, need help, or just want to show your support? Reach us here: Discord Server & Patreon page.
- Port over API from source repo
- Confirm basic functionality
- Write tests for all API Methods
- Golang QOL improvements
- Create Wrapper Structs for API Endpoints + Parse them within the API methods
- Add proper WebSocket client for V2 / Websocket API
go get github.com/harmony-ai-solutions/CharacterAI-GolangDetailed documentation and Apidocs coming soon
Example code for a simple, functional Chat app. The code can also be found in example.go
package main
import (
"bufio"
"fmt"
"github.com/harmony-ai-solutions/CharacterAI-Golang/cai"
"os"
"strconv"
"strings"
)
func main() {
// Initial params - Usage of env vars recommended
//token := ""
//character := ""
//isPlus := false
token := os.Getenv("CAI_TOKEN")
character := os.Getenv("CAI_CHAR")
isPlus, errParse := strconv.ParseBool(os.Getenv("CAI_PLUS"))
if errParse != nil {
isPlus = false
}
// Create client
caiClient, errClient := cai.NewGoCAI(token, isPlus)
if errClient != nil {
fmt.Println(fmt.Errorf("unable to create client, error: %q", errClient))
os.Exit(1)
}
// Get chat data
chatData, errChat := caiClient.Chat.GetChat(character)
if errChat != nil {
if strings.Contains(errChat.Error(), "404") {
// Chat does not exist yet, create new
chatData, errChat = caiClient.Chat.NewChat(character)
if errChat != nil {
fmt.Println(fmt.Errorf("unable to create chat, error: %q", errChat))
os.Exit(3)
}
} else {
fmt.Println(fmt.Errorf("unable to fetch chat data, error: %q", errChat))
os.Exit(2)
}
}
// Find AI paricipant in chat
var aiParticipant *cai.ChatParticipant
for _, participant := range chatData.Participants {
if !participant.IsHuman {
aiParticipant = participant
break
}
}
// Get History for chatroom
if chatHistoryData, errHistory := caiClient.Chat.GetHistory(chatData.ExternalID); errHistory != nil {
fmt.Println(fmt.Errorf("unable to parse user data"))
os.Exit(4)
} else {
fmt.Println("Previous messages (up to 5):")
messageHistory := chatHistoryData.Messages
if len(chatHistoryData.Messages) > 5 {
messageHistory = messageHistory[len(messageHistory)-5:]
}
for _, message := range messageHistory {
fmt.Println(fmt.Sprintf("%v: %v", message.SourceName, message.Text))
}
}
for true {
fmt.Println("Enter user message: ")
scanner := bufio.NewScanner(os.Stdin)
scanner.Scan()
errInput := scanner.Err()
if errInput != nil {
fmt.Println(fmt.Errorf("unable to scan user input. Error: %v", errInput))
os.Exit(6)
}
// Send
messageResult, errMessage := caiClient.Chat.SendMessage(chatData.ExternalID, aiParticipant.User.Username, scanner.Text(), nil)
if errMessage != nil {
fmt.Println(fmt.Errorf("unable to send message. Error: %v", errMessage))
os.Exit(7)
}
// Handle result
if len(messageResult.Replies) > 0 {
firstReply := messageResult.Replies[0]
fmt.Println(fmt.Sprintf("%v: %v", aiParticipant.Name, firstReply.Text))
fmt.Println()
}
}
Project Harmony.AI emerged from the idea to allow for a seamless living together between AI-driven characters and humans. Since it became obvious that a lot of technologies required for achieving this goal are not existing or still very experimental, the long term vision of Project Harmony is to establish the full set of technologies which help minimizing biological and technological barriers in Human <-to-> AI Interaction.
We want to counter today's tendencies of AI development centralization at the hands of big corporations. We're pushing towards maximum transparency in our own development efforts, and aim for our software to be accessible and usable in the most democratic ways possible.
Therefore, for all our current and future software offerings, we'll perform a constant and well-educated evaluation whether we can safely open source them in parts or even completely, as long as this appears to be non-harmful towards achieving the project's main goal.
Also, we're constantly striving to keep our software offerings as accessible as possible when it comes to services which cannot be run or managed by everyone - For example our Harmony Speech TTS Engine. As long as this project exists, we'll be trying out utmost to provide free tiers for personal and public research use of our software and APIs.
However, at the same time we'll also ensure everyone who supports us or actively joins forces with us on our journey, gets something proper back in turn. Therefore we're also maintaining a Patreon Page with different supporter tiers, as we are open towards collaboration with other businesses.
Feel free to join our Discord Server and / or subscribe to our Patreon - Even $1 helps us drive this project forward.
Contact us directly via: contact@project-harmony.ai
© 2023 Harmony AI Solutions & Contributors
Licensed under the Apache 2.0 License