# Ayrshare integration

> Social media API to publish, schedule and analyze posts, manage comments, messages, reviews and ads, and run multi-client profiles across Facebook, Instagram, LinkedIn, X/Twitter, TikTok, YouTube and more.

- Authentication: apiKey

## Tools (120)

- **Add Auto Hashtags**: Returns the post text with relevant hashtags added.
- **Add RSS Feed**: Registers an RSS, Substack or YouTube feed; new articles are posted automatically to the chosen networks.
- **Analyze Sentiment**: Returns the sentiment analysis of a text string.
- **Batch Get All User Profiles**: Returns a pre-signed URL (valid 7 days) to a file holding the data of all User Profiles; a new file may be generated every 3 hours.
- **Boost Facebook Post**: Turns an existing post into a paid Facebook ad. This creates a real campaign that spends the connected ad account's money, daily budget `budget` USD, until `endDate` (indefinitely if unset). Requires the paid Ads add-on and a payment method linked at Meta.
- **Boost Instagram Post**: Turns an existing post into a paid Instagram ad. This creates a real campaign that spends the connected ad account's money, daily budget `budget` USD, until `endDate` (indefinitely if unset). Requires the paid Ads add-on and a payment method linked at Meta.
- **Bulk Schedule Posts**: Schedules many posts from a CSV file upload. Prefer Create Post for new integrations.
- **Check Banned Hashtag**: Checks whether a hashtag is banned.
- **Check Post Length**: Computes the weighted length of a post text per network and whether it fits.
- **Check Subreddit Exists**: Checks that a subreddit exists.
- **Copy Post**: Copies an existing post to other platforms, with optional overrides. Publishes live unless `scheduleDate` is set.
- **Create Automation**: Beta. Creates an Instagram or Facebook DM automation: when a trigger fires (such as a keyword in a comment or DM), the actions run, and they send messages to real people.
- **Create Link Session**: Creates a social linking session and URL for a user to connect accounts.
- **Create Post**: Publishes a post to the linked social networks, or schedules it with `scheduleDate`.
- **Create Short Link**: Shortens a URL, optionally with UTM parameters. The same URL always returns the same short link.
- **Create User Profile**: Creates a User Profile and returns its `profileKey` and `refId`.
- **Delete Automation**: Beta. Deletes an automation.
- **Delete Auto Schedule**: Deletes a named auto-schedule. Posts already scheduled keep their dates.
- **Delete Comments**: Deletes comments, or hides a TikTok comment. Deletion is permanent on the social network.
- **Delete Post**: Deletes a post by ID, several posts, or all pending scheduled posts. Published posts are also removed from the social networks (not Instagram, which cannot be deleted via API).
- **Delete Review Reply**: Deletes your reply to a Google Business Profile review.
- **Delete RSS Feed**: Deletes a registered feed.
- **Delete User Profile**: Deletes a User Profile.
- **Generate Image Alt Text**: Generates alt text for an image with AI.
- **Generate Linking URL**: Generates a JWT linking URL (and optional email) so a user can link social accounts to a User Profile.
- **Generate Post Text**: Generates post text from a description or images with AI. Counts toward a monthly AI usage total.
- **Get Automation**: Beta. Returns one automation with its triggers, actions and stats.
- **Get Automation Activity**: Beta. Returns the paginated activity log of an automation.
- **Get Auto Response**: Returns the current direct message auto-response settings.
- **Get Brand Data**: Returns public profile data for brands and users on supported networks.
- **Get Collaborator Request Status**: Checks whether an Instagram collaborator or Facebook Reel collaborator accepted an invitation.
- **Get Comments**: Gets comments for a post by Ayrshare Post ID, Social Post ID, or comment ID.
- **Get Facebook Ad History**: Returns ads created through Ayrshare with spend and performance metrics for a date range. Requires the paid Ads add-on.
- **Get Facebook Ad Insights**: Returns Meta performance insights per day for campaigns, ad sets or ads, optionally broken down by age, gender, country or placement. Requires the paid Ads add-on.
- **Get Facebook DSA Recommendations**: Returns suggested Digital Services Act beneficiary and payor values for an ad account, for EU-targeted ads. Requires the paid Ads add-on.
- **Get Instagram Ad History**: Returns ads created through Ayrshare with spend and performance metrics for a date range. Requires the paid Ads add-on.
- **Get Instagram Ad Insights**: Returns Meta performance insights per day for campaigns, ad sets or ads, optionally broken down by age, gender, country or placement. Requires the paid Ads add-on.
- **Get Instagram Audio**: Looks up one Instagram audio track by id. Needs Instagram linked through Facebook Login.
- **Get Instagram DSA Recommendations**: Returns suggested Digital Services Act beneficiary and payor values for an ad account, for EU-targeted ads. Requires the paid Ads add-on.
- **Get Instagram Online Followers**: Returns how many Instagram followers were online by hour for a given day.
- **Get Large Media Upload URL**: For files over 10 MB (max 5 GB): returns a presigned `uploadUrl` (valid 30 minutes) to upload the file to, and an `accessUrl` (valid 30 days) to use in `mediaUrls`.
- **Get Link Analytics**: Returns click analytics for one short link, or for all short links when no link ID is given.
- **Get Link Session**: Returns the state of a linking session.
- **Get Media Metadata**: Returns codec, duration, dimensions and size of a media file URL.
- **Get Messages**: Returns messages or conversations for a platform.
- **Get Platform Post History**: Fetches posts and their analytics straight from a social network, including posts not made via Ayrshare.
- **Get Post**: Returns one post by Ayrshare Post ID.
- **Get Post Analytics**: Returns analytics (likes, impressions, views, reactions) for a post published through Ayrshare, per platform. Use `Get Post Analytics by Social ID` for posts made outside Ayrshare.
- **Get Post Analytics by Social ID**: Returns analytics for posts identified by their social network ID, including posts made outside Ayrshare. Same `POST /analytics/post` route as Get Post Analytics, with `searchPlatformId: true` and exactly one platform.
- **Get Post History by ID**: Returns the history of one post by Ayrshare Post ID.
- **Get Post History by Social ID**: Returns history for a post that did not originate in Ayrshare, by its social post ID.
- **Get Profile Details**: Returns the profile's linked social accounts and monthly post and API usage; a cheap call to confirm the credential works.
- **Get Reddit Flairs**: Returns the flair ids available in a subreddit.
- **Get Review**: Returns a single Google Business Profile review.
- **Get Social Account Analytics**: Returns account-level analytics and demographics (impressions, views, followers) for linked social networks.
- **Get User Lookups**: Returns the X/Twitter users looked up this month via `userId`/`userName`.
- **Get Webhook History**: Returns webhook deliveries from the last 6 months.
- **Get WhatsApp Business Profile**: Returns the WhatsApp Business profile details.
- **List Automations**: Beta. Lists automations, optionally filtered by platform.
- **List Auto Schedules**: Lists the active auto-schedules.
- **List Boosted Facebook Ads**: Lists boosted ads by account, ad, or post. Send at least one of the identifying filters. Requires the paid Ads add-on.
- **List Boosted Instagram Ads**: Lists boosted ads by account, ad, or post. Send at least one of the identifying filters. Requires the paid Ads add-on.
- **List Facebook Ad Accounts**: Lists the Facebook ad accounts available to the profile; the `id` is the `accountId` used by the other Facebook ads calls. Requires the paid Ads add-on.
- **List Facebook Ad Campaigns**: Lists campaigns in a Facebook ad account. Requires the paid Ads add-on.
- **List Instagram Ad Accounts**: Lists the Instagram ad accounts available to the profile; the `id` is the `accountId` used by the other Instagram ads calls. Requires the paid Ads add-on.
- **List Instagram Ad Campaigns**: Lists campaigns in a Instagram ad account. Requires the paid Ads add-on.
- **List Media Gallery**: Lists images in the media gallery, including resized images.
- **List Pending Auto Schedule Posts**: Retrieves all pending (not yet published) auto-schedule posts.
- **List Pinterest Boards**: Lists the linked Pinterest account's boards; the id is `pinterestOptions.boardId`.
- **List Post History**: Lists posts sent via Ayrshare, newest first, filterable by dates, status, platform or type.
- **List Reviews**: Returns reviews for Facebook Pages or Google Business Profile.
- **List RSS Feeds**: Returns all registered feeds.
- **List User Profiles**: Lists User Profiles with their linked networks.
- **List Webhooks**: Lists registered webhooks.
- **List YouTube Categories**: Lists YouTube video category ids for a region.
- **List YouTube Playlists**: Lists the linked YouTube channel's playlists; the id is the `youTubeOptions.playListId` for posting.
- **Moderate Content**: Flags harmful or inappropriate text or an image.
- **Post Comment**: Adds a comment to a post. Publishes live on the social network.
- **Recommend Hashtags**: Suggests hashtags for a keyword, sourced from TikTok.
- **Register Webhook**: Registers an HTTPS URL to receive events for an action type.
- **Remove YouTube Watermark**: Removes the watermark from the linked YouTube channel.
- **Reply to Comment**: Replies to a comment, made through Ayrshare or outside it. Publishes live on the social network.
- **Reply to Review**: Posts a public reply to a review.
- **Resize Image**: Resizes, crops, blurs, watermarks or converts an image to fit a network, and stores the result.
- **Retry Post**: Retries a post whose status is `error`. Publishes live; the retry is treated as a scheduled post.
- **Revoke Link Session**: Revokes a linking session so its URL stops working.
- **Rewrite Post**: Rewrites post text into up to 5 variations with AI.
- **Rotate Webhook Signing Secret**: Replaces the secret used to sign webhook deliveries (HMAC).
- **Search Facebook Ad Cities**: Searches cities usable in `locations.cities` when boosting. Each result has the `key` Meta needs. Requires the paid Ads add-on.
- **Search Facebook Ad Interests**: Searches ad targeting interests; pass the returned ids as `interests` when boosting. Requires the paid Ads add-on.
- **Search Facebook Ad Regions**: Searches regions usable in `locations.regions` when boosting. Each result has the `key` Meta needs. Requires the paid Ads add-on.
- **Search Facebook Pages**: Searches Facebook Pages by name.
- **Search Hashtags**: Searches Instagram hashtags by keyword and returns top or recent posts.
- **Search Instagram Ad Cities**: Searches cities usable in `locations.cities` when boosting. Each result has the `key` Meta needs. Requires the paid Ads add-on.
- **Search Instagram Ad Interests**: Searches ad targeting interests; pass the returned ids as `interests` when boosting. Requires the paid Ads add-on.
- **Search Instagram Ad Regions**: Searches regions usable in `locations.regions` when boosting. Each result has the `key` Meta needs. Requires the paid Ads add-on.
- **Search Instagram Audio**: Searches Instagram's audio catalog for a track to attach to a Reel. Needs Instagram linked through Facebook Login.
- **Search LinkedIn**: Searches LinkedIn companies, then people, to find the name used for @mentions.
- **Search Tweets by Keyword**: Searches recent X/Twitter posts by keyword. Needs the X BYO key headers (see Important Notes).
- **Send Message**: Sends a direct message on Facebook, Instagram, X/Twitter or WhatsApp. Delivers to a real person.
- **Set Auto Response**: Turns the automatic reply to new direct messages on or off and sets its text. Active replies message real people.
- **Set Auto Schedule**: Creates or replaces a named auto-post schedule of daily UTC times. Posts sent with `autoSchedule` take the next free slot.
- **Set YouTube Watermark**: Sets a watermark image on the linked YouTube channel. It then shows on all existing and future videos.
- **Transcribe Video**: Transcribes a video hosted by Ayrshare, for example to draft a title.
- **Translate Post**: Translates text into another language.
- **Unlink Social Network**: Unlinks one social network from the profile named by `Profile-Key`.
- **Unregister Webhook**: Removes the webhook for an action type.
- **Update Automation**: Beta. Updates an automation; `triggers` and `actions` replace the full sets. Setting `active` to true can resume sending messages.
- **Update Business Profile Data**: Updates Google Business Profile location data or the WhatsApp Business profile.
- **Update Conversation Status**: Archives or reactivates a conversation.
- **Update Facebook Ad Status**: Changes a boosted ad's status. Setting `active` resumes spending; `deleted` or `archived` stops the ad. Requires the paid Ads add-on.
- **Update Instagram Ad Status**: Changes a boosted ad's status. Setting `active` resumes spending; `deleted` or `archived` stops the ad. Requires the paid Ads add-on.
- **Update Post**: Updates a pending scheduled post (date, approval, pause, notes) or a published YouTube video's visibility and details.
- **Update RSS Feed**: Updates a feed's image and hashtag settings.
- **Update Short Link**: Changes a short link's destination URL.
- **Update User Profile**: Updates a User Profile's title, tags and linking-page branding.
- **Upload Media**: Uploads an image or small video (max 30 MB) to the media library and returns a URL for `mediaUrls`.
- **Validate JSON**: Checks that a JSON body is correctly formatted.
- **Validate Post**: Dry-runs a `/post` body and returns any problems without publishing.
- **Verify Media URL**: Checks that a media URL exists and is reachable; use after a large upload.

Connect Ayrshare in General Input: https://www.generalinput.com/apps/ayrshare