Content

Schema

Represents the Content object. It contains data of media (images, videos, audio) present in a connected account.

Fields

· 31
id string · uuid required

Unique ID of the content item.

created_at string · date-time required

Object creation time (UTC date and time in ISO 8601 format)

updated_at string · date-time required

Object updation time (UTC date and time in ISO 8601 format)

work_platform WorkPlatformAttribute
engagement object
external_id string required

Unique content ID on the platform.

title string required

Title of the content item.

format string · enum

Media type of the content item.

values

  • VIDEO
  • IMAGE
  • AUDIO
  • TEXT
  • OTHER
type string · enum required

Platform specific content type.

values

  • VIDEO
  • POST
  • STORY
  • TWEET
  • BLOG
  • IMAGE
url string · uri required

Platform content URL.

media_url string · uri· nullable

Direct media URL of the content item, which can be used to download the media item. This is usually a signed URL and may have certain expiry limits so we recommend using it for downloads as soon as possible (such as when a webhook is received), if you are looking to cache media files with you.

duration integer · nullable required

Video duration in seconds (only available for YouTube).

description string

Description of the content item.

hashtags array of string · nullable

List of hashtags found in the title or description of the content item. If there are no hashtags in the title or description of the content item, then the attribute will be null.

mentions array of string · nullable

List of mentions found in the title or description of the content item. If there are no mentions in the title or description of the content item, then the attribute will be null.

visibility string · enum

Visibility of the content item.

values

  • PUBLIC
  • PRIVATE
thumbnail_url string · uri

Thumbnail URL of the content item, which can be used to download the media thumbnail. This is usually a signed URL and may have certain expiry limits so we recommend using it for downloads as soon as possible (such as when a webhook is received), if you are looking to cache thumbnails with you.

persistent_thumbnail_url string · uri

Persistent thumbnail URL of the content item.

published_at string · date-time required

Publishing timestamp of the content item.

platform_profile_id string required

Unique profile ID of the user on the work platform.

Ex - For YouTube it's the channel ID and for Instagram it's the Instagram page ID.

platform_profile_name string required

User's profile name on the work platform. This is not unique, is displayed prominently on the profile, usually editable and is most commonly associated with that user's identity on the platform.

Ex - For YouTube, it's the channel name displayed on the channel page and for Instagram / Twitter / TikTok etc, it's the name displayed on the user's profile page.

authors array of string

Names of the authors of the publication

audience string · enum

Audience type that the post will be accessible to.

values

  • FREE
  • PAID
  • BOTH
platform string · enum

Platform the the post was published to.

values

  • WEB
  • EMAIL
  • BOTH
content_tags array of string

Content tags associated with the publication.

sponsored object · nullable
audio_track_info object · nullable

Type of audio used in the content. Only available for Instagram Reels, null for other platforms and content types.

collaboration object · nullable
is_owned_by_platform_user boolean · default: true deprecated

true, if the content is owned by the creator. In YouTube, it is possible that content is actually owned by another creator, but current creator has linked that content in their playlist. In such a case the content will still be listed for the current creator.

Used by

· 6 operations