Skip to main content
New to Corsair? See API access, authentication, and error handling.

Access

get

access.get Read a student access record for one course Risk: read
Input Output: object[] \| object

update

access.update Expire a student access record Risk: write
Input Output: string \| number \| object \| object[] \| null \| undefined

updateCode

access.updateCode Expire a gallery access code Risk: write
Input Output: string \| number \| object \| object[] \| null \| undefined

Assets

upload

assets.upload Upload an asset file to the account library Risk: write
Input The file is sent as multipart form data. Output: string \| number \| object \| object[] \| null \| undefined

Domains

add

domains.add Allow one more domain to embed your videos Risk: write
Input Output: string \| number \| object \| object[] \| null \| undefined

list

domains.list List the domains a video may be embedded on Risk: read
Input: empty object Output: object[]

Projects

create

projects.create Create a project to file videos under Risk: write
Input Output: string \| number \| object \| object[] \| null \| undefined

list

projects.list List the projects (video groups) on the account Risk: read
Input: empty object Output: object[]

search

search.search Search videos, projects and other objects on the account Risk: read
Input The term is sent in the body as query; the reference lists no parameters for this route. Output: object[] \| object

Students

create

students.create Create a course or gallery student with an access record Risk: write
Input expires takes a date or the literal “0000-00-00” when never is true. Output: string \| number \| object \| object[] \| null \| undefined

Videos

create

videos.create Create a video from a hosted link or an uploaded file, optionally copying player settings from another video Risk: write
Input Pass either url or file. url wins when both are given, and hls asks for HLS encoding. Output: string \| number \| object \| object[] \| null \| undefined

delete

videos.delete Delete one or more videos; there is no restore route Risk: destructive · Irreversible
Input There is no restore route. Each ID is sent as its own IDs[] form field, the format the API accepts. Output: string \| number \| object \| object[] \| null \| undefined

list

videos.list List videos (1000 a page), or one video by numeric ID, optionally narrowed to a project Risk: read
Input Pass video_id for one video or video_group to narrow to a project. Video IDs are the numeric IDs this route returns, not the base64 form in a watch URL. The answer is a page object under videos (1000 videos a page); pass page for the next one. Output

listTop

videos.listTop List the most-watched videos over a window of days Risk: read
Input Output: object[]

metrics

videos.metrics Read a video load, play, watch and share counts Risk: read
Input The only response body Spotlightr documents. The field is completitionRate, not completionRate. Output

updateSettings

videos.updateSettings Change individual player settings on a video Risk: write
Input settings carries only the keys to change, as a JSON object. Output: string \| number \| object \| object[] \| null \| undefined

updateSource

videos.updateSource Point an existing video at a new source URL, replacing the old source Risk: destructive
Input Replaces the video source; the old URL is not kept, so this is marked destructive. Output: string \| number \| object \| object[] \| null \| undefined

views

videos.views List a video views (30 a page), optionally for one known viewer or only those past one percent watched Risk: read
Input The answer is a page object with data, summary and 30 views a page; pass page for the next one. Output