Skip to main content
POST
Create a media object

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
integer<int32>
required

The Dash Social assigned ID of the brand.

Body

application/json
source
enum<string>
required

Source of media.

Available options:
INSTAGRAM,
INSTAGRAM_STORY,
PINTEREST,
FACEBOOK,
TIKTOK,
TIKTOK_AD,
TWITTER,
YOUTUBE,
LINKEDIN,
THREADS,
SNAPCHAT,
UPLOAD,
EDITOR,
AI_GENERATION,
FACEBOOK_ADS,
FACEBOOK_LINK,
FACEBOOK_TEXT,
FACEBOOK_TEXT_LINK,
TWITTER_LINK,
TWITTER_TEXT
type
enum<string>
required

Type of media.

Available options:
IMAGE,
VIDEO,
CAROUSEL,
REEL
callback_socket_id
string

ID of WebSocket to notify when media conversion is complete.

content_tags
any[]

content tag names that brand media can be tagged with

Example:
custom_metrics
object[]
image
object

Data if type is IMAGE.

likeshop
object

Likeshop Stats.

meta
object

Metadata describing this media item.

source_created_at
string<date-time>

An ISO-8601 formatted timestamp of when the source object was created.

source_type
enum<string>

Type of source.

Available options:
UGC,
OWNED,
OTHER
variants
enum<string>[]

Variants of media: TEXT, LINK

Available options:
TEXT,
LINK
video
object

Data if type is VIDEO.

video_predictions_interval_sec
number

Time interval for sampled video predictions

video_suggested_thumbnail_list
object[]

Response

Created

source
enum<string>
required

Source of media.

Available options:
INSTAGRAM,
INSTAGRAM_STORY,
PINTEREST,
FACEBOOK,
TIKTOK,
TIKTOK_AD,
TWITTER,
YOUTUBE,
LINKEDIN,
THREADS,
SNAPCHAT,
UPLOAD,
EDITOR,
AI_GENERATION,
FACEBOOK_ADS,
FACEBOOK_LINK,
FACEBOOK_TEXT,
FACEBOOK_TEXT_LINK,
TWITTER_LINK,
TWITTER_TEXT
type
enum<string>
required

Type of media.

Available options:
IMAGE,
VIDEO,
CAROUSEL,
REEL
brand_id
integer
read-only
brand_media_id
integer
read-only
brand_media_status
string
read-only

Status of the brand media (e.g. PROCESSED, HIDDEN, NEW).

callback_socket_id
string

ID of WebSocket to notify when media conversion is complete.

can_publish_within
object

Media is only allowed to be published within this range of dates.

caption_question
object

Whether the caption of this media item includes a question.

caption_sentiment
object

Sentiment as determined by the caption of this media item.

collections
object
read-only

Collections that the media belong to.

comment_sentiment
object

Sentiment as determined by the aggregated comments on this media item.

community_engagement
integer
read-only

Media engagement for community overview

content_rights_expiry_date
string<date-time>
read-only

Expiry date of the content rights.

content_rights_requested_by
string
read-only

User ID of the person who requested content rights.

content_rights_requested_date
string<date-time>
read-only

Date when the content rights were requested.

content_rights_type
enum<string>
read-only

Content rights status of the media.

Available options:
APPROVED,
NOT_REQUESTED,
REQUESTED,
LAPSED,
FAILED,
EXPIRED
content_tags
any[]

content tag names that brand media can be tagged with

Example:
created_at
string<date-time>
read-only

An ISO-8601 formatted timestamp of when the object was created.

creator
object

Creator info for the media

custom_metrics
object[]
facebook
object
read-only

Facebook source data.

id
integer
read-only

The object's ID.

image
object

Data if type is IMAGE.

instagram
object
read-only

Instagram source data.

instagram_ads
object
read-only

Instagram ads source data.

instagram_story
object
read-only

Instagram story source data.

instagram_story_frame
object
read-only

Instagram story frame source data.

instagram_user
object
read-only

Instagram User source data.

likeshop
object

Likeshop Stats.

linkedin
object
read-only

LinkedIn source data.

media_group
integer
read-only

Media group ID.

meta
object

Metadata describing this media item.

pinterest
object
read-only

Pinterest source data.

predictions
object

Contains vision predictions for this media. Only returned if include query param contains "predictions".

snapchat
object
read-only

Snapchat source data.

source_account_id
string
read-only

The native ID of the account that created this post, if applicable.

source_created_at
string<date-time>

An ISO-8601 formatted timestamp of when the source object was created.

source_id
string
read-only

Source ID of media.

source_type
enum<string>

Type of source.

Available options:
UGC,
OWNED,
OTHER
threads
object
read-only

Threads source data.

tiktok
object
read-only

TikTok source data.

tiktok_ad
object
read-only

TikTok Ad source data.

twitter
object
read-only

Twitter source data.

updated_at
string<date-time>
read-only

An ISO-8601 formatted timestamp of when the object was last updated.

variants
enum<string>[]

Variants of media: TEXT, LINK

Available options:
TEXT,
LINK
video
object

Data if type is VIDEO.

video_predictions
object

Contains vision predictions for video media, which is a list of prediction values by frame equidistant to the length of the video

video_predictions_interval_sec
number

Time interval for sampled video predictions

video_suggested_thumbnail_list
object[]
visual_features
string
read-only

Visual features string of this media

youtube
object
read-only

YouTube source data