Riverside

App · 17 actions

Read recordings, exports, edits, events and registrants; create timeline exports and webinar registrations.

Actions

ActionWhat it does
Create timeline exportCreate timeline export.
Create webinar registrantCreate webinar registrant.
Delete exportDelete export.
Delete recordingDelete recording.
Download transcriptionDownload a recording’s SRT or text transcription.
Get exportGet export.
Get export download URLGet export download URL.
Get recordingGet recording.
Get timeline download URLGet timeline download URL.
Get timeline exportGet timeline export.
Get track download URLGet track download URL.
List editsList edits.
List eventsList events.
List exportsList exports.
List recordingsList recordings.
List webinar registrantsList webinar registrants.
List workspaceList workspace.

Create timeline export

Create timeline export.

Inputs

Clip IDclip_idtextRequired
Clip ID.
TargettargettextRequired
Target.One of: premiere_pro (Premiere pro), final_cut_pro (Final cut pro), pro_tools (Pro tools).
Include comments markers chaptersinclude_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 IDevent_idtextRequired
Event ID.
EmailemailtextRequired
Email.
First namefirst_nametextRequired
First name.
Last namelast_nametextRequired
Last name.
Custom fieldscustom_fieldslist
Custom fields.

Outputs

dataobject
Riverside response data.
Example output
{
  "data": {
    "event_id": "example",
    "join_url": "example"
  }
}

Delete export

Delete export.

Inputs

Export IDexport_idtextRequired
Export ID.

Outputs

dataobject
Riverside response data.
Example output
{
  "data": {}
}

Delete recording

Delete recording.

Inputs

Recording IDrecording_idtextRequired
Recording ID.

Outputs

dataobject
Riverside response data.
Example output
{
  "data": {}
}

Download transcription

Download a recording’s SRT or text transcription.

Inputs

Recording IDrecording_idtextRequired
Recording ID.
Typetypetext
Type.One of: srt, txt.
File namefile_nametext
File name.

Outputs

dataobject
Riverside response data.
Example output
{
  "data": {
    "content_base64": "example",
    "content_type": "example"
  }
}

Get export

Get export.

Inputs

Export IDexport_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 IDexport_idtextRequired
Export ID.

Outputs

dataobject
Riverside response data.
Example output
{
  "data": {
    "download_url": "example"
  }
}

Get recording

Get recording.

Inputs

Recording IDrecording_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 IDtimeline_idtextRequired
Timeline ID.

Outputs

dataobject
Riverside response data.
Example output
{
  "data": {
    "download_url": "example"
  }
}

Get timeline export

Get timeline export.

Inputs

Timeline IDtimeline_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 IDfile_idtextRequired
File ID.

Outputs

dataobject
Riverside response data.
Example output
{
  "data": {
    "download_url": "example"
  }
}

List edits

List edits.

Inputs

Studiostudio_idtext
Studio ID.
Projectproject_idtext
Project ID.
Start datestart_datedate
Start date.
End dateend_datedate
End date.
Pagepagenumber
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

Studiostudio_idtext
Studio ID.
Event typeevent_typetext
Event type.One of: session, webinar.
Statusstatustext
Status.One of: upcoming, live, ended.
Fromfrom_timedate and time
From.
Totodate and time
To.
Updated afterupdated_afterdate and time
Updated after.
Cursorcursortext
Cursor.
Limitlimitnumber
Limit.From 1 to 500.

Outputs

dataobject
Riverside response data.
Example output
{
  "data": {
    "data": [],
    "next_cursor": "example"
  }
}

List exports

List exports.

Inputs

Studiostudio_idtext
Studio ID.
Projectproject_idtext
Project ID.
Start datestart_datedate
Start date.
End dateend_datedate
End date.
Pagepagenumber
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

Studiostudio_idtext
Studio ID.
Projectproject_idtext
Project ID.
Start datestart_datedate
Start date.
End dateend_datedate
End date.
Pagepagenumber
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 IDevent_idtextRequired
Event ID.
Cursorcursortext
Cursor.
Limitlimitnumber
Limit.From 1 to 500.
Sortsorttext
Sort.One of: registeredAt, email, name.
Orderordertext
Order.One of: asc, desc.
Approvedapprovedtrue/false
Approved.
Participatedparticipatedtrue/false
Participated.
Searchsearchtext
Search.
Updated afterupdated_afterdate and time
Updated after.
Includeincludetext
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": []
}

On this page