API overview
The dcast API adds video platform capabilities to your site or app: ingest, transcoding, live streaming, multistream, real-time video rooms, analytics, monetization, and notifications. You call the Partner API base URL below; we run the underlying media, storage, CDN, and real-time infrastructure.
What is available today
- Upload & VOD — Direct worker upload (
POST /videos/upload, same handler asPOST /videos), chunkedContent-RangePUT toupload.url, status/progress, embed, download, patch, delete. Likes (idempotent toggle), comment edit & delete (author or video-owner moderation), public view registration (24h dedup), and related videos. See Upload flows and Videos. - Cloud editor — Metadata, export jobs (plan-gated). Video editor.
- Live & multistream — Streams (RTMP, SRT, WebRTC, HTTP pull), PATCH, end, status, thumbnail, recording. Restreams with encoder URLs, start/stop, recording. Live chat per stream (GET/POST/DELETE + SSE tail) with source tagging for cross-platform aggregated messages. Streams, Restreams, Recording.
- Rooms — Create/update, tokens, participants (list, admit, kick, mute), start/end, recording, host reactions. Rooms.
- Channels — Public profile lookup (
GET /channel/:username) with display name, counts, live status, public tier roster, and storefront URLs. Owner-of-key sees extras (email, plan, storage). Channels. - Discovery — Withdrawn:
GET /search,GET /trendingandGET /feedanswer410 CATALOG_DISABLED. Content is reached by its link or through one creator's channel. Discovery. - Analytics — Account, per-video, per-stream, summary, stats, geography. Analytics.
- Monetization — Tiers (read and manage), checkout, purchases, subscribers, read-only payout history. Onboarding and payout configuration are admin-controlled (not exposed via Partner API):
GET /monetization/payments;GET /tiers,POST /tiers,PATCH /tiers/:id,DELETE /tiers/:id,GET /purchases;GET /subscribers,POST /subscribers,DELETE /subscribers/:userId,GET /me/subscriptions;POST /checkout/subscription(POST /checkout/videois retired: paid videos are bought inside the embedded player). Monetization; building a site with free, members-only and paid titles: Recipe: paid catalog. - Notifications — List, unread count, read/all, preferences, delete. Notifications.
- Team access (session API) — Invites, member roles, per-resource allowlists (videos, streams, restreams, rooms), delegated workspace (
X-Effective-Channel-Id), team chat, and team tasks use/api/teamswith a user access token, not the Partner API key. Team & scopes. - System —
/health,/me,/quota. Account & quota. - Limits & delivery — Errors & rate limits; event delivery via polling and Notifications. Webhooks (optional HTTPS callbacks) — see current scope on that page.
Base URL and auth
Base URL: https://api.dcast.pro/api/v1
Auth: Authorization: Bearer YOUR_API_KEY — a key is pk_ followed by 40 hex characters. Keep it on your server.
Machine-readable
- /openapi.json — OpenAPI 3.1 spec of every Partner API route (also at
https://api.dcast.pro/api/v1/docs/openapi.json). - /llms.txt — index of every docs page and the key methods, for AI assistants.
- Markdown version of every docs page: append
.mdto its URL, e.g. /docs/quickstart.md. GET https://api.dcast.pro/api/v1/changelog— public changelog.
Sign up on this site, then open the dashboard → Settings → API Keys. Trial keys are available with limited request quotas before you upgrade.
Quickstart
1. Create an API key in the dashboard.
2. Check health (no key):
curl -s https://api.dcast.pro/api/v1/health3. List videos:
curl -s -H "Authorization: Bearer YOUR_API_KEY" "https://api.dcast.pro/api/v1/videos?limit=5"Next: Quickstart (includes a QA curl checklist), Authentication.
What is still on the roadmap
Granting a specific viewer access over the API, session-level analytics, gift checkout, more webhook events, and developer tooling (MCP server, TypeScript SDK, CLI) are planned — see Roadmap for the authoritative list.
