Introduction
Work with your Vidyst webinars, registrants, recordings and analytics from your own systems.
The Vidyst API lets your own systems work with your Vidyst account: webinars, registrants, recordings and analytics. It's a REST API over HTTPS: JSON in, JSON out, authenticated with an API key.
Every request goes to:
https://vapi.vidyst.com/public/v1The API is for server-to-server calls. Keys are secrets, so requests from a browser are refused: the API sends no CORS headers.
Quickstart
Create an API key
In the Vidyst studio, go to Developer → API keys and create a key. Choose what it may do (its scopes) and copy the secret: it's shown only once.
Check that it works
GET /auth/verify needs no scope and tells you what the key may do:
curl https://vapi.vidyst.com/public/v1/auth/verify \
-H "Authorization: Bearer vk_live_…"{
"valid": true,
"key": {
"name": "Production server",
"prefix": "vk_live_4fQ9zK2mXp7L",
"mode": "live",
"scopes": ["webinars:read", "registrants:read"],
"expiresAt": "2027-02-01T09:30:00.000Z"
},
"rateLimit": { "limit": 120, "remaining": 119, "windowSeconds": 60 }
}Build your integration
Read Authentication for how to keep and roll keys, Rate limits for the limits and their headers, and Errors for what to do with each failure. Every endpoint is in the API reference.
Conventions
- Timestamps are ISO 8601 in UTC (
2026-11-03T09:30:00.000Z), ids are UUIDs, and field names are camelCase. - Errors are RFC 9457 problem details. Branch on their
code, never on the wording ofdetail. - Ignore response fields you don't know: new ones are added within
v1. See Versioning.