TVU Public API Stage
Home
Home
  1. Export
  • Ingest Integration Workflow
  • Authentication
    • get `SID` for authentication
  • MediaHub API
    • Explanation of URL and Type for Source and Output
    • project-api
      • whiteBalanceDetail
      • setWhiteBalance
      • setAudioOffset
      • resetWhiteBalance
      • listProjects
      • deleteProjects
      • queryStatus
      • getProject
      • updateProject
      • createProject
      • deleteProject
    • source-object-api
      • listSourceObjects
      • sourceObjectInfo
      • deleteSourceObjectInfo
      • deleteSourceObjectInfoBulk
      • updateSourceObjectInfo
      • createSourceObject
    • output-encoder-api
      • outputPairedWithEncodingProfile
      • outputPairedWithEncodingProfile
      • deletePairedOfOutputEncodingProfile
      • updateOutput
      • createOutput
      • deleteOutput
      • listOutputs
      • queryOutputEncodingProfilePairs
    • encoder-profile-api
      • queryEncodingProfile
      • encodingProfile
      • createEncodingProfile
      • deleteEncodingProfile
      • queryEncodingProfiles
      • queryEncodingProfileDict
    • route-api
      • switchConnect(project mode)
      • singleOutputEnableStreaming(project mode)
      • singleOutputDisableStreaming(project mode)
      • disconnect(project mode)
      • connect(project mode)
    • setting-api
      • getSupportKeys
      • getGroupAttr
      • setGroupAttr
    • preview-decoder-api
      • stopPreview
      • startPreview
    • switcher-api
      • setAudioDelay
    • RouteApi
      • destinationSwitch(destination mode)
      • destinationStopLive(destination mode)
      • destinationStartLive(destination mode)
    • destination-api
      • updateDestination
      • createDestination
      • deleteDestination
      • listDestinations
      • destinationPairedWithEncodingProfile
  • Search API
    • event
      • slug with ingest setting
      • query slug
      • delete slug
      • create slug
      • retrieve slug
      • current slug
      • add the mark file to PP
      • create clip object
    • search
      • session
        • Send session heartbeat to track user activity
      • query
        • Run an auto-search query
        • Search stored summarizations by time range
        • Get AI summarization for a media segment
      • person
        • List persons detected in a media file by face recognition
        • Search persons globally by name or ID tags
      • slug
        • Search media content by tags and free text
      • object
        • Fetch all tags across objects
        • Fetch tags for an object
        • Retrieve detailed object info
        • Search objects with tag filters
        • Get tag autocomplete suggestions for an object
        • Search file format info by path
        • Search media objects by ID list
        • Find object IDs by media paths
      • recording
        • Retrieve recording info array by task ID
        • Get recording intervals by path
      • caption
        • List caption supported languages
        • Retrieve caption transcript within a media time range
      • srt
        • Generate a marked SRT subtitle file
      • scene
        • Query SCTE-35 marker events by time range
      • doc
        • Record a user click on a search result
      • health
        • Get deployed service version
      • apiv2
        • AI agent search
      • appearance
        • Get appearance relations v2
        • Get appearance name suggestions v2
      • Get appearance list
      • Get content click v2
      • Get caption by source object
      • Get TVU 264 status
      • Get appearance relations
      • Search captions by keyword
      • Get scene change info v2
      • Search events by source object and time
      • Cross-type media content search (v2)
      • Appearance search
      • Get latest event for source objects
      • Get appearance name suggestions
      • Get recordings for an event object
      • Get media files
      • Get media files by IDs
      • Get name suggestions
      • Auto complete
      • Search user source objects
      • Search persons by source object
      • Search person face appearances
      • Search person track by source object
      • Get settings
      • Get search suggestions
      • Get supported languages
      • Get recorded files
      • Search words
      • import test
      • ai search
    • extract
      • ERROR CODE
      • export
      • cut-json
      • thumbnail
      • longexport
      • exportaudio
    • public
      • register webhook
  • MediaMind Story Creation
    • create story
  • Object API
    • GraphQL
      • Error Code
      • Object Interface Related Structures
      • Examples
      • Object Interface Related Structures Copy
      • object
        • notifyGroupsEvents
        • createObjectAndBind
        • getObject
        • getObjectAttr
        • getObjectByTangible
        • getObjectByID
        • getObjectByName
        • getObjectByOwner
        • getObjectBySource
        • getOrCreateObjectByTangible
        • bulkGetObjectByTangible
        • updateObject
        • updateObjectAttr
        • bulkUpdateObject
        • deleteObject
      • tangible
        • createTangible
        • createTangibleAndBind
        • updateTangible
        • deleteObjectByGroupId
        • batchDeleteObject
        • updateObjectStatus
        • updateEventObjectBySource
      • relationship
        • bindRelation
        • bindObjectRelation
        • bindMultiObjectRelation
        • bulkUpdateTangible
        • getLatestObjectRelation
        • getTangible
        • getTangibleByObject
        • deleteTangible
        • updateTangible Copy
      • object tag
        • getObjectRelation
        • replaceRelation
        • removeRelation
    • RESTful
      • ErrorCode
      • res.tvu.ai
        • object
        • tangible
        • tangible 2
      • create object tag
      • update object tag
      • delete object tag
      • get object tag
      • update object attributes
      • get objects' attribute
      • Get objects with the attribute set to a specific value.
      • get objects' single attribute
      • get object
      • Get objects with the publicslug attribute set to true.
    • status
      • objectd callback
      • createObjectTag
      • hold
      • updateObjectTag
      • deleteObjectTag
      • removeObjectRelation
      • release
      • removeMultiObjectRelation
      • watch
      • removeRelationByTangible
      • unwatch
      • query the hold status of object
      • query the hold status of tangible
    • 文档
      • 合并tangible需要执行的命令
      • 索引详情
  • Grid API
    • getSession
    • getDeviceList
    • addPackToken
    • removePackToken
    • queryPairedR
    • queryPairedT
    • queryPairedToken
    • getGridMetadata
    • updateGridMetadata
    • deleteExt
    • getThumbnail
    • listSocialAccount
    • startPushLive
    • stopPushLive
    • addEvent
    • deleteEvent
    • listEvent
    • queryEvent
    • batchHandleEvent
    • getStatus
    • queryPairedTGeoByRid
    • setLiveParameters
    • startLive
    • stopLive
    • addExt
    • getAvailableDevice
    • listShareAccount
    • getRealTimeLiveParameters
  • Producer API
    • GraphQL API Use Specification
    • Programs
      • program query
      • program data
      • create program
      • update program
      • delete program
      • start
      • stop
    • Input Source
      • create EXT source
      • create RTMP push source
      • create RTPFEC source
      • create SRT source
      • create HTML source
      • delete IP source
      • add source to slot
      • remove source from slot
      • cut slot to PVW
      • cut slot to PGM
      • set source delay
    • Clip Player
      • media files
      • add clip to clip player
      • remove clip from clip player
      • edit clip
      • play clip player
      • pause clip player
      • resume clip player
      • stop clip player
      • move clip position
      • Play multiple clip players at same time
    • Overlay
      • add overlay to PVW
      • add overlay to PGM
      • clear overlay on PVW
      • clear overlay on PGM
      • remove overlay from PGM
      • cut overlay
      • logo files
      • request upload param
      • add logo to program
      • remove logo
      • move logo position
      • save singular app token
      • switch singular
      • delete singular
      • save graphic url
      • delete and remove graphic url
    • Collaborator
      • create collaborator
      • remove collaborator
      • update collaborator roles
    • Followers
      • available slave programs
      • add or update gangs
      • remove gang
    • Producer AI
      • update AI Setting
      • play all clip players
      • play all clip players from the beginning
      • upload source thumbnail
    • Audio Mixer
      • Audio Transaction
    • Playlist for Clip Player
      • create a playlist
      • get a playlist by id
      • switch to the playlist
      • update a playlist name
      • delete a playlist
      • list program playlists by programId and fileShimNo
      • page query program playlist
  • Channel API
    • clone
      • mirror clone
      • enable/disable sync at start of Broadcast day
    • scheduleMapping
      • addScheduleMappingTemplate
    • Event
      • batch add event
      • Get sourceId based on sourceType and sourceName
    • SCTE
      • Adding ManualSCTE via API
    • epg file export
    • Take Breaking Source
    • Take Next
    • Emergency Switch
    • Turn on/off craw
    • Turn on/off logo
    • Turn on/off cc
    • Take PlayList
  • UsageService API
    • Get DeviceInfo By PeerId
  • Media Service For Producer
    • tvucc-share
      • output
        • stopOutput
        • liveOutput
      • share Video
        • stopRtmpOutput
        • liveRtmpOutputAccount
    • tvucc-media
      • output Setting
        • updateOutputAccount
        • deleteOutputAccount
        • addOutPutAccount
        • getOutputAccount
      • ListOutputAccount
      • deleteRtmpAccount
      • addRtmpOutputAccount
  • Partyline API
    • party
      • join
      • party status
      • checkV2
      • gallery join
      • get by code
      • page
      • join anywhere
      • meetingAnywhere
      • anywhere join
      • queryByRtilCode
      • queryByPartyCode
      • listCurrentPartyByUserID
      • command managerMute
      • Receiver Join party_ccR
      • Receiver Join party_ppR
      • Receiver leave party
      • Receiver start gallery
      • status
      • reset status
      • delete
      • getOnlineUserList
      • listPartyMembers
      • reportUserChange
      • create
      • update
      • check
      • checkInvite
      • voIPStaus
  • Commentator API
    • event
      • page
      • create event
      • reuse
      • update
      • info
      • delete
      • stop
      • switch
  • Workflow API
    • queryWorkflow
    • updateWorkflow
    • createWorkflow
    • deleteWorkflow
    • listWorkflows
  • shortcut API
    • get user shortcuts
    • get short cut modules
    • trigger
    • update user shortcuts
    • delete shortcut
  • ScteService API
    • Enable Scte
    • enableScteToSwitcher
  • MOS Gateway API
  • Export api
  • Input&Output Module API
    • Authentication API
      • get "session id" for authentication
    • input-module-api
      • query input list
      • update input
      • run input
      • query input
      • delete input
    • encoder-profile-api
      • createEncodingProfile
      • queryEncodingProfile
      • deleteEncodingProfile
      • encodingProfile
      • createEncodingProfile
      • queryEncodingProfile
      • deleteEncodingProfile
      • encodingProfile
      • queryEncodingProfiles
      • queryEncodingProfiles
      • queryEncodingProfileDict
      • queryEncodingProfileDict
    • output-module-api
      • run output
      • update output
      • query output list
      • query output
      • delete output
  • public
    • data-delete
    • data-delete-retry
    • data-query
    • log-query
  • Export
    • Export a video clip
      POST
    • Export a long video clip in chunks
      POST
    • Estimate output file size before exporting
      POST
    • Export an audio clip
      POST
    • Merge multiple video files into one
      POST
    • Trim a JSON edit list to a time range
      POST
  • Media Info
    • Get a thumbnail image from a video
    • Get technical metadata for a video
  • Create a new slug and trigger recording.
    POST
  • version
    GET
  • Update an existing slug and its recording configuration.
    POST
  • metadata
    GET
  • upload-to-zype
    POST
  • estimate-video-size
    POST
  • estimate-video-size
    GET
  • 查询Object信息
    POST
  • Get object information from the search index by object ID.
    GET
  • Create a new object
    POST
  • Update an existing object.
    PUT
  • Delete an object (requires authentication).
    DELETE
  • Query detailed object information by a list of object IDs.
    POST
  • Query all objects bound to a given tangible ID.
    GET
  • Check whether a specific feature is enabled for a set of objects.
    POST
  • Check whether the specified user is an admin or owner of the given object.
    POST
  • Unlink (detach) a tangible from an object.
    POST
  • Bind a tangible to an object.
    POST
  • Copy an object and bind the copy to a new tangible.
    POST
  • Place a hold on an object to reserve it for exclusive use by an application.
    POST
  • Release a previously held object.
    POST
  • Create a new tangible and bind it to an existing object in a single operation.
    POST
  • Schemas
    • Schemas
      • Pet
      • Category
      • controllers.QueryAnalyzeReq
      • PageShortcut
      • Tag
      • MediaProfileDTO
      • controllers.GenMarkSrtBySIDReq
      • ResultRunOutputVO
      • UserShortcutQuery
      • controllers.QuerySuggestReq
      • TriggerRequest
      • RunOutputVO
      • Object
      • controllers.AutoGenerateFileResp
      • ResultVoid
      • controllers.ApiCapTagParm
      • AgentUpdateWorkFlowDTO
      • controllers.QuerySynonymsReq
      • Shortcut
      • RunInputVO
      • RunOutPutDTO
      • controllers.ApiClickParm
      • Input
      • GetUserShortcutRequest
      • ResultPageInfoRunInputVO
      • controllers.CheckHealthResponse
      • RunInputDTO
      • Output
      • controllers.ApiFaceFrameParm
      • ShortcutUpdateRequest
      • models.AutoGenerateReq
      • PageInfoRunInputVO
      • controllers.DrawFaceFrameResp
      • AgentWorkFlowDTO
      • ResultRunInputVO
      • controllers.ApiFramePersonParm
      • SortField
      • controllers.DrawFaceFrameRetuen
      • SourceObjectListDTO
      • controllers.ApiGetFaceParm
      • AddSourceObjectDTO
      • controllers.FaceGlobalListResp
      • controllers.ApiGetSrtByPeerIdParm
      • LoginUser
      • controllers.FaceInfoReturnData
      • controllers.ApiGetSrtParm
      • OutputLiveVo
      • ProjectRecordVo
      • ResponseResultProjectRecordVo
      • controllers.FaceListResp
      • models.QueryHintsReq
      • models.SceneInfoRequest
      • controllers.FramePersonInfoResp
      • controllers.CapReturnHandleData
      • controllers.GenMarkSrtReq
      • controllers.CapTagResp
      • models.SearchCapWithTagsReq
      • controllers.GenUploadSrt
      • controllers.ClickQueryResp
      • controllers.GetFaceAssetNumResp
      • controllers.ClickQueryReturnData
      • controllers.GetLangReq
      • controllers.GetMarkerResp
      • controllers.GetObjectByTangibleResp
      • controllers.FaceFrameResp
      • controllers.GetObjectFeatureConfResp
      • controllers.GetRRSTaskListResp
      • controllers.GetRecordContentResp
      • controllers.GetRecordingInfoResp
      • controllers.FramePersonResp
      • controllers.GetStoreInfoByGroupIdReq
      • controllers.GetFacePosition
      • controllers.GetStoreInfoByGroupIdResp
      • controllers.GetFaceResp
      • controllers.GetFaceReturnData
      • controllers.GetTagValueByTaskIdResp
      • controllers.GetFaceReturnDataList
      • controllers.HealthReturnData
      • controllers.MergeListResp
      • controllers.NameSuggestMergeListResp
      • controllers.PersonFaceAssetNumReq
      • controllers.PersonInfoV3Resp
      • controllers.PersonListResp
      • controllers.PersonNameResp
      • controllers.QueryAnalyzeResp
      • controllers.QueryHintsResp
      • controllers.GetSrtResp
      • controllers.QuerySuggestResp
      • controllers.QuerySynonymsResp
      • controllers.SceneChangeInfoReturn
      • controllers.SearchCombtagsCaptionResp
      • controllers.SearchDurationIntervalReq
      • controllers.SearchMediaByMpdResp
      • controllers.SearchDurationIntervalResp
      • controllers.SearchMediaByTsResp
      • controllers.SearchMediaByUidResp
      • controllers.SearchMediaObjectResp
      • controllers.SearchPersonListResp
      • controllers.SearchSlugCapWithTagsResp
      • controllers.QuerySubTittle
      • controllers.SearchSlugWithTagsResp
      • controllers.SearchStoryResp
      • controllers.SimpleMarkSrtReq
      • controllers.SlotStrengthResp
      • controllers.SearchTaskIntervalReq
      • controllers.SearchCapWithTagsTittle
      • controllers.StoryGlobalListResp
      • controllers.SearchTaskIntervalResp
      • controllers.StoryListResp
      • controllers.StoryReturnData
      • controllers.SubstanceListReturnData
      • controllers.TestInterResponse
      • controllers.TaskOperationIntervalReq
      • controllers.UpdatePortraitReq
      • controllers.UpdatePortraitResp
      • controllers.UrlAddrResp
      • controllers.UrlInfoResp
      • controllers.UrlReturnData
      • models.EsAdminInfo
      • models.EsFaceFrameStateData
      • controllers.SrtSubTittle
      • models.EsFeatureInfo
      • models.EsGpsInfo
      • models.EsMarkerReturnData
      • models.EsObjectData
      • models.EsObjectFeature
      • controllers.SuggestParm
      • models.EsOwnerInfo
      • models.EsPlaceholdersData
      • models.EsStoryData
      • models.EsSynonymsData
      • models.FaceAssetNumReturnData
      • models.FaceInfoQReq
      • models.GetObjectByTangibleReq
      • models.GetObjectFeatureConfReq
      • models.FileListItem
      • models.HlStory
      • models.MMAStoreGroup
      • models.MarkerQReq
      • models.MediaObjectByUidQReq
      • models.MediaObjectQReq
      • models.MediaObjectResult
      • models.PeerIdAgg
      • models.PeerIdBuckets
      • models.PilotQReq
      • models.RRSTaskCompleteList
      • models.RRSTaskListQInfo
      • models.RRSTaskListQReqFilter
      • models.RecordContentQReq
      • models.RestoreDuration
      • models.SearchCombTagCaptionReq
      • models.RestoreInfo
      • models.SearchMediaByMpdReq
      • models.SearchMediaByTsReq
      • models.SearchStoryWithTagsReq
      • models.Size
      • models.UrlInfoData
      • models.UserUsage
      • service.AnaData
      • models.SearchCapReturnData
    • Sample Schemas
    • Producer
      • Schemas
        • SourceSwitchVo
        • PlayListItem
        • UserSingularApp
        • SourcePVWSwitchVo
        • PlayList
        • VideoMotion
        • ProgramGang
        • UpdateAISettingRequest
        • PlayReq
        • PlayAllClipPlayerRequest
        • UserCustomSource
        • AudioTransactionReqVo
        • ProgramSource
        • FileInfo
        • ProgramPlaylist
        • AddSourceParam
        • ProgramPlaylistQuery
        • StopLiveRequest
        • UploadSourceThumbnailRequest
        • Overlay
        • OverlayRequest
        • SourceParamVo
        • ClipPlayer
        • Program
        • CreateRTPFECSourceParam
        • ProgramGraphicUrl
        • OverlayPIP
        • ProgramQuery
        • ProgramVO
        • ProgramInput
        • Slot
        • PvwPgm
        • RTILUser
        • AddOrRemoveMembersRequest
        • CreateSRTSourceParam
        • FileUploadResponseForS3
        • ProgramFeaturesInput
        • SourceDelayRequest
        • ProgramTeamMember
        • SlaveProgramAndFeature
        • GangOperateRequest
        • FileInfoQueryRequest
        • StudioLogo
        • UploadSourceResult
        • ProgramPrivateServer
        • Features
        • OverlayLogo
        • ObjectResource
        • ProgramFeature
        • ProductionUser
        • ProgramButton
        • LBand
        • FileSourceActionVo
        • LocalVideo
        • UploadFile
        • OverlayUrl
        • UploadSourceRequest
        • Transition
    • Response
    • ResponseResult
    • Result«Map«Object»»
    • Obj
    • controllers.SubstanceListClickReq
    • PublicDestination
    • controllers.ActiveSearchResp
    • 记录不存在
    • Record not found
    • ProcessResultObject
    • MmaRecordingParam
    • AudioPaddingInfo
    • sortOptions
    • OutputDTO
    • ObjectDetailsInfo
    • controllers.AgentSearchItems
    • 参数不正确
    • Invalid input
    • UpdateVideoEncoderReq
    • RrsRecordingParam
    • VideoPaddingInfo
    • Result
    • ProcessResultListObjectDetailsInfo
    • controllers.AgentSearchReq
    • ReTranscribe
    • CreateSlugRecordParam
    • ThumbnailBaseInfo
    • Map«Object»
    • GraphqlResult
    • controllers.AgentSearchResp
    • UpdateSlugRecordParam
    • VideoBaseInfo
    • AudioEncoderParam
    • key
    • UpdateObjectParam
    • controllers.AutoCompleteResp
    • SourceObj
    • SourceFile
    • EditEncodingProfileDTO
    • Result«CheckPartyVo»
    • ProcessResult
    • controllers.CapReturnData
    • Destination
    • VideoEncoderParam
    • CheckPartyVo
    • CopyObjectParam
    • controllers.CaptionResp
    • StopPreviewParam
    • Transcribe
    • ProfileApiVo
    • TagValueVo
    • DeleteObject
    • controllers.CaptionSearchReq
    • ResponseResultProfileApiVo
    • CommonPartyInfo
    • ProcessResultBoolean
    • controllers.CaptionSearchResp
    • VideoInfo
    • OutputQueryDTO
    • ProcessResultMapBoolean
    • PublicExportReq
    • controllers.CaptionSearchResult
    • BasePreviewVO
    • PublicLongexportReq
    • OutputVo
    • CheckObjectFeature
    • EnableOutputDTO
    • controllers.ContentV2Item
    • Attribute
    • EstimateVideoSizeReq
    • PageResultOutputVo
    • CheckObjectAdmin
    • controllers.ContentV2Resp
    • ExportAudioReqV2
    • ResultPageResultOutputVo
    • ObjTgbRelation
    • controllers.EventItem
    • MergeVideoReq
    • CreateOutputDTO
    • HoldObjectParam
    • ProjectRecord
    • controllers.EventRecordingsResp
    • OutputEncodingProfilePairDTO
    • ReleaseObjectParam
    • CutJsonReqV2
    • controllers.EventResp
    • UpdateAudioEncoderReq
    • PairVo
    • CreateTangibleAndBind
    • PublicExportRes
    • controllers.FetchAllObjectTagResp
    • ResponseResultBasePreviewVO
    • PublicLongexportRes
    • ResponseResultListPairVo
    • AdminInfo
    • controllers.GenMarkSrtResp
    • EstimateVideoSizeRes
    • EncodingProfileDTO
    • OwnerInfo
    • controllers.GetInterValReq
    • ExportAudioResV2
    • PairDetailVO
    • FeatureInfo
    • DisableOutputDTO
    • controllers.GetIntervalResp
    • MergeVideoRes
    • ResponseResultListPairDetailVO
    • GeoInfo
    • controllers.GetObjectDetailResp
    • AudioEncoderRes
    • ObjectRecyclingBin
    • CutJsonRes
    • controllers.GetObjectTagSuggestionResp
    • GetThumbnailResV2
    • EncodingTier
    • CreateObjectAttr
    • controllers.GetRecordingInfoV2Resp
    • GetMetadataRes
    • ResponseResultListSingleTierEncodingProfileRes
    • NestedObjects
    • controllers.GetScteMarkerInfoResp
    • SingleTierEncodingProfileRes
    • OperatorInfo
    • ObjectConnectInfo
    • controllers.GetSummarizationResp
    • VideoEncoderRes
    • TangibleInfo
    • controllers.GetVersionResponse
    • QueryEncodingProfileVO
    • TagInfo
    • controllers.LatestEventResp
    • ResponseResultQueryEncodingProfileVO
    • TypeInfo
    • controllers.MediaFileByIdsReq
    • Audio
    • controllers.MediaFileByIdsResp
    • DestinationLiveDTO
    • LabelAndValue
    • MapBoolean
    • controllers.MediaFileResp
    • ProfileTemplateVo
    • controllers.MediafileItem
    • ResponseResultProfileTemplateVo
    • controllers.NameSuggestionResp
    • Video
    • controllers.ObjectItem
    • UpdateSourceObjectDTO
    • controllers.ObjectResp
    • PermissionDTO
    • ObjectInfoDTO
    • controllers.PersonInfoItem
    • ResponseResultObjectInfoDTO
    • controllers.PersonInfoResp
    • ProjectDTO
    • UpdateProjectDTO
    • controllers.PersonItem
    • controllers.PersonListClickResp
    • ResponseResultSourceSearchPageVo
    • controllers.PersonResp
    • SourceSearchObject
    • WhiteBalanceAdjustDTO
    • controllers.PersonTrackItem
    • SourceSearchPageVo
    • RgbDTO
    • controllers.PersonTrackResp
    • SourceSearchTag
    • AddSourceObjectParam
    • WhiteBalanceDTO
    • controllers.PublicSearchItem
    • controllers.PublicSearchResp
    • ConnectDTO
    • controllers.RecordedFileResp
    • ResponseResultString
    • controllers.RecordingInfoReturnData
    • OutputProjectQueryDTO
    • controllers.ReturnData
    • ActiveOutput
    • controllers.SceneChangeInfoItem
    • OutputEncodingPairs
    • controllers.SceneChangeInfoResp
    • OutputProjectApiVo
    • controllers.SearchCombtagsResp
    • PageInfoOutputProjectApiVo
    • controllers.SearchMediaByIdsResp
    • StreamProfile
    • ResponseResultPageInfoOutputProjectApiVo
    • controllers.SearchObjectByMediaResp
    • CreateProjectDTO
    • SourceAttrPO
    • SwitchConnectDTO
    • controllers.SearchObjectTagsResp
    • ResponseResultOutputProjectApiVo
    • ResponseResultProjectRecord
    • controllers.SearchPersonNameWithTagsResp
    • controllers.SearchSummarizationResp
    • controllers.SearchWordsResp
    • SourceObjectListParam
    • controllers.SettingsResp
    • DestinationVO
    • OrderItem
    • controllers.SuggestionResp
    • PageResultDestinationVO
    • controllers.SupportLangItem
    • ResultPageResultDestinationVO
    • controllers.SupportLangResp
    • ResultDestinationVO
    • controllers.Tvu264StatusItem
    • DestinationObjectEncodingProfileDTO
    • controllers.Tvu264StatusResp
    • controllers.UpdateActivityReq
    • AudioOffsetDTO
    • controllers.UpdateActivityResp
    • controllers.UpdateClickCntResp
    • controllers.UpdateClickReq
    • controllers.WebPersonReturnData
    • ResponseResultWhiteBalanceDetailVO
    • controllers.WordsItem
    • WhiteBalanceDetailVO
    • controllers.WordsResp
    • Scopes
    • models.AccessPermission
    • models.AccessPermissionV2
    • Vector
    • ScopeInfo
    • models.AppearanceAffiliated
    • models.AppearanceAffiliatedContent
    • models.AppearanceContent
    • StreamProfileParam
    • models.AppearanceData
    • models.AppearanceEvent
    • BasePreviewDTO
    • WhiteBalanceParentDTO
    • models.AppearanceFilter
    • ResultOutputDTO
    • models.AppearanceListItem
    • models.AppearanceListResponse
    • models.AppearanceRelationItem
    • models.AppearanceRelations
    • models.AppearanceRelationsRequestV2
    • models.AppearanceRelationsResponse
    • models.AppearanceRelationsResult
    • models.AppearanceSearchFilter
    • models.AppearanceSearchRequest
    • models.AppearanceSearchResponse
    • models.AppearanceSearchResult
    • models.AppearanceSuggestionRequestV2
    • models.AppearanceSuggestionResponse
    • models.AutoSearchReq
    • models.CriteriasCondition
    • models.EsCapfullReturnData
    • models.EsCapfullReturnDataV3
    • models.EsObjectTagData
    • models.EsWordsData
    • models.EventCondition
    • models.EventObjectRecordingsResult
    • models.FetchAllObjectTagReq
    • models.FetchObjectTagReq
    • models.GetIntervalItems
    • models.GetObjectReq
    • models.GpsInfo
    • models.HintData
    • models.HintRetureData
    • models.HitSlug
    • models.HostAppearance
    • models.LocationInfo
    • models.MatchCaptionRet
    • models.MatchFaceRet
    • models.MatchListRet
    • models.MatchLogoRet
    • models.MatchResult
    • models.MatchSlugRet
    • models.MediaFileRet
    • models.MediaFileRetrunData
    • models.MediaInfo
    • models.MediaItem
    • models.ObjectDetail
    • models.ObjectQReq
    • models.ObjectReturnData
    • models.ObjectTagSuggestionReq
    • models.PersonInfo
    • models.PersonReturnData
    • models.PersonTrackInfo
    • models.PreViewMediaInfo
    • models.PubSearchBaseReq
    • models.PubSearchFilters
    • models.PubSearchTsRange
    • models.RecordingInfoQReq
    • models.SceneChangeInfoData
    • models.ScteMarkerInfoReq
    • models.ScteMarkerInfoResult
    • models.SearchAssetResult
    • models.SearchBaseTagsReq
    • models.SearchDurationRange
    • models.SearchFileFormatByPathReq
    • models.SearchFilters
    • models.SearchLocation
    • models.SearchMediaByIdsReq
    • models.SearchMediaByIdsReturnData
    • models.SearchMediaFileBySourceObjectId
    • models.SearchObjectByUserId
    • models.SearchObjectIdByMediaReq
    • models.SearchPersonNameWithTagsReq
    • models.SearchSummarizationRequest
    • models.SearchTags
    • models.SearchTsRange
    • models.SortOptions
    • models.SourceCondition
    • models.SubStanceV2
    • models.SummarizationItem
    • models.SummarizationRequest
    • models.TangibleAttributeData
    • models.TermsItem
    • models.TimestampRange
    • models.Tvu264StatusData
  1. Export

