Wistia

App · 20 actions

Manage Wistia media, folders and tags and read account usage.

Actions

ActionWhat it does
Archive mediaArchive media.
Copy mediaCopy media.
Copy media batchCopy media batch.
Create folderCreate folder.
Create tagCreate tag.
Delete folderDelete folder.
Delete mediaDelete media.
Delete tagDelete tag.
Get accountGet account.
Get account usageGet account usage.
Get folderGet folder.
Get mediaGet media.
Import mediaImport media.
List foldersList folders.
List mediaList media.
List tagsList tags.
Move mediaMove media.
Restore mediaRestore media.
Update folderUpdate folder.
Update mediaUpdate media.

Archive media

Archive media.

Inputs

Hashed Idshashed_idslistRequired
An array of the media hashed IDs to be archived.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "background_job_status": {
      "hashed_id": "example",
      "id": 1,
      "status": "queued"
    },
    "message": "example"
  }
}

Copy media

Copy media.

Inputs

MediahashedmediaHashedIdtextRequired
Hashed ID of the media (e.g., "4d23503f70")
Folderfolder_idnumber
The ID of the folder where you want the new copy placed. Defaults to the source media’s current folder if omitted or invalid.
Ownerownertext
An email address specifying the owner of the new media. Defaults to the source media’s current owner if omitted or invalid.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "archived": false,
    "created": "example",
    "description": "example",
    "duration": "example",
    "embedCode": "example",
    "folder": "example",
    "hashed_id": "example",
    "id": 1,
    "name": "example",
    "progress": 1.0,
    "protected": false,
    "section": "example",
    "status": "queued",
    "thumbnail": {
      "height": 1,
      "url": "example",
      "width": 1
    },
    "type": "Video",
    "updated": "example"
  }
}

Copy media batch

Copy media batch.

Inputs

Hashed Idshashed_idslistRequired
An array of the media hashed IDs to be copied.
Folderfolder_idtextRequired
The hashed ID of the destination folder where the copies will be placed.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "destination": {
      "hashedId": "example",
      "name": "example",
      "type": "example"
    }
  }
}

Create folder

Create folder.

Inputs

Namenametext
The name of the folder you want to create.
AdminemailadminEmailtext
The email address of the person you want to set as the owner of this folder. Defaults to the Wistia Account Owner.
Descriptiondescriptiontext
The folder’s description.
AnonymouscanuploadanonymousCanUploadtrue/false
Whether anonymous users can upload media to the folder.
AnonymouscandownloadanonymousCanDownloadtrue/false
Whether anonymous users can download media from the folder.
Publicpublictrue/false
A flag indicating whether or not the folder is enabled for public access.
PersonallibrarypersonalLibrarytrue/false
When true, creates the folder inside the requesting user's personal "My Library" (owned by them) instead of a shared account folder.

Outputs

dataobject
A folder (previously called a project) is a container in which to organize media into. It can be used to set permissions that apply to all the media in the folder as well as organizing media into subfolders (previously called media groups).
Example output
{
  "data": {
    "anonymous_can_download": false,
    "anonymous_can_upload": false,
    "created": "example",
    "cursor": "example",
    "description": "example",
    "hashed_id": "example",
    "id": 1,
    "kind": "library",
    "media_count": 1,
    "medias": {
      "url": "example"
    },
    "name": "example",
    "personal_library": false,
    "public": false,
    "public_id": "example",
    "updated": "example"
  }
}

Create tag

Create tag.

Inputs

NamenametextRequired
The tag name. Stored lowercased with whitespace squished, 50 characters max, and must not already exist on the account.

Outputs

dataobject
A tag is used to tag related media. You can then filter media by a specific tag.
Example output
{
  "data": {
    "created_at": "example",
    "cursor": "example",
    "name": "example",
    "taggings_count": 1,
    "updated_at": "example"
  }
}

Delete folder

Delete folder.

Inputs

