Skip to main content
Use Spotlightr through Corsair: one client, typed API calls. Create an API key in Spotlightr under Settings, Integrations and APIs, then Get API key. The plugin sends it as the vooKey parameter on every request, which is the only form the API reads, and masks it in errors and in the page URLs Spotlightr echoes back. Things to know:
  • The REST API is narrow. It covers videos, projects, embed domains, course students and access records, and view analytics. Playlist, quiz and lead management have no REST route and are not exposed.
  • Response bodies are barely documented. Spotlightr’s reference lists request parameters and gives one sample response, the metrics object. The plugin types that object exactly (including Spotlightr’s completitionRate spelling) and accepts the other routes’ answers as open objects, rather than inventing fields.
  • Booleans are 1 and 0. The reference documents flags that way, so the plugin converts true to 1 before sending.
  • Uploads are multipart. videos.create and assets.upload take a Blob, so the file never passes through JSON.
  • videos.delete cannot be undone. There is no restore route.
  • A wrong key reads as a plain string. A 401 body is literally "Unauthorized.", and a missing one is "Missing token.". Some routes answer an HTML 500 for a bad key instead of a 401.
What you get:
  • 18 typed API operations

Setup

1

Install

2

Add the plugin

corsair.ts
With multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.
3

Choose authentication

4

Connect a tenant

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.

Example API calls

List your videos
Create a project
See the full list on the API page.

What’s next

API reference

Every spotlightr.api.* operation with input and output types.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.