Riverside
App · 17 actions
Read recordings, exports, edits, events and registrants; create timeline exports and webinar registrations.
Actions
| Action | What it does |
|---|---|
| Create timeline export | Create timeline export. |
| Create webinar registrant | Create webinar registrant. |
| Delete export | Delete export. |
| Delete recording | Delete recording. |
| Download transcription | Download a recording’s SRT or text transcription. |
| Get export | Get export. |
| Get export download URL | Get export download URL. |
| Get recording | Get recording. |
| Get timeline download URL | Get timeline download URL. |
| Get timeline export | Get timeline export. |
| Get track download URL | Get track download URL. |
| List edits | List edits. |
| List events | List events. |
| List exports | List exports. |
| List recordings | List recordings. |
| List webinar registrants | List webinar registrants. |
| List workspace | List workspace. |
Create timeline export
Create timeline export.
Inputs
- Clip ID
clip_idtextRequired - Clip ID.
- Target
targettextRequired - Target.One of:
premiere_pro(Premiere pro),final_cut_pro(Final cut pro),pro_tools(Pro tools). - Include comments markers chapters
include_comments_markers_chapterstrue/false - Include comments markers chapters.
Outputs
dataobject- Riverside response data.
Example output
{
"data": {
"download_url": "example",
"status": "example",
"timeline_id": "example"
}
}Create webinar registrant
Create webinar registrant.
Inputs
- Event ID
event_idtextRequired - Event ID.
- Email
emailtextRequired - Email.
- First name
first_nametextRequired - First name.
- Last name
last_nametextRequired - Last name.
- Custom fields
custom_fieldslist - Custom fields.
Outputs
dataobject- Riverside response data.
Example output
{
"data": {
"event_id": "example",
"join_url": "example"
}
}Delete export
Delete export.
Inputs
- Export ID
export_idtextRequired - Export ID.
Outputs
dataobject- Riverside response data.
Example output
{
"data": {}
}Delete recording
Delete recording.
Inputs
- Recording ID
recording_idtextRequired - Recording ID.
Outputs
dataobject- Riverside response data.
Example output
{
"data": {}
}Download transcription
Download a recording’s SRT or text transcription.
Inputs
- Recording ID
recording_idtextRequired - Recording ID.
- Type
typetext - Type.One of:
srt,txt. - File name
file_nametext - File name.
Outputs
dataobject- Riverside response data.
Example output
{
"data": {
"content_base64": "example",
"content_type": "example"
}
}Get export
Get export.
Inputs
- Export ID
export_idtextRequired - Export ID.
Outputs
dataobject- Riverside response data.
Example output
{
"data": {
"created_date": "example",
"id": "example",
"name": "example"
}
}Get export download URL
Get export download URL.
Inputs
- Export ID
export_idtextRequired - Export ID.
Outputs
dataobject- Riverside response data.
Example output
{
"data": {
"download_url": "example"
}
}Get recording
Get recording.
Inputs
- Recording ID
recording_idtextRequired - Recording ID.
Outputs
dataobject- Riverside response data.
Example output
{
"data": {
"created_date": "example",
"id": "example",
"name": "example"
}
}Get timeline download URL
Get timeline download URL.
Inputs
- Timeline ID
timeline_idtextRequired - Timeline ID.
Outputs
dataobject- Riverside response data.
Example output
{
"data": {
"download_url": "example"
}
}Get timeline export
Get timeline export.
Inputs
- Timeline ID
timeline_idtextRequired - Timeline ID.
Outputs
dataobject- Riverside response data.
Example output
{
"data": {
"download_url": "example",
"error": "example",
"status": "example",
"timeline_id": "example"
}
}Get track download URL
Get track download URL.
Inputs
- File ID
file_idtextRequired - File ID.
Outputs
dataobject- Riverside response data.
Example output
{
"data": {
"download_url": "example"
}
}List edits
List edits.
Inputs
- Studio
studio_idtext - Studio ID.
- Project
project_idtext - Project ID.
- Start date
start_datedate - Start date.
- End date
end_datedate - End date.
- Page
pagenumber - Page.At least 1.
Outputs
dataobject- Riverside response data.
Example output
{
"data": {
"data": [],
"next_page_url": "example",
"page": 1,
"total_items": 1,
"total_pages": 1
}
}List events
List events.
Inputs
- Studio
studio_idtext - Studio ID.
- Event type
event_typetext - Event type.One of:
session,webinar. - Status
statustext - Status.One of:
upcoming,live,ended. - From
from_timedate and time - From.
- To
todate and time - To.
- Updated after
updated_afterdate and time - Updated after.
- Cursor
cursortext - Cursor.
- Limit
limitnumber - Limit.From 1 to 500.
Outputs
dataobject- Riverside response data.
Example output
{
"data": {
"data": [],
"next_cursor": "example"
}
}List exports
List exports.
Inputs
- Studio
studio_idtext - Studio ID.
- Project
project_idtext - Project ID.
- Start date
start_datedate - Start date.
- End date
end_datedate - End date.
- Page
pagenumber - Page.At least 1.
Outputs
dataobject- Riverside response data.
Example output
{
"data": {
"data": [],
"next_page_url": "example",
"page": 1,
"total_items": 1,
"total_pages": 1
}
}List recordings
List recordings.
Inputs
- Studio
studio_idtext - Studio ID.
- Project
project_idtext - Project ID.
- Start date
start_datedate - Start date.
- End date
end_datedate - End date.
- Page
pagenumber - Page.At least 0.
Outputs
dataobject- Riverside response data.
Example output
{
"data": {
"data": [],
"next_page_url": "example",
"page": 1,
"total_items": 1,
"total_pages": 1
}
}List webinar registrants
List webinar registrants.
Inputs
- Event ID
event_idtextRequired - Event ID.
- Cursor
cursortext - Cursor.
- Limit
limitnumber - Limit.From 1 to 500.
- Sort
sorttext - Sort.One of:
registeredAt,email,name. - Order
ordertext - Order.One of:
asc,desc. - Approved
approvedtrue/false - Approved.
- Participated
participatedtrue/false - Participated.
- Search
searchtext - Search.
- Updated after
updated_afterdate and time - Updated after.
- Include
includetext - Include.One of:
poll_answers(Poll answers).
Outputs
dataobject- Riverside response data.
Example output
{
"data": {
"data": [],
"page": {
"limit": 1,
"next_cursor": "example",
"total_items": 1
}
}
}List workspace
List workspace.
Inputs
None.
Outputs
datalist- Riverside response data.
Example output
{
"data": []
}