Sign in

v1

latestOpenAPI 3.0.02026-07-24212113249.1 KB
Media

Create media

post/medias

Headers

channelstring required

Channel ID

organizationstring required

The URL of the end-user web application

Request body

filenamestring required

File name

status'Uploading' | 'Uploaded' | 'Transcoding' | 'Ready' | 'Ingest' | 'Processing' | 'Complete' | 'ImageComplete' | 'AudioComplete' | 'SubtitleComplete' required

The current status of this media content on the platform. Enum

type'Video' | 'Image' | 'Audio' | 'Livestream' | 'Subtitle' required

The type of media content. Enum

uploadstring

Upload ID

durationnumber required

Duration of video or audio content

widthnumber required

Width of image

heightnumber required

Height of image

aspectRatiostring required

Aspect ration of visual content

orientation'landscape' | 'portrait' required

Orientation of visual content. Enum

baseUrlstring required
imgPathstring required
dashPathstring required
hlsPathstring required
mp4VodUrlstring required
mp4Pathstring required
vttPathstring required
localestring

ISO 639-1 leanguage code

Example request

{
  "filename": "my-video.mp4",
  "status": "Uploaded",
  "type": "Audio",
  "upload": "6185c7b98711e5b2cae511a2",
  "duration": 3600,
  "width": 1920,
  "height": 1080,
  "aspectRatio": "16:9",
  "orientation": "landscape",
  "baseUrl": "https://www.fanhero.com",
  "locale": "pt-BR"
}

Response

Returns a ResponseMediaOutput object with the metadata for the new media.

idstring required
createdAtstring date-time required
filenamestring required
channelstring required
accountstring required
type'Video' | 'Image' | 'Audio' | 'Livestream' | 'Subtitle' required

Media content type. Enum

status'Uploading' | 'Uploaded' | 'Transcoding' | 'Ready' | 'Ingest' | 'Processing' | 'Complete' | 'ImageComplete' | 'AudioComplete' | 'SubtitleComplete' required

The current status of the media content on the platform. Enum

uploadstring required
isAvatarboolean required
durationnumber required

Duration of video or audio content

widthstring required

Width of image

heightstring required

Height of image

aspectRatiostring required

Aspect ratio of visual content

orientation'landscape' | 'Image' | 'portrait' required

Orientation of visual content

baseUrlstring required
dashPathstring required
hlsPathstring required
mp4Pathstring required
thumbnailPathstring[] required
labelstring[] required

Example response

{
  "id": "61886612d37f875060b4749c",
  "filename": "video.mp4",
  "channel": "61883ef40a57a49d87b95643",
  "account": "61883ef40a57a49d87b95643",
  "type": "Audio",
  "status": "Uploaded",
  "upload": "61883ef40a57a49d87b95643",
  "isAvatar": true,
  "duration": 36000,
  "width": "1920",
  "height": "1080",
  "aspectRatio": "16:9",
  "orientation": "landscape",
  "baseUrl": "https://www.fanhero.com"
}