IdidtextRequired
Hashed ID of the folder (e.g., "4d23503f70")

Outputs

dataobject
A folder (previously called a project) is a container in which to organize media into. It can be used to set permissions that apply to all the media in the folder as well as organizing media into subfolders (previously called media groups).
Example output
{
  "data": {
    "anonymous_can_download": false,
    "anonymous_can_upload": false,
    "created": "example",
    "cursor": "example",
    "description": "example",
    "hashed_id": "example",
    "id": 1,
    "kind": "library",
    "media_count": 1,
    "medias": {
      "url": "example"
    },
    "name": "example",
    "personal_library": false,
    "public": false,
    "public_id": "example",
    "updated": "example"
  }
}

Delete media

Delete media.

Inputs

MediahashedmediaHashedIdtextRequired
Hashed ID of the media (e.g., "4d23503f70")

Outputs

dataobject
Response.
Example output
{
  "data": {
    "archived": false,
    "created": "example",
    "description": "example",
    "duration": "example",
    "embedCode": "example",
    "hashed_id": "example",
    "id": 1,
    "name": "example",
    "progress": 1.0,
    "protected": false,
    "section": "example",
    "status": "queued",
    "thumbnail": {
      "height": 1,
      "url": "example",
      "width": 1
    },
    "type": "Video",
    "updated": "example"
  }
}

Delete tag

Delete tag.

Inputs

NamenametextRequired
Name of the tag to delete

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get account

Get account.

Inputs

None.

Outputs

dataobject
An account represents a customer at Wistia. Each account can own media, folders channels, etc.
Example output
{
  "data": {
    "channel_count": 1,
    "folder_count": 1,
    "id": 1,
    "media_count": 1,
    "name": "example",
    "url": "example",
    "video_limit": 1
  }
}

Get account usage

Get account usage.

Inputs

None.

Outputs

dataobject
Account usage and plan information, including storage, media, seat, and bandwidth limits. Fields under `limits` are only visible to account owners and managers.
Example output
{
  "data": {
    "can_invite_teammates": false,
    "can_upload": false,
    "limits": {
      "bandwidth": {
        "limit_bytes": 1,
        "period": "monthly",
        "resets_at": "example",
        "used_bytes": 1
      },
      "media": {
        "count": 1,
        "flexible_limit": 1,
        "inflexible_limit": 1
      },
      "primary_resource": "storage",
      "storage": {
        "flexible_limit_bytes": 1,
        "inflexible_limit_bytes": 1,
        "used_bytes": 1
      },
      "users": {
        "account_billable_count": 1,
        "billable_count": 1,
        "flexible_limit": 1,
        "inflexible_limit": 1,
        "viewers_count": 1
      }
    },
    "links": {
      "billing_url": "example",
      "plans_url": "example",
      "usage_url": "example"
    },
    "plan": {
      "is_standard": false,
      "is_trial": false,
      "name": "example",
      "tier": "example",
      "trial_expires_at": "example"
    },
    "role": "example",
    "upload_blocked_reason": "example",
    "verified_domain": false
  }
}

Get folder

Get folder.

Inputs

IdidtextRequired
Hashed ID of the folder (e.g., "4d23503f70")

Outputs

dataobject
A folder (previously called a project) is a container in which to organize media into. It can be used to set permissions that apply to all the media in the folder as well as organizing media into subfolders (previously called media groups).
Example output
{
  "data": {
    "anonymous_can_download": false,
    "anonymous_can_upload": false,
    "created": "example",
    "cursor": "example",
    "description": "example",
    "hashed_id": "example",
    "id": 1,
    "kind": "library",
    "media_count": 1,
    "medias": {
      "url": "example"
    },
    "name": "example",
    "personal_library": false,
    "public": false,
    "public_id": "example",
    "updated": "example"
  }
}

Get media

Get media.

Inputs

