TVU Public API Stage
Home
Home
  1. Home
  • 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
        • createObject
        • 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
      • update object attributes
      • delete object tag
      • get object tag
      • get objects' attribute
      • get objects' single attribute
      • get object
      • Get objects with the publicslug attribute set to true.
      • Get objects with the attribute set to a specific value.
    • 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
  • 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
  • Schemas
    • Schemas
      • Pet
      • Category
      • controllers.QueryAnalyzeReq
      • PageShortcut
      • Tag
      • PublicExportRes
      • MediaProfileDTO
      • CutJsonRes
      • CutJsonReqV2
      • 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»»
    • controllers.SubstanceListClickReq
    • PublicExportReq
    • PublicDestination
    • controllers.ActiveSearchResp
    • 记录不存在
    • Record not found
    • ProcessResultObject
    • MmaRecordingParam
    • sortOptions
    • OutputDTO
    • controllers.AgentSearchItems
    • VideoInfo
    • 参数不正确
    • Invalid input
    • UpdateVideoEncoderReq
    • RrsRecordingParam
    • Result
    • controllers.AgentSearchReq
    • ReTranscribe
    • CreateSlugRecordParam
    • Map«Object»
    • controllers.AgentSearchResp
    • UpdateSlugRecordParam
    • AudioEncoderParam
    • key
    • controllers.AutoCompleteResp
    • SourceObj
    • EditEncodingProfileDTO
    • Result«CheckPartyVo»
    • controllers.CapReturnData
    • VideoEncoderParam
    • CheckPartyVo
    • controllers.CaptionResp
    • StopPreviewParam
    • ProfileApiVo
    • TagValueVo
    • controllers.CaptionSearchReq
    • ResponseResultProfileApiVo
    • CommonPartyInfo
    • controllers.CaptionSearchResp
    • OutputQueryDTO
    • controllers.CaptionSearchResult
    • BasePreviewVO
    • OutputVo
    • EnableOutputDTO
    • controllers.ContentV2Item
    • Attribute
    • PageResultOutputVo
    • controllers.ContentV2Resp
    • ResultPageResultOutputVo
    • controllers.EventItem
    • CreateOutputDTO
    • ProjectRecord
    • controllers.EventRecordingsResp
    • OutputEncodingProfilePairDTO
    • controllers.EventResp
    • UpdateAudioEncoderReq
    • PairVo
    • controllers.FetchAllObjectTagResp
    • ResponseResultBasePreviewVO
    • ResponseResultListPairVo
    • controllers.GenMarkSrtResp
    • EncodingProfileDTO
    • controllers.GetInterValReq
    • PairDetailVO
    • DisableOutputDTO
    • controllers.GetIntervalResp
    • ResponseResultListPairDetailVO
    • controllers.GetObjectDetailResp
    • AudioEncoderRes
    • controllers.GetObjectTagSuggestionResp
    • EncodingTier
    • controllers.GetRecordingInfoV2Resp
    • ResponseResultListSingleTierEncodingProfileRes
    • controllers.GetScteMarkerInfoResp
    • SingleTierEncodingProfileRes
    • ObjectConnectInfo
    • controllers.GetSummarizationResp
    • VideoEncoderRes
    • controllers.GetVersionResponse
    • QueryEncodingProfileVO
    • controllers.LatestEventResp
    • ResponseResultQueryEncodingProfileVO
    • controllers.MediaFileByIdsReq
    • Audio
    • controllers.MediaFileByIdsResp
    • DestinationLiveDTO
    • LabelAndValue
    • 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. Home

Authentication API

TVU public HTTP API supports the following authentication methods.

1. Authorization: Bearer#

Your bearer token is AppSecret, which is generated in Command Center -> Setting -> Access App -> Create an Access App with both API Function and BearerToken enabled. This 32-character-long string is composed only of numbers and lowercase letters, e.g. 1234567890abcdefghij123456789012.
Our APIs only allow users to access resources they have permission for. The owner of the AppSecret determines which resources the API can access and manage.
Currently, the approach is supported by MediaHub, TVUSearch, and the endpoint mma.tvunetworks.com.

2. HTTP request header SID#

