Introduction
Introduction
Welcome to the ai_licia platform documentation. This short primer orients you before diving into the Public API, REST endpoints, or EventSub stream.
What you can build
- Automations – Feed real-time data (game state, alerts, custom triggers) so ai_licia can respond in chat and TTS.
- Dashboards – Monitor EventSub to visualize chat, AI activity, or moderation decisions in your control panels.
- Extensions & bots – Combine REST calls with EventSub streams to implement round-trip experiences, e.g., button presses that trigger AI callouts and reactions streamed back to your UI.
Key surfaces
| Surface | Purpose | Quick links |
|---|---|---|
| REST API | Send contextual events or request on-demand AI generations. | REST overview |
| EventSub (SSE) | Receive chat, AI messages, moderation, channel events, and system updates in one stream. | EventSub overview |
| SDKs | Official libraries to integrate faster (currently TypeScript/Node). | SDKs |
Getting ready
- Review Authentication to obtain or rotate your channel API key.
- Use the OpenAPI spec or ReDoc reference if you prefer working from schemas.
- Pick your integration path:
- Write-first (REST) if you only need to send context or triggers.
- Read-first (EventSub) if you care about ai_licia’s responses, moderation, and channel system events.
- Both for closed-loop automations.
Continue with the Public API Overview for deeper details on scopes, rate limits, and feature guides.