NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Spotlightr connects to a Nagent workspace with an API key. Once it is connected, agents can call 12 Spotlightr actions, such as "Add Domain", "Create Group" and "Create Video". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Spotlightr, with input parameters and output schema.
SPOTLIGHTR_ADD_DOMAINTool to add a whitelisted domain for embedding Spotlightr videos. Use when you need to whitelist a new domain for video embedding.
Input parameters
Domain to whitelist for embedding videos (e.g., example.com or test-domain-example.com)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SPOTLIGHTR_CREATE_GROUPTool to create a new project (group) in Spotlightr. Use when you need to organize videos into a new project or group.
Input parameters
Name of the project/group to create
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SPOTLIGHTR_CREATE_VIDEOTool to create a video in Spotlightr by uploading a file or linking from an external source. Use when you need to add a new video from YouTube, Google Drive, Vimeo, or other sources.
Input parameters
File path or URL to the video source (YouTube, Google Drive, Vimeo, etc.)
Media streaming protocol: 0 to leave as unsecured, 1 to encode with HLS
The name of the video
Type of creation: 0 to debug (test without creating), 1 to confirm creation
Custom S3 integration ID. Use '0' for default storage or provide custom integration ID
Video group ID to associate the video with
Player configuration settings object for customizing video player appearance and behavior
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SPOTLIGHTR_DELETE_VIDEOTool to delete or remove videos from Spotlightr projects. Use when you need to permanently delete one or more videos by their IDs.
Input parameters
List of video IDs to delete. Must contain at least one video ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SPOTLIGHTR_GET_DOMAINSTool to retrieve whitelisted domains for a Spotlightr account. Use when you need to list all domains approved for embedding videos.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SPOTLIGHTR_GET_TOP_VIDEOSTool to retrieve the top videos from a Spotlightr account. Use when you need to list the most viewed videos.
Input parameters
Number of days to look back for top videos (default 30)
Number of top videos to return (default 3)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SPOTLIGHTR_GET_VIDEO_METRICSTool to retrieve analytics metrics for a specified video. Use when you have a video ID and need its metrics (loads, plays, playRate, completionRate, shares, etc.).
Input parameters
ID of the video to fetch metrics for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SPOTLIGHTR_GET_VIDEO_SOURCETool to get or replace the video source for an existing video in Spotlightr. Use when you need to update a video's source URL.
Input parameters
Video ID whose source is to be replaced
New URL for the video source
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SPOTLIGHTR_GET_VIDEO_VIEWSTool to retrieve video view data with optional filtering by viewer ID and watch status. Use when you need detailed view records for a specific video.
Input parameters
Video identifier for retrieving view data
Return all views without pagination
Filter to only include views with percentWatched > 1
ID or email of a known viewer to filter views by specific viewer
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SPOTLIGHTR_LIST_GROUPSTool to retrieve all projects (groups) in a Spotlightr account. Use when you need to list all available projects or groups.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SPOTLIGHTR_LIST_VIDEOSTool to retrieve videos from a Spotlightr account. Use when you need to list all videos or filter by specific video ID or project.
Input parameters
Identifier for a specific video record to retrieve
Identifier for filtering videos by project association
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SPOTLIGHTR_SEARCH_GLOBALTool to perform account-wide search across all videos and content in Spotlightr. Use when you need to find specific videos, projects, or content by name or keyword.
Input parameters
Search query string to search across videos and content. If not provided, returns all content.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 12 Spotlightr actions on Nagent, including "Add Domain", "Create Group" and "Create Video". Add Domain: Add a whitelisted domain for embedding Spotlightr videos. Each action is listed on this page with its input parameters and its output.
Spotlightr connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Add Domain takes 1 required input: domain. It returns data, error and successful.