The Media Management API is the only Way to create, update or modify "standard" Media Items or References. All other Endpoints, who may create Media Items only create Items in a UGC Context.
will create a new Media Item of the given Streamtype, if the given urlParameter contains a valid Source for the given Streamtype.
Path Parameters
Name
Type
Description
streamtype
string
the Streamtype of the target Item
Request Body
Name
Type
Description
url*
string
the URL to download the Source
useQueue
boolean
if set to 1, the Download will be queued and the Endpoint will create a "planned" Media Item. Should be used on large Files and especially on Video Items.
queueStart
number
UNIX Timestamp - if Queue is used, start the Import at the given Time
transcodeInBackground
boolean
if set to 1, the file transcoding will be paused until enough system resources are available (for Video, Audio and Variant).
asVariantFor
string
[facebook, instagram, twitter, vimeo, youtube, externalview, tiktok] if Streamtype is a Video, create a new Variant of the given Video with this given Target Platform.
asVariantOf
integer
if Streamtype is Video, create a new Variant for the given Video.
autoPublish
boolean
if set, the Media Item will be automatically published/not published. If omitted, the Domain Settings will be applied.
refnr
string
an internal Reference for the calling Domain
origin
string
a 3Q nexx Reference for an Origin Source.
originReference
string
if given a valid 3Q nexx Origin Source and this Source has its own Reference Ids, this can be defined here.
filename
string
if the original Filename should be stored, send it with this Parameter
language
2-Letter Code
if set and valid, the Media Item (if Video or Audio) will use this Language as Source Language. This may have Effects on automatic Captions and/or Video Detail Analysis.
notes
string
optional Hints and Notes for this Upload for later Inspection
will create a new Media Item of the given Streamtype, if the Streamtype is a valid Single-Streamtype Container (Playlist, Album, Audio Album and Magazine are currently supported).
In Contrast to the /fromdata Endpoint, the Result of this Method is a Topic Container. A Topic Container is a Container, which contains of Elements, that were appended automatically by a certain Logic.
Path Parameters
Name
Type
Description
streamtype
string
the Streamtype of the target Item
Request Body
Name
Type
Description
title
string
the Title of the new Item
itemSource
string
if a topic is defined, Source for the Entries is Media Search, otherwise, itemSource is obligatory [topitems, topitemsexternal, mostliked, mostcommented, bestrated, mostactive, picked]
topic
string
the Key Words for the Search for Items in this Container - only necessary, if itemSource is empty.
duration
integer
the target Duration in Minutes of the Container (only for Playlists and Audio Albums)
items
integer
the target Amount of Container Items (only for Albums and Magazines)
searchMode
string
the desired Way of Searching for finding optimal Items [classicwithand, classicwithor, fulltext]
searchFields
string
if set, the Search will only be performed on the given List of Attribute (comma seperated), otherwise, all Attributes will be searched
channel
integer
an optional Restriction for the selected Child Items
format
integer
an optional Restriction for the selected Child Items
category
iteger
an optional Restriction for the selected Child Items
only necessary for TTS Audio. This endpoint will re-create the Audio File on the current TTS Content. It is also possible to update the Text Content, if the corresponding Parameters are set.
Path Parameters
Name
Type
Description
streamtype*
string
the Streamtype of the target Item
item*
number
the target Item ID
Request Body
Name
Type
Description
title
string
will be used in Speech, if set
subtitle
string
will be used in Speech, if set
teaser
string
will be used in Speech, if set
textcontent
String
will be used in Speech, if set
language
2-Letter Language Code
voice
Voice ID
if set, will override the currently used Voice. You can find a List of all Voices on /system/ttsvoices - please notice, that the "ID" of these Voices are not numeric!
only necessary for Articles. This Endpoint will create/update an Audio Representation of the Article for "reading" Purposes. The correseponding Audio is not a valid Audio Object itself.
a Comma seperated List of the new Item IDs in the desired new Order. Please notice, that for Collections and Sets, the Item IDs are NOT the Media Item IDs, but the Reference IDs within the current Container (as they can hold various Streamtypes, the ID is not enough).
autoorder
string
[title, subtitle, created, uploaded, releasedate, runtime, filesize, random] automatically order the Container by the given Child Attribute (or shuffle it by random)
autoorderdirection
string
[ASC, DESC] if using AutoOrder, set the Sort Order
creates a new LiveStream without an explicit LiveConnection(will be created automatically). This Endpoint is only available, if the calling Domain has "automatic LiveConnection" Feature enabled.
Request Body
Name
Type
Description
title
string
the Title of the new LiveStream
type
string
[event, 247] - the Type of the new LiveStream
sourceType
string
[rtmp, srt] - the sourceType for the new LiveStream
enableDVR
boolean
if set to 1, the new LiveStream will support DVR Features
create a new Audio File by Text-to-Speech AI of the given Text.
Request Body
Name
Type
Description
language
string
interpret the Text in the given Language (defaults to Domain Default Language, if omitted)
voice
Voice ID
if set, will override the currently used Voice. You can find a List of all Voices on /system/ttsvoices - please notice, that the "ID" of these Voices are not numeric!
creates a new Radio without a n explicit LiveLink (will be created automatically). This Endpoint is only available, if the calling Domain has the "automatic LiveLink" Feature enabled.
as the Streamtype "post" only includes external Contents, this Endpoint is closely related to a Media Export. Technically, this Endpoint posts the given Content directly to the given Account and creates a nexxOMNIA Social Post Item out of it. Supported Accounts are Accounts of the Types [facebook, twitter]
Request Body
Name
Type
Description
account
string
the ID of a valid Domain Account
postText
integer
the Text of the Post
postImage
integer
the (optional) ID of an existing Image to attach to the Post
There is also an Endpoint to implicitely create Posts by sharing the Link of a Media Item to a Platform instead of physically exporting it. You will find the /exportaspost Endpoint under Media Export Management.
This Endpoint will update a specific MultiLanguage Set. It takes the same Parameter as the /addtranslation Endpoint, but will update the corresponding Set, if found.
Path Parameters
Name
Type
Description
streamtype*
string
the Streamtype of the target Item
item*
integer
the target Item ID
Query Parameters
Name
Type
Description
language*
string
the 2-Letter-Code of the Language of the MultiLanguage Set to update
add the given Item to the given Rack - Rackssupport only Videos and Live Streams as Child Streamtype (and those cannot be mixed)
Path Parameters
Name
Type
Description
streamtype*
string
the Streamtype of the target Item
item*
integer
the target Item ID
rackd*
integer
the Rack ID
Query Parameters
Name
Type
Description
purpose
Sting
optonal Description of this Item. Can be free String, if the Rack handles Video Alternatives, must be a valid 2-Letter-Language Code, if the Rack contains Audio Alternatives.
This Endpoint will update a specific HotSpot. It takes the same Parameter as the /addhotspot Endpoint, but will update the corresponding HotSpot, if found.
