id or its public_link_id, which is the last
segment of a watch URL such as
https://acme.neetorecord.com/watch/4f9c2a1b7e5d3086af12.
Sample output on this page is the JSON envelope you get with
--json. On a
terminal the same data prints as a table or a key-value list. See
Output formats.List recordings
Lists the recordings in the workspace, newest first. Use it to find a recording id to pass to the other commands.Show a recording
Shows one recording in full.<id>- the recording id or public link id.
list returns, wrapped in data
with no pagination block.
Search recordings by title
Searches recordings by title. Use it when you know roughly what a recording is called but not its id.
The output matches
recordings list.
Search recordings by transcript
Searches the text of recording transcripts. Use it to find the recording where something was said, rather than one whose title matches.
The output matches
recordings list.
Update a recording
Renames a recording, replaces its summary, moves it between folders, or replaces its tags. Only the flags you pass are changed.<id>- the recording id or public link id.
--tag replaces every tag on the recording, so pass the complete list each
time. Tags that do not exist yet are created. Passing --folder-id "" removes
the recording from its folder. --folder-id accepts the id returned by
folders list.
The output is the updated recording object, wrapped in data.
Delete a recording
Deletes a recording and everything derived from it. This cannot be undone.<id>- the recording id or public link id.
Show a transcript
Prints the full transcript with its timestamped segments.<id>- the recording id or public link id.
Check transcript status
Reports whether a transcript exists and where generation has got to. Check this before polling for transcript text.<id>- the recording id or public link id.
Generate a transcript
Starts transcript generation, or regenerates an existing transcript in another language. Generation runs in the background.<id>- the recording id or public link id.
Show chapters
Prints the auto generated chapters of a recording.<id>- the recording id or public link id.
Check chapter status
Reports whether chapters exist and where generation has got to.<id>- the recording id or public link id.
Generate chapters
Starts chapter generation for a recording. It needs a transcript, so runtrigger-transcript first if the recording does not have one.
<id>- the recording id or public link id.
Get the share link
Prints the public watch link, and whether that link has expired or is behind access control.<id>- the recording id or public link id.
Get the embed code
Prints the iframe snippet for embedding a recording in another page.<id>- the recording id or public link id.
Get the download URL
Returns a presigned URL for downloading the recording. The URL is short lived, so fetch it right before you use it.<id>- the recording id or public link id.
"is_download_file_ready": false and no URL. Run trigger-mp4, then try again.
An MP4 URL is valid for 600 seconds; a --format webm URL is valid for 60
seconds and is ready as soon as the recording has been uploaded.
Generate the MP4
Starts preparing the downloadable MP4 for a recording. Run it whendownload-url reports that the file is not ready.
<id>- the recording id or public link id.
status is generating when regeneration was queued, already_generating
when a conversion is already running, and ready when the MP4 is already up to
date.
Get a screenshot
Returns a URL to a still frame captured at a timestamp. Useful for pulling a thumbnail out of a recording, or for looking at what was on screen when something was said.<id>- the recording id or public link id.
--timestamp must fall within the recording’s duration.
Show recording analytics
Reports the view count for a single recording, broken down by day.<id>- the recording id or public link id.
analytics show.
List CTAs
Lists the call to action buttons configured on a recording.<id>- the recording id or public link id.
Create a CTA
Adds a call to action button that appears over the video for a time range.<id>- the recording id or public link id.