MediahashedmediaHashedIdtextRequired
Hashed ID of the media (e.g., "4d23503f70")
Description Formatdescription_formattext
Description format.One of: markdown.
Includeincludetext
Include.One of: speakers.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "archived": false,
    "assets": [],
    "created": "example",
    "description": "example",
    "duration": "example",
    "embedCode": "example",
    "folder": "example",
    "hashed_id": "example",
    "id": 1,
    "name": "example",
    "progress": 1.0,
    "protected": false,
    "section": "example",
    "speakers": [],
    "status": "queued",
    "subfolder": {
      "created": "example",
      "cursor": "example",
      "description": "example",
      "hashed_id": "example",
      "name": "example",
      "position": 1,
      "updated": "example"
    },
    "tags": [],
    "thumbnail": {
      "height": 1,
      "url": "example",
      "width": 1
    },
    "type": "Video",
    "updated": "example"
  }
}

Import media

Import media.

Inputs

UrlurltextRequired
The publicly accessible URL of the media file to import.
Folderfolder_idtext
The hashed ID of the folder (project) to import the media into. If not provided, a new folder will be created.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "background_job_status": {
      "hashed_id": "example",
      "id": 1,
      "status": "queued"
    },
    "message": "example"
  }
}

List folders

List folders.

Inputs

Pagepagenumber
Page.
Per Pageper_pagenumber
Per page.
Cursor Enabledcursor_enablednumber
If `cursor[enabled]` is set to 1, the first result set will be fetched with cursor pagination enabled. This values is ignored if `cursor[before]` or `cursor[after]` are set.One of: 0, 1.
Cursor Beforecursor_beforetext
If `cursor[before]` is set then cursor pagination is enabled and all records before the cursor up to the `per_page` are returned. This feature is useful for fetching "new records", for example, in a "pull to refersh" feature when showing records in a descending order.
Cursor Aftercursor_aftertext
If `cursor[after]` is set then cursor pagination is enabled and all records after the cursor up to the `per_page` are returned.
Sort Bysort_bytext
Sort by.One of: name, created, updated, mediaCount, id.
Sort Directionsort_directionnumber
Sort direction.One of: 0, 1.
Hashed Idshashed_idslist
Hashed ids.

Outputs

datalist
Response.
Example output
{
  "data": []
}

List media

List media.

Inputs

Pagepagenumber
Page.
Per Pageper_pagenumber
Per page.
Cursor Enabledcursor_enablednumber
If `cursor[enabled]` is set to 1, the first result set will be fetched with cursor pagination enabled. This values is ignored if `cursor[before]` or `cursor[after]` are set.One of: 0, 1.
Cursor Beforecursor_beforetext
If `cursor[before]` is set then cursor pagination is enabled and all records before the cursor up to the `per_page` are returned. This feature is useful for fetching "new records", for example, in a "pull to refersh" feature when showing records in a descending order.
Cursor Aftercursor_aftertext
If `cursor[after]` is set then cursor pagination is enabled and all records after the cursor up to the `per_page` are returned.
Sort Bysort_bytext
Sort by.One of: name, created, updated, position.
Sort Directionsort_directionnumber
Sort direction.One of: 0, 1.
Folderfolder_idtext
Hashed ID of the folder (e.g., "4d23503f70")
Namenametext
Name.
Description Formatdescription_formattext
Description format.One of: markdown.
Includeincludetext
Include.One of: speakers.
Typetypetext
Type.One of: Video, Audio, Image, PdfDocument, MicrosoftOfficeDocument, Swf, UnknownType.
Hashed Idshashed_idslist
Hashed ids.
Tagstagslist
Tags.
Archivedarchivedtrue/false
Archived.

Outputs

datalist
Response.
Example output
{
  "data": []
}

List tags

List tags.

Inputs

