Live-only uploads, reposts, and LIVE start/end. Adding, restarting, recovering, or reconnecting never replays history.
Send X-API-Key or Authorization: Bearer …. Mutations also require a stable Idempotency-Key.
Use the opaque tenant path and Authorization: Bearer … or X-WS-Key. Delivery is live-only with no reconnect replay. Video frames may include object.media_url; photos/carousels use image_urls. object.kind is video, photo, or carousel. Captions are description; structured mentions and hashtags come from TikTok textExtra when present (including non-ASCII tags). When the origin has a playable prefix, a sibling tiktok.media.ready frame (1322.tiktok.media.v1) repeats that event_id, permalink url, and playable media_url. It is not a second post. Raw TikTok play_url is never on customer payloads. Incomplete media is no-store; complete media is edge-cacheable.
| Method | Path | Authentication | Purpose |
|---|---|---|---|
| GET | / | Public | Customer API documentation |
| POST | /admin/backup idempotent mutation | Admin bearer + IP | Backup create |
| GET | /admin/clients | Admin bearer + IP | Clients list |
| POST | /admin/clients idempotent mutation | Admin bearer + IP | Client create |
| DELETE | /admin/clients/:client_id idempotent mutation | Admin bearer + IP | Client delete |
| GET | /admin/clients/:client_id | Admin bearer + IP | Client get |
| PATCH | /admin/clients/:client_id idempotent mutation | Admin bearer + IP | Client patch |
| POST | /admin/clients/:client_id/api/disable idempotent mutation | Admin bearer + IP | Client api disable |
| POST | /admin/clients/:client_id/api/enable idempotent mutation | Admin bearer + IP | Client api enable |
| POST | /admin/clients/:client_id/discord/disable idempotent mutation | Admin bearer + IP | Client discord disable |
| POST | /admin/clients/:client_id/discord/enable idempotent mutation | Admin bearer + IP | Client discord enable |
| POST | /admin/clients/:client_id/extend idempotent mutation | Admin bearer + IP | Client extend |
| POST | /admin/clients/:client_id/move idempotent mutation | Admin bearer + IP | Client move |
| POST | /admin/clients/:client_id/regenerate idempotent mutation | Admin bearer + IP | Credential api rotate |
| POST | /admin/clients/:client_id/regenerate-api idempotent mutation | Admin bearer + IP | Credential api rotate |
| POST | /admin/clients/:client_id/rotate-ws idempotent mutation | Admin bearer + IP | Credential websocket rotate |
| GET | /admin/clients/:client_id/tracked | Admin bearer + IP | Client tracks |
| POST | /admin/clients/:client_id/websocket/disable idempotent mutation | Admin bearer + IP | Client websocket disable |
| POST | /admin/clients/:client_id/websocket/enable idempotent mutation | Admin bearer + IP | Client websocket enable |
| GET | /admin/detectors/health | Admin bearer + IP | Detector health |
| GET | /admin/reports/expiring | Admin bearer + IP | Report expiring |
| GET | /admin/reports/near-limit | Admin bearer + IP | Report near limit |
| GET | /admin/reports/summary | Admin bearer + IP | Report summary |
| GET | /admin/ws/firehose | private admin bearer | Private live-only committed-event WebSocket |
| POST | /discord/interactions | Discord Ed25519 signature | Optional signed Discord interaction ingress |
| GET | /health | Public | Process liveness |
| GET | /healthz | Public | Process liveness |
| GET | /openapi.json | Public | OpenAPI 3.1 contract |
| GET | /readyz | Public | Dependency readiness |
| GET | /v1/dashboard | Client API key | Tenant dashboard |
| GET | /v1/docs | Public | Human-readable API reference |
| GET | /v1/health | Client API key | Tenant health |
| GET | /v1/limits | Client API key | Tenant quotas |
| GET | /v1/list | Client API key | List tracked accounts |
| GET | /v1/media/{video_id}.mp4 | HMAC query signature | Short-lived cached mp4; first detect never waits on this fetch |
| GET | /v1/status | Client API key | Tenant status |
| POST | /v1/track idempotent mutation | Client API key | Track an account without history |
| PATCH | /v1/tracks/:track_id idempotent mutation | Client API key | Change tracked event and delivery settings |
| POST | /v1/untrack idempotent mutation | Client API key | Stop tracking an account |
| GET | /v1/ws/status | Client API key | Tenant WebSocket status |