Export a video clip

POST
https://api.tvunetworks.com/export
Trims a video clip from a TVU high-resolution recording archive (HLS/MPD) and uploads
the result to a caller-specified cloud storage location.
This is a long-polling endpoint. On the first call, the server registers the job
and returns errorCode: 1000 with a non-zero timeWait. The client must re-submit the
identical request body at timeWait-millisecond intervals until errorCode reaches
a terminal state:
1005 (Work Finish) — export succeeded; read videoPath, fileSize, videoDuration.
Any other non-1001 code — export failed; read errorMsg.
Task identity is derived from fileName (or an auto-generated hash of
highResolutionMediaFilePath + startTime + duration when omitted). Submitting the
same body while a job is in progress returns the current task state without spawning
a duplicate job.
Key options
isDryrun (default true) — validate the request without performing the actual export.
Set to false to trigger a real export.
isFrameLevel — enable sub-GOP frame-accurate cut points.
isCover — overwrite the output file if it already exists (default false; returns
1100 if the file exists and this flag is not set).
withMetadataJson — also produce a companion JSON metadata sidecar alongside the video.
audioPadding / videoPadding — prepend/append silent audio or black-frame padding.

Error Codes#

CodeMessageCause
1000task created successfullyTask registered; begin polling (timeWait > 0)
1001work not finish.Still processing — wait timeWait ms and poll again
1004file already exist.Source filename conflict (intermediate state)
1005Work FinishExport completed successfully (terminal, timeWait = 0)
1017add user task fail.Internal error creating the export job; retry
1018the request param abnormal.A required field is missing or invalid
1019init aws s3 sdk failed, please contact TVU Support.Destination storage credentials are invalid or unreachable
1020tvu264 some error.Video transcoding process failed
1021upload file failFailed to upload the output file to cloud storage
1026file restore error.Source file is archived (Glacier); restore timed out
1031video export time exceeds limit.System-wide concurrent export quota reached; try later
1032the number of user max export task exceeds limit.This user has too many concurrent export jobs
1035open or create file fail.Server failed to open the output file for writing
1042consume memory task num exceeds limit.Server memory task limit reached; try later
1046insufficient remaining free spaceServer disk is full; contact TVU Support
1050(locate source failed)Cannot locate source TS segments for the requested time range
1051(download temp ts error)Failed to download temporary TS segments
1052(exceed duration limit)Clip duration exceeds the allowed maximum
1053(metadata json error)Failed to generate companion metadata JSON (withMetadataJson=true)
1084from redis get user task fail.Cache lookup failed; retry after a moment
1086get source ts signature url fail.Failed to generate a signed URL for the source media
1093verify required ts fail.Source TS file integrity check failed
1099Media processing encountered an exception. Please retry...Unexpected processing error; retry, then contact TVU Support
1100export file already existed.Output file exists and isCover was not set to true

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Job status (poll again if errorCode == 1001)
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.tvunetworks.com/export' \
--header 'SID: 92575d36dcb631ac94745e6b157de17a5a13d65b31e44869f06854ab928dd80235d4daae8696b4a92a7be5f802c45a219648701fc9ca59f44e9c0f022d5d38a7' \
--header 'Content-Type: application/json' \
--data-raw '{
    "highResolutionMediaFilePath": "https://mma-video-new.s3.us-east-1.amazonaws.com/ts/PRODUCER_RECORDINGS/source-001/live-001/1/play.m3u8",
    "startTime": 1700000000000,
    "duration": 30000,
    "userAccount": "user@example.com",
    "fileName": "clip_20231114_30s",
    "fileType": "mp4",
    "isDryrun": false,
    "destination": {
        "cloudVendor": "s3",
        "bucket": "media-export-bucket",
        "region": "us-east-1",
        "folder": "export/"
    }
}'
Response Response Example
Export complete
{
    "errorCode": 1005,
    "errorMsg": "Work Finish",
    "isDryrun": false,
    "timeWait": 0,
    "videoPath": "https://media-export-bucket.s3.us-east-1.amazonaws.com/export/clip_20231114_30s.mp4",
    "fileSize": 52428800,
    "videoDuration": 30000,
    "thumbnailInfo": {
        "url": "https://mma-video-new.s3.us-east-1.amazonaws.com/ts/PRODUCER_RECORDINGS/source-001/live-001/source-001_live-001_1700000000000_30000.jpg",
        "width": "1920",
        "height": "1080"
    },
    "videoInfo": {
        "url": "https://media-export-bucket.s3.us-east-1.amazonaws.com/export/clip_20231114_30s.mp4",
        "type": "mp4",
        "bitrate": "5000k",
        "width": "1920",
        "height": "1080",
        "framerate": "29.97",
        "duration": "30"
    }
}
Modified at 2026-06-15 13:53:30
Previous
log-query
Next
Export a long video clip in chunks
Built with