Pagepagenumber
Page.
Per Pageper_pagenumber
Per page.
Cursor Enabledcursor_enablednumber
If `cursor[enabled]` is set to 1, the first result set will be fetched with cursor pagination enabled. This values is ignored if `cursor[before]` or `cursor[after]` are set.One of: 0, 1.
Cursor Beforecursor_beforetext
If `cursor[before]` is set then cursor pagination is enabled and all records before the cursor up to the `per_page` are returned. This feature is useful for fetching "new records", for example, in a "pull to refersh" feature when showing records in a descending order.
Cursor Aftercursor_aftertext
If `cursor[after]` is set then cursor pagination is enabled and all records after the cursor up to the `per_page` are returned.
Sort Bysort_bytext
Sort by.One of: name, created, updated, taggingsCount, id.
Sort Directionsort_directionnumber
Sort direction.One of: 0, 1.

Outputs

datalist
Response.
Example output
{
  "data": []
}

Move media

Move media.

Inputs

Hashed Idshashed_idslistRequired
An array of the media hashed IDs to be moved.
Folderfolder_idtextRequired
The hashed ID of the folder where you want the media moved.
Subfolder Idsubfolder_idtext
Optional. The hashed ID of the subfolder where you want the media moved. If not provided, media will be moved to the folder's default subfolder. The subfolder must belong to the specified folder.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "background_job_status": {
      "hashed_id": "example",
      "id": 1,
      "status": "queued"
    },
    "message": "example"
  }
}

Restore media

Restore media.

Inputs

Hashed Idshashed_idslistRequired
An array of the media hashed IDs to be restored.
Folderfolder_idtextRequired
The hashed ID of the folder to restore the medias to.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "container": {
      "hashedId": "example",
      "name": "example",
      "type": "example"
    }
  }
}

Update folder

Update folder.

Inputs

IdidtextRequired
Hashed ID of the folder (e.g., "4d23503f70")
Namenametext
The folder’s new name.
Descriptiondescriptiontext
The folder’s new description.
AnonymouscanuploadanonymousCanUploadtrue/false
Whether anonymous users can upload media to the folder.
AnonymouscandownloadanonymousCanDownloadtrue/false
Whether anonymous users can download media from the folder.
Publicpublictrue/false
A flag indicating whether or not the folder is enabled for public access.

Outputs

dataobject
A folder (previously called a project) is a container in which to organize media into. It can be used to set permissions that apply to all the media in the folder as well as organizing media into subfolders (previously called media groups).
Example output
{
  "data": {
    "anonymous_can_download": false,
    "anonymous_can_upload": false,
    "created": "example",
    "cursor": "example",
    "description": "example",
    "hashed_id": "example",
    "id": 1,
    "kind": "library",
    "media_count": 1,
    "medias": {
      "url": "example"
    },
    "name": "example",
    "personal_library": false,
    "public": false,
    "public_id": "example",
    "updated": "example"
  }
}

Update media

Update media.

Inputs

MediahashedmediaHashedIdtextRequired
Hashed ID of the media (e.g., "4d23503f70")
Namenametext
The media’s new name.
New Still Media Idnew_still_media_idtext
The Wistia hashed ID of an image that will replace the still that’s displayed before the player starts playing.
Descriptiondescriptiontext
A new description for this media. Accepts plain text or markdown.
Tagstagslist
An array of tag names to apply to the media. This replaces any existing tags. To add tags without replacing existing tags, use bulk-tag-media.
Custom Metadatacustom_metadataobject
Custom metadata field values to set, keyed by field key. Values take the same shapes as the Set Custom Metadata Field Value endpoint; a null value clears that field and omitted fields are untouched. Requires the custom metadata feature on the account.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "archived": false,
    "created": "example",
    "description": "example",
    "duration": "example",
    "embedCode": "example",
    "hashed_id": "example",
    "id": 1,
    "name": "example",
    "progress": 1.0,
    "protected": false,
    "section": "example",
    "status": "queued",
    "tags": [],
    "thumbnail": {
      "height": 1,
      "url": "example",
      "width": 1
    },
    "type": "Video",
    "updated": "example"
  }
}

On this page