Live Data API — HAL 8580 User Guide
Send live values like the current song or game to HAL 8580 from your own tools with the live data API, so HAL can mention them in Twitch chat.
Live data is on Premium. Your own tools send values to HAL, like the song you're playing, the tempo, the game or a goal, and HAL mentions them when they fit the conversation. You find it in the dashboard under What HAL knows, then Live data.
Values
Each value has:
- Key: a short name in lowercase letters, digits and underscores, like
now_playing. - Value: text, a number, true or false, or JSON.
- Remove after (seconds): optional. Leave it empty to keep the value until you remove it. 3600 is one hour. Set it for values that go stale.
- Description: optional. Helps HAL understand the value, like "The song I'm playing".
You can add a value by hand on the Live data page, and see every value HAL currently has. Values that come from HAL itself can't be edited.
Sending values from your tools
Any tool that can make a web request can send values to HAL: a song tracker, a heart-rate monitor, a stream deck. Every request needs your API token in the Authorization header. Get the token in your dashboard under Plan and account, then Settings, and keep it secret. If it leaks, make a new one and the old one stops working.
The requests:
POST /api/public/data adds a value.GET /api/public/data gets every value.GET /api/public/data/:key gets one value.PUT /api/public/data/:key changes a value.DELETE /api/public/data/:key removes a value.DELETE /api/public/data?confirm=yes removes every value.
Body for adding a value (ttl is optional, in seconds):
{
"key": "current_game",
"value": "Elden Ring",
"ttl": 3600,
"description": "Currently playing game"
}
Body for changing a value:
{ "value": "Dark Souls 3", "ttl": 7200 }
Example with curl:
curl -X POST https://hal8580.com/api/public/data \
-H "Authorization: hal_your_api_token_here" \
-H "Content-Type: application/json" \
-d '{
"key": "sub_goal",
"value": {"current": 45, "target": 50},
"ttl": 3600,
"description": "Subscriber goal for today"
}'
The full API reference is at hal8580.com/api/docs.
Connected services
Under Plan and account, then Settings, you can connect RaidRunner, Patreon and StreamScanner. They let HAL see your raid train, new patrons and stream events, so it can talk about them.
HAL 8580 is an AI-powered chat bot for Twitch streamers. It joins your chat as a co-host, talks with your viewers, welcomes raids and regulars, and remembers your community. 15 personalities. Free to start.
This site is a single-page application and requires JavaScript to use the dashboard. To learn more or sign up, please enable JavaScript and reload.