The owner of the SID(a.k.a Session ID) determines which resources the API can access and manage. `
This API can be used to obtain the session ID. Once retrieved, include this string as the value of the HTTP request header SID when making API calls. Please refer to the code example provided below:
This Javascript snippet can be directly used in Postman as a pre-request script to obtain SID.
// Set your email and password
var email = "YourAccount";
var password = "YourPassword";

// Use the CryptoJS library to calculate the SHA512 hash of the password
var hashedPassword = CryptoJS.SHA512(password).toString(CryptoJS.enc.Hex);

// Construct the request body
var requestBody = {
    "email": email,
    "password": hashedPassword,
    "expireTime": 360
};

// Send an asynchronous request to get the token
pm.sendRequest({
    url: 'https://userservice.tvunetworks.com/userAuth/token/getToken',
    method: 'POST',
    header: 'Content-Type:application/json',
    body: {
        mode: 'raw',
        raw: JSON.stringify(requestBody)
    }
}, function (err, response) {
    // Check for errors and response status code
    if (err || response.code !== 200) {
        console.error('Failed to get token:', err ? err : `Status code: ${response.code}`);
        return;
    }

    // Parse the response body and extract the token
    var responseData = response.json();
    if (responseData.errorCode === "0x0") {
        var token = responseData.result.token;
        // Store the token in an environment variable for subsequent requests
        pm.environment.set("SID", token);
        console.log('Successfully obtained token:', token);
        pm.request.headers.upsert({ key: 'SID', value: token });
    } else {
        console.error('Failed to get token:', responseData.errorInfo);
    }
});

3. HTTP request header AccessKey#

FieldsTypeDescription
appkeystringTVU creates a pair of keys for API users, including AppKey and AppSecret
timestampstringin millisecond. Generating Signature needs it.
signaturestringSignature = MD5(AppSecret + Timestamp)
requestIdstringA random string of 32 characters, including numbers and uppercase and lowercase letters.
This Javascript snippet can be directly used in Postman as a pre-request script to obtain SID.
// a random string of 32 characters, including numbers and uppercase and lowercase letters.
function generateRequestId(length) {
    var result = '';
    var characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
    var charactersLength = characters.length;
    for (var i = 0; i < length; i++) {
        result += characters.charAt(Math.floor(Math.random() * charactersLength));
    }
    return result;
}

var appkey = "your_appkey_got_from_tvu_support";
var appsecret= "your_appsecret_got_from_tvu_support"
var account = "your_tvu_account"

var timestamp = Math.round(new Date().getTime())
var signature= CryptoJS.MD5(appsecret+timestamp).toString()
var requestId = generateRequestId(32);

var accesskey = {
    "requestId": requestId,
    "appkey": appkey,
    "timestamp": timestamp,
    "signature": signature
};

pm.collectionVariables.set("AccessKey", JSON.stringify(accesskey));

4. HTTP request header Authorization#

The logic is the same as described in Method 2 on this page, except that it uses the Authorization request header instead of SID. This applies to endpoints under mma.tvunetworks.com.

5. HTTP request headers appkey/...#

FieldsTypeDescription
appkeystringTVU creates a pair of keys for API users, including AppKey and AppSecret
timestampstringin millisecond. Generating Signature needs it.
signaturestringSignature = MD5(AppSecret + Timestamp)
requestIdstringA random string of 32 characters, including numbers and uppercase and lowercase letters.
accountstringyour TVU account
This Javascript snippet can be directly used in Postman as a pre-request script to obtain SID.
// a random string of 32 characters, including numbers and uppercase and lowercase letters.
function generateRequestId(length) {
    var result = '';
    var characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
    var charactersLength = characters.length;
    for (var i = 0; i < length; i++) {
        result += characters.charAt(Math.floor(Math.random() * charactersLength));
    }
    return result;
}

var appkey = "your_appkey_got_from_tvu_support";
var appsecret= "your_appsecret_got_from_tvu_support"
var account = "your_tvu_account"

var timestamp = Math.round(new Date().getTime())
var signature= CryptoJS.MD5(appsecret+timestamp).toString()
var requestId = generateRequestId(32);

var accesskey = {
    "requestId": requestId,
    "appkey": appkey,
    "timestamp": timestamp,
    "signature": signature,
    "account": account
};

pm.collectionVariables.set("AccessKey", JSON.stringify(accesskey));
Modified at 2025-02-23 23:46:07
Previous
Ingest Integration Workflow
Next
get `SID` for authentication
Built with