> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # GeneratePostData # Package: socialMedia # Namespace: GeneratedContentService # Method link: https://dev.wix.com/docs/api-reference/business-management/marketing/social-media/generated-content-v1/generate-post-data.md ## Permission Scopes: Manage Social Posts: SCOPE.PROMOTE.MANAGE-SOCIAL-POSTS ## Introduction Generates post content for one or more social channels. Returns per-channel post payloads matching an item's content, so you can use the result to create a draft or publish. Provide site assets, a text prompt, or both. --- ## REST API ### Schema ``` Method: generatePostData Description: Generates post content for one or more social channels. Returns per-channel post payloads matching an item's content, so you can use the result to create a draft or publish. Provide site assets, a text prompt, or both. URL: https://www.wixapis.com/social-publisher/v1/generate-post-data Method: POST Method parameters: param name: channels | type: array | description: Channels to generate post content for. When empty, the response includes one entry for each supported channel: Instagram, Facebook, LinkedIn, Twitter, Pinterest, Google Business Profile, and TikTok. A non-empty value narrows the response to the requested channels. | validation: maxItems 10 - enum: INSTAGRAM, FACEBOOK, YOUTUBE, LINKEDIN, TWITTER, PINTEREST, GBP, TIKTOK param name: context | type: context | description: Additional context to incorporate into the generated content. param name: media | type: array | description: Candidate media for the generated post. Accepts images only. Each item carries a `type` (must be image), a `url`, and an optional Wix Media Manager `fileId` for media already in Wix. | validation: maxItems 10 - name: type | type: MediaType | description: Media type. - enum: IMAGE, VIDEO - name: url | type: string | description: Media URL. | validation: format WEB_URL - name: fileId | type: string | description: Media Manager file GUID backing the media. Available only when the media is stored in the Media Manager. | validation: maxLength 1000 param name: siteAssets | type: array | description: Site assets the generated post is based on. | validation: maxItems 10 - name: id | type: string | description: GUID of the asset in the Wix app that owns it. For example, a product GUID for a `STORES_PRODUCT` asset. | validation: maxLength 256 - name: type | type: Type | description: Type of asset. - enum: - BLOG_POST: A Wix Blog post. - EVENT: A Wix Events event. - STORES_PRODUCT: A Wix Stores product. - BOOKINGS_SERVICE: A Wix Bookings service. - STORES_COUPON: A Wix Stores coupon. - STORES_CATEGORY: A Wix Stores category. param name: userInput | type: userInput | description: Free-form guidance for the generated post content. | validation: maxLength 5000 Return type: GeneratePostDataResponse - name: results | type: array | description: Generated post content, one entry per requested channel. - ONE-OF: - name: instagramPost | type: InstagramPost | description: - ONE-OF: - name: imageUrl | type: string | description: The image URL. - name: videoUrl | type: string | description: The video URL. - name: mediaWrapper | type: MediaWrapper | description: The media list. - name: media | type: array | description: List of media items. - name: type | type: MediaType | description: Media type. - enum: IMAGE, VIDEO - name: url | type: string | description: Media URL. | validation: format WEB_URL - name: fileId | type: string | description: Media Manager file GUID backing the media. Available only when the media is stored in the Media Manager. | validation: maxLength 1000 - name: caption | type: string | description: Caption for the post. Can include hashtags (for example, `#crazywildebeest`) and mentions of Instagram users (for example, `@natgeo`). Mentioned users are notified when the post is published. Supports up to 30 hashtags and 20 mentions. | validation: maxLength 2200 - name: postUrl | type: string | description: The post URL on Instagram. - name: insights | type: InstagramInsights | description: Insights from Instagram. - name: likes | type: integer | description: Number of likes. - name: engagement | type: integer | description: Number of engagements. - name: impressions | type: integer | description: Number of impressions. - name: plays | type: integer | description: Number of plays. - name: reach | type: integer | description: Number of accounts reached. - name: comments | type: integer | description: Number of comments. - name: shares | type: integer | description: Number of shares. - name: saved | type: integer | description: Number of saves. - name: totalInteractions | type: integer | description: Total number of interactions. - name: facebookPost | type: FacebookPost | description: - ONE-OF: - name: imageUrl | type: string | description: The image URL. - name: videoUrl | type: string | description: The video URL. - name: link | type: string | description: The link URL. - name: mediaWrapper | type: MediaWrapper | description: The media list. - name: pageId | type: string | description: The page GUID to publish the post to. - name: caption | type: string | description: Caption for the post. - name: postUrl | type: string | description: The post URL on Facebook. - name: linkMetadata | type: LinkMetadata | description: Link preview metadata. Available only when the post contains a link. - name: thumbnailUrl | type: string | description: Thumbnail URL for the link preview. - name: title | type: string | description: Title for the link preview. - name: description | type: string | description: Description for the link preview. - name: insights | type: FacebookInsights | description: Insights from Facebook. - name: impressions | type: FacebookImpressions | description: Impression counts. - name: unique | type: integer | description: Number of unique impressions. - name: total | type: integer | description: Total number of impressions. - name: interactions | type: FacebookInteractions | description: Interaction counts. - name: unique | type: integer | description: Number of unique interactions. - name: total | type: integer | description: Total number of interactions. - name: reactions | type: FacebookReactions | description: Reaction counts. - name: like | type: integer | description: Number of "like" reactions. - name: love | type: integer | description: Number of "love" reactions. - name: wow | type: integer | description: Number of "wow" reactions. - name: haha | type: integer | description: Number of "haha" reactions. - name: sad | type: integer | description: Number of "sad" reactions. - name: anger | type: integer | description: Number of "angry" reactions. - name: activity | type: FacebokActivity | description: Activity counts. - name: share | type: integer | description: Number of shares. - name: like | type: integer | description: Number of likes. - name: comment | type: integer | description: Number of comments. - name: updatedDate | type: string | description: Date and time the insights were last updated. | validation: format date-time - name: linkedinPost | type: LinkedinPost | description: - ONE-OF: - name: imageUrl | type: string | description: The image URL. - name: videoUrl | type: string | description: The video URL. - name: link | type: string | description: The link URL. - name: mediaWrapper | type: MediaWrapper | description: The media list. - name: authorId | type: string | description: Author GUID of the post. Can be an organization page or a personal feed. - name: caption | type: string | description: Caption for the post. - name: linkMetadata | type: LinkMetadata | description: Link preview metadata. Available only when the post contains a link. - name: insights | type: LinkedinPostInsights | description: Insights from LinkedIn. - name: uniqueImpressions | type: integer | description: Number of unique impressions. - name: impression | type: integer | description: Total number of impressions. - name: shares | type: integer | description: Number of shares. - name: engagement | type: float | description: Engagement rate. - name: clicks | type: integer | description: Number of clicks. - name: likes | type: integer | description: Number of likes. - name: comments | type: integer | description: Number of comments. - name: updatedDate | type: string | description: Date and time the insights were last updated. | validation: format date-time - name: twitterPost | type: TwitterPost | description: - ONE-OF: - name: imageUrl | type: string | description: The image URL. - name: videoUrl | type: string | description: The video URL. - name: link | type: string | description: The link URL. - name: mediaWrapper | type: MediaWrapper | description: The media list. - name: caption | type: string | description: Caption for the post. - name: linkMetadata | type: LinkMetadata | description: Link preview metadata. Available only when the post contains a link. - name: insights | type: TwitterInsights | description: Insights from X (Twitter). - name: retweets | type: integer | description: Number of retweets. - name: replies | type: integer | description: Number of replies. - name: likes | type: integer | description: Number of likes. - name: quotes | type: integer | description: Number of quote posts. - name: bookmarks | type: integer | description: Number of bookmarks. - name: impressions | type: integer | description: Number of impressions. - name: updatedDate | type: string | description: Date and time the insights were last updated. | validation: format date-time - name: pinterestPost | type: PinterestPost | description: - name: boardId | type: string | description: The board GUID to publish the post to. | validation: maxLength 128 - name: title | type: string | description: The title of the post. | validation: maxLength 100 - name: description | type: string | description: The description of the post. | validation: maxLength 800 - name: link | type: string | description: The link to include in the post. | validation: maxLength 2048 - name: mediaWrapper | type: MediaWrapper | description: The media list. - name: insights | type: PinterestInsights | description: Insights from Pinterest. - name: impressions | type: integer | description: Number of impressions. - name: clicks | type: integer | description: Number of clicks. - name: saves | type: integer | description: Number of saves. - name: comments | type: integer | description: Number of comments. - name: reactions | type: integer | description: Number of reactions. - name: updatedDate | type: string | description: Date and time the insights were last updated. | validation: format date-time - name: gbpPost | type: GbpPost | description: - name: locationId | type: string | description: The location GUID to publish the post to. | validation: maxLength 128 - name: locationAccountId | type: string | description: Account (group) GUID of the location. | validation: maxLength 128 - name: description | type: string | description: The description of the post. | validation: maxLength 1500 - name: callToAction | type: GbpPostCallToAction | description: Call to action type and URL to include in the post. - name: actionType | type: GbpPostCallToActionType | description: Type of the call to action. - enum: BOOK, ORDER, SHOP, LEARN_MORE, SIGN_UP - name: url | type: string | description: URL of the call to action. | validation: maxLength 2048 - name: mediaWrapper | type: MediaWrapper | description: The media list. - name: insights | type: GbpInsights | description: Insights from Google Business Profile. - name: shares | type: integer | description: Number of shares. Google Business Profile post insights aren't currently available, so this returns `-1`. - name: updatedDate | type: string | description: Date and time the insights were last updated. | validation: format date-time - name: tiktokPhoto | type: TikTokPhoto | description: - name: accountId | type: string | description: The account GUID to publish the photo to. | validation: maxLength 128 - name: privacyLevel | type: TikTokPrivacyLevel | description: Privacy level for the photo. - enum: PUBLIC_TO_EVERYONE, FOLLOWER_OF_CREATOR, MUTUAL_FOLLOW_FRIENDS, SELF_ONLY - name: title | type: string | description: A title for the photo. | validation: maxLength 90 - name: description | type: string | description: A description for the photo. | validation: maxLength 4000 - name: disableComment | type: boolean | description: Whether comments are disabled for the photo. - name: autoAddMusic | type: boolean | description: Whether to automatically add music to the photo. - name: brandContentToggle | type: boolean | description: Whether the content is a paid partnership promoting a third-party business. - name: brandOrganicToggle | type: boolean | description: Whether the content promotes the creator's own business. - name: mediaWrapper | type: MediaWrapper | description: The media list. - name: insights | type: TikTokInsights | description: Insights from TikTok. - name: views | type: integer | description: Number of views. - name: likes | type: integer | description: Number of likes. - name: comments | type: integer | description: Number of comments. - name: shares | type: integer | description: Number of shares. - name: updatedDate | type: string | description: Date and time the insights were last updated. | validation: format date-time - name: channelName | type: ChannelName | description: Channel the content is generated for. - enum: INSTAGRAM, FACEBOOK, YOUTUBE, LINKEDIN, TWITTER, PINTEREST, GBP, TIKTOK ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.promoteGrowthToolsPublisher.generatedContent.generatePostData(options) Description: Generates post content for one or more social channels. Returns per-channel post payloads matching an item's content, so you can use the result to create a draft or publish. Provide site assets, a text prompt, or both. Method parameters: param name: options | type: GeneratePostDataOptions none - name: siteAssets | type: array | description: Site assets the generated post is based on. | validation: maxItems 10 - name: _id | type: string | description: GUID of the asset in the Wix app that owns it. For example, a product GUID for a `STORES_PRODUCT` asset. | validation: maxLength 256 - name: type | type: Type | description: Type of asset. - enum: - BLOG_POST: A Wix Blog post. - EVENT: A Wix Events event. - STORES_PRODUCT: A Wix Stores product. - BOOKINGS_SERVICE: A Wix Bookings service. - STORES_COUPON: A Wix Stores coupon. - STORES_CATEGORY: A Wix Stores category. - name: userInput | type: string | description: Free-form guidance for the generated post content. | validation: maxLength 5000 - name: media | type: array | description: Candidate media for the generated post. Accepts images only. Each item carries a `type` (must be image), a `url`, and an optional Wix Media Manager `fileId` for media already in Wix. | validation: maxItems 10 - name: type | type: MediaType | description: Media type. - enum: IMAGE, VIDEO - name: url | type: string | description: Media URL. | validation: format WEB_URL - name: fileId | type: string | description: Media Manager file GUID backing the media. Available only when the media is stored in the Media Manager. | validation: maxLength 1000 - name: context | type: object | description: Additional context to incorporate into the generated content. - name: channels | type: array | description: Channels to generate post content for. When empty, the response includes one entry for each supported channel: Instagram, Facebook, LinkedIn, Twitter, Pinterest, Google Business Profile, and TikTok. A non-empty value narrows the response to the requested channels. | validation: maxItems 10 - enum: INSTAGRAM, FACEBOOK, YOUTUBE, LINKEDIN, TWITTER, PINTEREST, GBP, TIKTOK Return type: PROMISE - name: results | type: array | description: Generated post content, one entry per requested channel. - ONE-OF: - name: instagramPost | type: InstagramPost | description: - ONE-OF: - name: imageUrl | type: string | description: The image URL. - name: videoUrl | type: string | description: The video URL. - name: mediaWrapper | type: MediaWrapper | description: The media list. - name: media | type: array | description: List of media items. - name: type | type: MediaType | description: Media type. - enum: IMAGE, VIDEO - name: url | type: string | description: Media URL. | validation: format WEB_URL - name: fileId | type: string | description: Media Manager file GUID backing the media. Available only when the media is stored in the Media Manager. | validation: maxLength 1000 - name: caption | type: string | description: Caption for the post. Can include hashtags (for example, `#crazywildebeest`) and mentions of Instagram users (for example, `@natgeo`). Mentioned users are notified when the post is published. Supports up to 30 hashtags and 20 mentions. | validation: maxLength 2200 - name: postUrl | type: string | description: The post URL on Instagram. - name: insights | type: InstagramInsights | description: Insights from Instagram. - name: likes | type: integer | description: Number of likes. - name: engagement | type: integer | description: Number of engagements. - name: impressions | type: integer | description: Number of impressions. - name: plays | type: integer | description: Number of plays. - name: reach | type: integer | description: Number of accounts reached. - name: comments | type: integer | description: Number of comments. - name: shares | type: integer | description: Number of shares. - name: saved | type: integer | description: Number of saves. - name: totalInteractions | type: integer | description: Total number of interactions. - name: facebookPost | type: FacebookPost | description: - ONE-OF: - name: imageUrl | type: string | description: The image URL. - name: videoUrl | type: string | description: The video URL. - name: link | type: string | description: The link URL. - name: mediaWrapper | type: MediaWrapper | description: The media list. - name: pageId | type: string | description: The page GUID to publish the post to. - name: caption | type: string | description: Caption for the post. - name: postUrl | type: string | description: The post URL on Facebook. - name: linkMetadata | type: LinkMetadata | description: Link preview metadata. Available only when the post contains a link. - name: thumbnailUrl | type: string | description: Thumbnail URL for the link preview. - name: title | type: string | description: Title for the link preview. - name: description | type: string | description: Description for the link preview. - name: insights | type: FacebookInsights | description: Insights from Facebook. - name: impressions | type: FacebookImpressions | description: Impression counts. - name: unique | type: integer | description: Number of unique impressions. - name: total | type: integer | description: Total number of impressions. - name: interactions | type: FacebookInteractions | description: Interaction counts. - name: unique | type: integer | description: Number of unique interactions. - name: total | type: integer | description: Total number of interactions. - name: reactions | type: FacebookReactions | description: Reaction counts. - name: like | type: integer | description: Number of "like" reactions. - name: love | type: integer | description: Number of "love" reactions. - name: wow | type: integer | description: Number of "wow" reactions. - name: haha | type: integer | description: Number of "haha" reactions. - name: sad | type: integer | description: Number of "sad" reactions. - name: anger | type: integer | description: Number of "angry" reactions. - name: activity | type: FacebokActivity | description: Activity counts. - name: share | type: integer | description: Number of shares. - name: like | type: integer | description: Number of likes. - name: comment | type: integer | description: Number of comments. - name: _updatedDate | type: Date | description: Date and time the insights were last updated. - name: linkedinPost | type: LinkedinPost | description: - ONE-OF: - name: imageUrl | type: string | description: The image URL. - name: videoUrl | type: string | description: The video URL. - name: link | type: string | description: The link URL. - name: mediaWrapper | type: MediaWrapper | description: The media list. - name: authorId | type: string | description: Author GUID of the post. Can be an organization page or a personal feed. - name: caption | type: string | description: Caption for the post. - name: linkMetadata | type: LinkMetadata | description: Link preview metadata. Available only when the post contains a link. - name: insights | type: LinkedinPostInsights | description: Insights from LinkedIn. - name: uniqueImpressions | type: integer | description: Number of unique impressions. - name: impression | type: integer | description: Total number of impressions. - name: shares | type: integer | description: Number of shares. - name: engagement | type: float | description: Engagement rate. - name: clicks | type: integer | description: Number of clicks. - name: likes | type: integer | description: Number of likes. - name: comments | type: integer | description: Number of comments. - name: _updatedDate | type: Date | description: Date and time the insights were last updated. - name: twitterPost | type: TwitterPost | description: - ONE-OF: - name: imageUrl | type: string | description: The image URL. - name: videoUrl | type: string | description: The video URL. - name: link | type: string | description: The link URL. - name: mediaWrapper | type: MediaWrapper | description: The media list. - name: caption | type: string | description: Caption for the post. - name: linkMetadata | type: LinkMetadata | description: Link preview metadata. Available only when the post contains a link. - name: insights | type: TwitterInsights | description: Insights from X (Twitter). - name: retweets | type: integer | description: Number of retweets. - name: replies | type: integer | description: Number of replies. - name: likes | type: integer | description: Number of likes. - name: quotes | type: integer | description: Number of quote posts. - name: bookmarks | type: integer | description: Number of bookmarks. - name: impressions | type: integer | description: Number of impressions. - name: _updatedDate | type: Date | description: Date and time the insights were last updated. - name: pinterestPost | type: PinterestPost | description: - name: boardId | type: string | description: The board GUID to publish the post to. | validation: maxLength 128 - name: title | type: string | description: The title of the post. | validation: maxLength 100 - name: description | type: string | description: The description of the post. | validation: maxLength 800 - name: link | type: string | description: The link to include in the post. | validation: maxLength 2048 - name: mediaWrapper | type: MediaWrapper | description: The media list. - name: insights | type: PinterestInsights | description: Insights from Pinterest. - name: impressions | type: integer | description: Number of impressions. - name: clicks | type: integer | description: Number of clicks. - name: saves | type: integer | description: Number of saves. - name: comments | type: integer | description: Number of comments. - name: reactions | type: integer | description: Number of reactions. - name: _updatedDate | type: Date | description: Date and time the insights were last updated. - name: gbpPost | type: GbpPost | description: - name: locationId | type: string | description: The location GUID to publish the post to. | validation: maxLength 128 - name: locationAccountId | type: string | description: Account (group) GUID of the location. | validation: maxLength 128 - name: description | type: string | description: The description of the post. | validation: maxLength 1500 - name: callToAction | type: GbpPostCallToAction | description: Call to action type and URL to include in the post. - name: actionType | type: GbpPostCallToActionType | description: Type of the call to action. - enum: BOOK, ORDER, SHOP, LEARN_MORE, SIGN_UP - name: url | type: string | description: URL of the call to action. | validation: maxLength 2048 - name: mediaWrapper | type: MediaWrapper | description: The media list. - name: insights | type: GbpInsights | description: Insights from Google Business Profile. - name: shares | type: integer | description: Number of shares. Google Business Profile post insights aren't currently available, so this returns `-1`. - name: _updatedDate | type: Date | description: Date and time the insights were last updated. - name: tiktokPhoto | type: TikTokPhoto | description: - name: accountId | type: string | description: The account GUID to publish the photo to. | validation: maxLength 128 - name: privacyLevel | type: TikTokPrivacyLevel | description: Privacy level for the photo. - enum: PUBLIC_TO_EVERYONE, FOLLOWER_OF_CREATOR, MUTUAL_FOLLOW_FRIENDS, SELF_ONLY - name: title | type: string | description: A title for the photo. | validation: maxLength 90 - name: description | type: string | description: A description for the photo. | validation: maxLength 4000 - name: disableComment | type: boolean | description: Whether comments are disabled for the photo. - name: autoAddMusic | type: boolean | description: Whether to automatically add music to the photo. - name: brandContentToggle | type: boolean | description: Whether the content is a paid partnership promoting a third-party business. - name: brandOrganicToggle | type: boolean | description: Whether the content promotes the creator's own business. - name: mediaWrapper | type: MediaWrapper | description: The media list. - name: insights | type: TikTokInsights | description: Insights from TikTok. - name: views | type: integer | description: Number of views. - name: likes | type: integer | description: Number of likes. - name: comments | type: integer | description: Number of comments. - name: shares | type: integer | description: Number of shares. - name: _updatedDate | type: Date | description: Date and time the insights were last updated. - name: channelName | type: ChannelName | description: Channel the content is generated for. - enum: INSTAGRAM, FACEBOOK, YOUTUBE, LINKEDIN, TWITTER, PINTEREST, GBP, TIKTOK ``` ### Examples ### generatePostData ```javascript import { generatedContent } from '@wix/promote-growth-tools-publisher'; async function generatePostData(options) { const response = await generatedContent.generatePostData(options); }; ``` ### generatePostData (with elevated permissions) ```javascript import { generatedContent } from '@wix/promote-growth-tools-publisher'; import { auth } from '@wix/essentials'; async function myGeneratePostDataMethod(options) { const elevatedGeneratePostData = auth.elevate(generatedContent.generatePostData); const response = await elevatedGeneratePostData(options); } ``` ### generatePostData (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { generatedContent } from '@wix/promote-growth-tools-publisher'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { generatedContent }, // Include the auth strategy and host as relevant }); async function generatePostData(options) { const response = await myWixClient.generatedContent.generatePostData(options); }; ``` ---