The Spotlightr connector lets your AI agent act in each user's Spotlightr account. Each user connects their own Spotlightr API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 15 tools.
- Tools
- 15
- What they doRead · write · destructive
- 6 · 8 · 16 read8 write1 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Spotlightr connection
In AgentKit > Connections, create a Spotlightr connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'spotlightr'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Spotlightr:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'spotlightr_domains_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "spotlightr"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Spotlightr:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="spotlightr_domains_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Spotlightr credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolspotlightr_domains_listList the domains whitelisted to embed your Spotlightr videos.Read-onlyList Whitelisted Domains
List the domains whitelisted to embed your Spotlightr videos. Returns the whitelisted domains. Use spotlightr_domain_add to allow another domain.
Inputs
This tool takes no inputs.
spotlightr_groups_listList the projects (video groups) in your Spotlightr account.Read-onlyList Projects
List the projects (video groups) in your Spotlightr account. Returns projects with their id and name. Use this to find a project ID for spotlightr_videos_list or spotlightr_video_create.
Inputs
This tool takes no inputs.
spotlightr_top_videos_listList your most-viewed videos over a recent period.Read-onlyList Top Videos
List your most-viewed videos over a recent period. Returns the top videos with their view statistics. Use this for a quick performance overview. Use spotlightr_video_metrics_get for one video.
Inputs
daysinteger- Reporting period in days. Spotlightr defaults to 30. Example: 30.
totalinteger- Number of top videos to return. Spotlightr defaults to 3. Example: 5.
spotlightr_video_metrics_getGet analytics for one video.Read-onlyGet Video Metrics
Get analytics for one video. Returns loads, plays, playRate, watched (average percent watched), completitionRate and shares. Use spotlightr_video_views_list for individual views.
Inputs
video_idintegerrequired- Numeric Spotlightr video ID (the decoded ID, not the base64 string in watch URLs). Get it from spotlightr_videos_list. Example: 1352090.
spotlightr_video_views_listList the individual views of a video, optionally for one known viewer or only views where something was watched.Read-onlyList Video Views
List the individual views of a video, optionally for one known viewer or only views where something was watched. Returns view records with viewer and watch-progress details. Use spotlightr_video_metrics_get for totals.
Inputs
video_idintegerrequired- Numeric Spotlightr video ID (the decoded ID, not the base64 string in watch URLs). Get it from spotlightr_videos_list. Example: 1352090.
all_viewsboolean- true to return all views without pagination. Example: false.
custom_viewer_idstring- ID or email of a known viewer to return views for. Example: jane@example.com.
only_watchedboolean- true to return only views with more than 1 percent watched. Example: true.
spotlightr_videos_listList the videos in your Spotlightr account, optionally narrowed to one video or one project.Read-onlyList Videos
List the videos in your Spotlightr account, optionally narrowed to one video or one project. Returns video records with their id, name, project (videoGroup), URLs and settings. Use this to find video IDs. Use spotlightr_video_metrics_get for a video's analytics.
Inputs
video_groupinteger- Return only videos in this project (group) ID, from spotlightr_groups_list. Example: 4521.
video_idinteger- Return only this video. Example: 1352090.
spotlightr_access_expireExpire a student's course access record.WriteExpire Access Record
Expire a student's course access record. Returns the update result. Use this to revoke a student's access to a course.
- Idempotent
Inputs
expireintegerrequired- Set to 1 to expire the record. Example: 1.one of
1 idintegerrequired- Access record ID. Example: 55021.
spotlightr_domain_addAdd a domain to the list allowed to embed your Spotlightr videos.WriteAdd Whitelisted Domain
Add a domain to the list allowed to embed your Spotlightr videos. Returns the result. Use spotlightr_domains_list to see the current list.
- Idempotent
Inputs
domainstringrequired- Domain to whitelist, without protocol. Example: example.com.
spotlightr_gallery_code_expireExpire a gallery access code so it can no longer be used.WriteExpire Gallery Access Code
Expire a gallery access code so it can no longer be used. Returns the update result. Use this to revoke a shared gallery code.
- Idempotent
Inputs
expiresintegerrequired- Set to 1 to expire the code. Example: 1.one of
1 idintegerrequired- Access code ID. Example: 3307.
spotlightr_group_createCreate a new project (video group) in Spotlightr.WriteCreate Project
Create a new project (video group) in Spotlightr. Returns the created project. Use its ID as video_group when creating or listing videos.
Inputs
namestringrequired- Name of the new project. Example: Onboarding videos.
spotlightr_student_createCreate a student login for a Spotlightr course or gallery, with optional expiry and unlock limits.WriteCreate Course Student
Create a student login for a Spotlightr course or gallery, with optional expiry and unlock limits. Returns the created student access. Use this to grant a person access to a protected course or gallery.
Inputs
emailstringrequired- Student's email address. Example: student@example.com.
expiresstringrequired- Expiry date as YYYY-MM-DD, or 0000-00-00 for none. Example: 0000-00-00.
idintegerrequired- Course or gallery ID. Example: 8812.
neverintegerrequired- 1 if access never expires, 0 otherwise. Example: 1.one of
01 passwordstringrequired- Password the student signs in with. Example: S3cure-pass-2026.
timeintegerrequired- Time limit for access, or 0 for none. Example: 0.
unlocksintegerrequired- Number of unlocks allowed, or 0 for no limit. Example: 0.
spotlightr_video_createCreate a Spotlightr video from a link (YouTube, Vimeo, Google Drive, Dropbox or a direct file URL), optionally copying another video's player settings.WriteCreate Video From URL
Create a Spotlightr video from a link (YouTube, Vimeo, Google Drive, Dropbox or a direct file URL), optionally copying another video's player settings. Returns the created video's watch URL. Use this to add a hosted or linked video. Uploading a file from disk is not supported by this tool.
Inputs
custom_s3integerrequired- 0 to use Spotlightr storage, or the ID of a custom S3 integration. Example: 0.
namestringrequired- Name of the new video. Example: Product demo.
urlstringrequired- Link to the video source: YouTube, Vimeo, Google Drive, Dropbox or a direct video URL. Example: https://www.youtube.com/watch?v=dQw4w9WgXcQ.
createinteger- 1 to create the video, 0 for a debug dry run. Example: 1.one of
01 hlsinteger- 1 to encode the video as secure HLS, 0 to leave it unencoded. Example: 1.one of
01 player_settingsinteger- ID of one of your videos (decoded, not base64) whose player settings to copy. Default settings are used if omitted. Example: 1352090.
video_groupinteger- Project (group) ID to put the video in, from spotlightr_groups_list. Example: 4521.
spotlightr_video_settings_updateUpdate individual player settings of a video.WriteUpdate Video Player Settings
Update individual player settings of a video. Only the keys you send change. Returns the update result. Use this to change the player (for example autoplay or colors) without editing other settings.
- Idempotent
Inputs
idintegerrequired- Video ID (decoded number, not the base64 string). Example: 1352090.
settingsstringrequired- JSON object, as a string, holding only the player setting keys to change. Example: {"autoplay": true}
spotlightr_video_source_updateReplace the source of an existing Spotlightr video with a new URL, keeping its ID, settings and analytics.WriteReplace Video Source
Replace the source of an existing Spotlightr video with a new URL, keeping its ID, settings and analytics. Returns the update result. Use this to swap the underlying file or link of a published video.
- Idempotent
Inputs
idintegerrequired- ID of the video whose source to replace. Example: 1352090.
urlstringrequired- New source URL for the video. Example: https://vimeo.com/76979871.
spotlightr_video_deletePermanently delete one or more videos from your Spotlightr account.DestructiveDelete Videos
Permanently delete one or more videos from your Spotlightr account. Returns the deletion result. Get video IDs from spotlightr_videos_list.
- Idempotent
Inputs
idsstringrequired- IDs of the videos to delete, as a JSON array of numbers. Example: [1234,5678]
No tools match.