Developer Docs
Changelog
Versioned, dated changes to the public Toktik API: new endpoints, new fields and deprecations, newest first.
Dated, developer-facing changes to the public API and SDKs — new endpoints, new events, changed costs, releases. This is distinct from our internal engineering changelog.
- added
v1New: Goody-bag feed — watch sets, a capacity read and a goodybag.* WebSocket plane
Choose the LIVE rooms to watch (the best-ranked N, or creators you name) and receive each goody bag once, the moment it appears, on the realtime socket. PUT/GET/DELETE /v1/goodybag/watch-set and GET /v1/goodybag/capacity under the new goodybag:manage scope; the feed is goodybag.subscribe → goodybag.status / goodybag.event on the existing socket under the new goodybag:read scope, carried in the handshake token only while your workspace's grant is in force. A granted capability (contact us); not credit-metered. See the Goody-bag feed guide.
- removed
v1Removed: LIVE session list + detail, the live_sessions export — SDKs sdk-js 0.3.0 / toktik 0.2.0
GET /v1/live/sessions and GET /v1/live/sessions/:id now answer 410 endpoint_removed (never billed); the live_sessions export dataset and the playground's liveSessions operation are gone. Per-creator LIVE history stays at GET /v1/live/creators/:uid/performance. This is an exception to the /v2 rule below: the endpoints had no external traffic. @toktikhq/sdk-js 0.3.0 and toktik 0.2.0 drop the session methods and take the full export request in exports.create.
- changed
v1Exports carry revenue and earnings; Whale intel depth by plan; new creator_gifters export
Every export adds est_revenue_usd / est_earnings_usd (estimates from diamonds; blank on Shopping boards, which score in points); gifters exports take region + segment; creator_roster adds identity, boards and gifts received 24h/7d/30d. GET /v1/creators/:handle/gifters (+ /live) returns Free the top 3 gifters, Starter the top 3, Pro+ all, with totals from Starter up and an access object describing the cap. New export dataset creator_gifters. GET /v1/watchlist adds giftTotals, gifterSummary.windows and giftTotalsAccess. Rankings/gifters exports require the Live module (403 module_not_entitled).
- added
v1New endpoints: Creator Stories, Watchlist API, LIVE playback, creator search, alert-rule editing
GET /v1/creators/:uid/stories (content:read) returns a creator's active story tray. The workspace Watchlist is now an API: GET/POST/DELETE /v1/watchlist under the new watchlist:manage scope (not credit-metered). GET /v1/creators (creator:read) searches the observed creator set, and GET /v1/live/creators/:uid/playback (live:stream) returns HLS/FLV sources for a live room. Alert rules gained PATCH, DELETE and a test-fire POST. Every response now carries a full typed schema in the OpenAPI reference.
- added
v1Developer docs: Realtime guide, SDK pages, versioning, changelog & status
Full Realtime guide with the complete event-type reference (10 events, no more), SDK docs for both clients with runnable samples, plus this versioning policy, public changelog and live status page.
- added
v1Python SDK — toktik 0.1.0
Official Python client: dependency-free REST plus an asyncio realtime LIVE-event client. Feature parity with @toktikhq/sdk-js.
- added
v1JavaScript SDK — @toktikhq/sdk-js 0.2.0
Namespaced typed client (rankings, live, creators, content, gifters, trends, exports, account) plus the realtime stream client.
- added
v1Realtime LIVE event WebSocket
Any-creator realtime stream at /v1/live/stream with a REST-minted handshake token, honest queued/active/offline statuses, and room-minute metering.
- added
v1Public /v1 data-plane + OpenAPI contract
Bearer-key REST surface across rankings, live, gifters, creators, content and trends, served with a live GET /openapi.json.