Endpoint index
Every address your systems can use, and what each does in plain English. API calls need the header Authorization: Bearer rck_live_… unless stated.
- POST
/api/public/v1/playback-tokensNeeds API keyGives you a short-lived pass and embed link so a private or restricted video plays on your named websites.
- POST
/api/public/v1/editor-tokensNeeds API keyGives you a short-lived pass to open the editor for one project, with view, edit or submit rights, on your named websites.
- GET
/api/public/v1/videosNeeds API keyLists and searches the videos in your workspace, 25 at a time by default.
- GET
/api/public/v1/videos/{slug}Needs API keyShows one video's details and its approved release history, marking which version is live.
- GET
/api/public/v1/embed-sdk.jsNo key neededThe helper script for your web pages: listens for player updates and turns them into training reports.
- GET
/embed/{slug}?org=&pt=&ref=No key neededThe video player for an iframe. Add pt for private videos and ref for your viewer reference.
- GET
/embed-editor/{projectId}?et=No key neededThe editor for an iframe. Needs an editor pass in et and must be opened from an allowed website.
Common errors
401 invalid_api_key: the key is missing, wrong or switched off. 400 invalid_request: the request body is malformed. 400 invalid_allowed_domain, invalid_scopes or invalid_brand: check hosts, scopes and branding (hex colour, https logo). 404: the video or project doesn't exist in this workspace, isn't published, or is under review. 429: more than 120 requests in a minute — wait 60 seconds.