API reference

Exports

  • AiliciaClient
  • Public types from ./interfaces (EventSub types, payloads, stream options, and chat types)

Methods

MethodPurpose
sendEvent(content, ttl?)Send contextual data via REST.
triggerGeneration(content)Trigger an immediate AI response.
listCharacters()List characters available to the authenticated streamer.
setActiveCharacter(characterId)Set the active character for the streamer.
requestStreamJoin(channelName?)Ask ai_licia to join a channel.
requestStreamLeave(channelName?)Ask ai_licia to leave a channel.
streamEventSub(options?)Subscribe to the unified EventSub SSE stream.
streamPublicChatMessages(options)Legacy public chat SSE (deprecated).
AiliciaClient.getInstance(config)Get or create a singleton instance.

Environment variables

NamePurpose
AI_LICIA_API_URLOverride API base URL (default: https://api.getailicia.com/v1).
AI_LICIA_API_KEYAPI key for authentication.
AI_LICIA_CHANNELDefault channel name for requests.