Skip to content
Changelog

Report a bug

Ayrshare integration: operations for AI agents

Ayrshare connects to Type.com as an integration. This page lists the 120 operations documented for Claude and Codex in Type.com: 67 read, 31 write, 22 destructive.

About Ayrshare

Ayrshare provides a Social Media API that enables developers to programmatically manage and automate social media posts, analytics, and interactions across multiple platforms.

Categories: Marketing & Social

How to connect Ayrshare to Type.com

Access
Organization connection: one shared account for the workspace.
MCP
Selected social-publishing operations are not available through Type’s MCP server. Other operations remain available through MCP, subject to your connection’s permissions. These MCP restrictions do not apply within Type.

To add the connection, follow the steps in Space connections.

Documented operations

120 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

120 operations listed.

  • Read

    Accounts

    List the Facebook ad accounts linked to the authenticated profile, with account status, aggregate performance metrics, and results cached for 10 minutes.

    GET /api/ads/facebook/accounts

  • Read

    Campaigns

    Fetch campaigns for one Facebook ad account by account ID, including remaining budget, campaign status, performance metrics, and scheduling details.

    GET /api/ads/facebook/campaigns

  • Read

    Boosted Ads

    Retrieve boosted Facebook ads by account, ad, or post ID, with status, Meta review results, current spend, real-time metrics, and shareable preview links.

    GET /api/ads/facebook/ads

  • Read

    History

    Retrieve daily Facebook ad spend and performance metrics for ads created with Boost Post, with goal-specific results, aggregated totals, and date filters.

    GET /api/ads/facebook/history

  • Read

    Insights

    Pull live daily Facebook ad metrics for campaigns, ad sets or ads, split by age, gender, country or placement, with paging for long date ranges.

    GET /api/ads/facebook/insights

  • Read

    Interests

    Search Facebook ad targeting interests by keyword for interest IDs and audience size estimates to use in Boost Post, or narrow to a special ad category.

    GET /api/ads/facebook/interests

  • Read

    Regions

    Search Facebook regions such as states and provinces for ad targeting, or call without parameters to list every country that supports region targeting.

    GET /api/ads/facebook/regions

  • Read

    Cities

    Search Facebook cities by name for targeting when boosting an ad. Each result includes its parent region, radius targeting support, and targeting flags.

    GET /api/ads/facebook/cities

  • Read

    DSA Recommendations

    Get Digital Services Act (DSA) beneficiary and payor recommendations for your Facebook ad account, required when boosting posts for ads that target the EU.

    GET /api/ads/facebook/dsaRecommendations

  • Read

    Accounts

    List Meta ad accounts for Instagram ads on the authenticated profile with status and metrics. Needs an Instagram Business account linked through Facebook.

    GET /api/ads/instagram/accounts

  • Read

    Campaigns

    Retrieve campaigns for an Instagram ad account by accountId, with status, budgetRemaining, metrics, and scheduling details. Results cache for 10 minutes.

    GET /api/ads/instagram/campaigns

  • Read

    Regions

    Search regions such as states and provinces for Instagram ad targeting, or call without parameters to list every country that supports region targeting.

    GET /api/ads/instagram/regions

  • Read

    Cities

    Find cities by name for Instagram ad targeting. Results include Facebook's key, region and regionId, supportsCity and supportsRegion flags, and subcities.

    GET /api/ads/instagram/cities

  • Read

    DSA Recommendations

    Get Digital Services Act (DSA) beneficiary and payor recommendations for the Meta ad account behind your Instagram ads, required for ads targeting the EU.

    GET /api/ads/instagram/dsaRecommendations

  • Read

    Boosted Ads

    Retrieve boosted Instagram ads by account, ad, or post ID, with status, Meta review results, current spend, real-time metrics, and shareable preview links.

    GET /api/ads/instagram/ads

  • Read

    History

    Retrieve daily Instagram ad spend and performance metrics, with goal-specific results, aggregated totals, and filters by account, ad, post, and date range.

    GET /api/ads/instagram/history

  • Read

    Insights

    Pull live daily Instagram ad metrics for campaigns, ad sets or ads, split by age, gender, country or placement, with paging for long date ranges.

    GET /api/ads/instagram/insights

  • Read

    Interests

    Search Instagram ad targeting interests by keyword and get audience size estimates. Use returned interest IDs in the interests array to boost posts.

    GET /api/ads/instagram/interests

  • Read

    Analytics on a Post

    Retrieve real-time likes, impressions, views, and reactions for a post sent via Ayrshare, with multiplatform partial-success handling.

    POST /api/analytics/post

  • Read

    Analytics on a Social Network

    Get analytics and demographics on a user's social profile, such as impressions, views, and followers

    POST /api/analytics/social

  • Read

    YouTube Playlists

    Get the playlists for the connected YouTube channel, with each playlist's views, playlist starts, estimated minutes watched, and average view duration.

    GET /api/analytics/youTubePlaylists

  • Read

    Count of Instagram Followers Online

    Retrieve the historical count of your Instagram followers online per hour for a given day, so you can optimize posting times for maximum engagement.

    GET /api/analytics/getInstagramOnlineFollowers

  • Read

    List Auto Schedule

    List your active auto schedules, including each schedule's title, times, and last scheduled date, which shows the next or most recent schedule date.

    GET /api/auto-schedule/list

  • Read

    Get Pending Auto Schedule Posts

    Retrieve every auto schedule post that is still pending and not yet published, using a GET request to /auto-schedule/pending with your API key header.

    GET /api/auto-schedule/pending

  • Read

    List Automations

    List the automations you've created

    GET /api/automations

  • Read

    Get Automation

    Fetch one automation with its triggers and actions

    GET /api/automations/{id}

  • Read

    Get Automation Activity

    Retrieve the last 30 days of dispatch attempts for one automation, newest first, with recipient, matched trigger, per-action results, and status values.

    GET /api/automations/{id}/activity

  • Read

    Get Comments

    Fetch comments on a post by Ayrshare Post ID, Social Post ID, or Comment ID, with multiplatform partial-success responses across networks.

    GET /api/comments/{id}

  • Read

    Get RSS Feeds

    Return every RSS feed registered to your account, with each feed's URL, title, link, autoHashtag and useFirstImage settings, and created and updated dates.

    GET /api/feed

  • Read

    Check Banned Hashtags

    Check whether Instagram or other social networks have banned a hashtag. Pass the hashtag with or without the # sign and get back a true or false result.

    GET /api/hashtags/banned

  • Read

    Recommend Hashtags

    Get suggestions for hashtags based on a keyword

    GET /api/hashtags/recommend

  • Read

    Search Hashtags

    Find public Instagram Media that has been tagged with specific hashtags

    GET /api/hashtags/search

  • Read

    Posts History

    Retrieve posts sent through Ayrshare from newest to oldest, filtered by date range, status, social network, post type, auto repost ID, or the last n days.

    GET /api/history

  • Read

    Post History by ID

    Get the history for a specific post

    GET /api/history/{id}

  • Read

    Get post history for a social platform

    Fetch posts and analytics from Bluesky, Facebook, Instagram, LinkedIn, Pinterest, Snapchat, Threads, TikTok, X, and YouTube, including non-Ayrshare posts.

    GET /api/history/{platform}

  • Read

    Posts History by Social ID

    Retrieve history for a post that did not originate via Ayrshare.

    GET /api/history/{socialId}

  • Read

    Link Analytics

    Get analytics on shortened links

    GET /api/links/{id}

  • Read

    Get Brand Data

    Get a social account information by a user name

    GET /api/brand/byUser

  • Read

    Search Facebook Pages

    Search for Facebook Pages based on a search query

    GET /api/brand/search/facebook

  • Read

    Search LinkedIn

    Search for LinkedIn companies or people

    GET /api/brand/search/linkedin

  • Read

    Search Tweets by Keyword

    Search X/Twitter for tweets matching keywords or hashtags

    GET /api/listen/keyword

  • Read

    Get All Media in Gallery

    Retrieve all the images and videos uploaded to the gallery

    GET /api/media

  • Read

    Metadata on a media file

    Get the metadata on a media file URL

    GET /api/media/meta

  • Read

    Search Instagram audio

    Search Instagram's licensed audio catalog for a track to attach to a Reel

    GET /api/media/instagram/audio/search

  • Read

    Get Instagram audio metadata

    Look up the details of a single Instagram audio track by its id

    GET /api/media/instagram/audio/{audioId}

  • Read

    Get Messages

    Get messages or conversations for a messaging platform

    GET /api/messages/{platform}

  • Read

    Get Auto Response

    Get the auto response setting

    GET /api/messages/autoresponse

  • Read

    Get a Post

    Retrieve a post by Ayrshare Post ID

    GET /api/post/{id}

  • Read

    Get User Profiles

    Get all the profiles associated with the primary profile.

    GET /api/profiles

  • Read

    Get All Reviews

    Retrieve all the reviews for the specified platform

    GET /api/reviews

  • Read

    Get a Single Review

    Fetch one Google Business Profile review by its ID, including the rating, review text, reviewer name and profile, and any reply posted by the business.

    GET /api/reviews/{id}

  • Read

    User Profile Details

    Get linked social accounts, usernames, account status, and usage metrics for the user or a User Profile, including response caching and monthly post quota.

    GET /api/user

  • Read

    Pinterest Boards

    Get Details for Pinterest User Boards

    GET /api/user/details/pinterest

  • Read

    WhatsApp Business Profile

    Get the current WhatsApp business profile for the linked WhatsApp account

    GET /api/user/details/whatsapp

  • Read

    Batch Get All

    Retrieve the user data for all user profiles

    GET /api/user/batch

  • Read

    Collaborator Request Status

    Check whether invited collaborators accepted, declined or are pending on Instagram Reels, images and carousels, or on Facebook Reels.

    GET /api/post/collaborators/{id}

  • Read

    Reddit Flair

    Retrieve the flair id for a subreddit to be used with a Reddit post

    GET /api/post/redditFlair/{subreddit}

  • Read

    User Lookups

    Retrieve the users (handles) looked up for the current month.

    GET /api/user/lookups

  • Read

    YouTube Categories

    Retrieve the YouTube categories ids for a given region

    GET /api/post/youtubeCategories/{region}

  • Read

    Check Post Length

    Calculate the weighted length, or character count, of a post string

    POST /api/validate/postLength

  • Read

    Check Subreddit Exists

    Pass a subreddit name as a path parameter to verify it. The response returns a success status, the subReddit name, and an exists value of true or false.

    GET /api/validate/redditExists/{subreddit}

  • Read

    Content Moderation

    Check content to ensure it is not harmful or inappropriate

    POST /api/validate/moderation

  • Read

    Validate JSON

    Send JSON to validate if correctly formatted

    POST /api/validate/json

  • Read

    Validate a Post

    Validate a post before publishing

    POST /api/validate/post

  • Read

    List Registered Webhooks

    Return the webhook URLs registered for your account. Set allWebhooks to true to list the webhooks for every User Profile, including the Primary Profile.

    GET /api/hook/webhook

  • Read

    Webhook History

    Get webhook delivery history grouped by action

    GET /api/hook/history

  • Write

    Set Auto Schedule

    Set up an auto-post schedule by providing times to send

    POST /api/auto-schedule/set

  • Write

    Create Automation

    Create a new engagement-triggered automation

    POST /api/automations

  • Write

    Post a Comment

    Add a comment to a post with an Ayrshare Post ID or Social Post ID, including supported platforms, body parameters, and @mentions in comments.

    POST /api/comments

  • Write

    Reply to a Comment

    Reply by Ayrshare or Social Comment ID on Bluesky, Facebook, Instagram, LinkedIn, TikTok, X, and YouTube, with @mentions and one image on Facebook or LinkedIn.

    POST /api/comments/reply/{commentId}

  • Write

    Add RSS Feed

    Add a new RSS feed for automated posting of new articles

    POST /api/feed

  • Write

    Generate Post Text

    Generate a new social post using AI

    POST /api/generate/post

  • Write

    Rewrite Post

    Generate variations of a social media post using AI

    POST /api/generate/rewrite

  • Write

    Transcribe a Video

    Provide a transcription and title of a video file using AI

    POST /api/generate/transcription

  • Write

    Translate Post

    Translate text for a post to another language

    POST /api/generate/translate

  • Write

    Generate Alt Text

    Create AI-generated alt text for your images

    POST /api/generate/altText

  • Write

    Sentiment Analysis

    Generate a sentiment analysis on a social media post or comment

    POST /api/generate/sentiment

  • Write

    Auto Hashtags

    Add the most relevant hashtags to your post

    POST /api/hashtags/auto

  • Write

    Upload Image or Video

    Upload an image or small video file to include in your post

    POST /api/media/upload

  • Write

    Upload Large Media Files

    For file uploads greater than 10 MB, obtain a presigned URL to upload a file

    GET /api/media/uploadUrl

  • Write

    Verify Media URL Exists

    Verify that the media file exists

    POST /api/media/urlExists

  • Write

    Resize an Image

    Resize an image to social media dimensions, add watermarks, or crop

    POST /api/media/resize

  • Write

    Send Message

    Send a direct message to a recipient

    POST /api/messages/{platform}

  • Write

    Set Auto Response

    Automatically send message auto responses

    POST /api/messages/autoresponse

  • Write

    Publish a Post API: Post to Any Social Network

    Publish to Facebook, Instagram, X, LinkedIn, TikTok, YouTube, and more with one Ayrshare API call. See parameters, code examples, and supported media.

    POST /api/post

  • Write

    Update a Post

    Update a scheduled post's metadata

    PATCH /api/post

  • Write

    Copy a Post

    Copy an existing post to new social media platforms with the same content, choose target platforms, set a schedule date, and override platform options.

    POST /api/post/copy

  • Write

    Bulk Post

    Bulk schedule posts with a CSV file

    POST /api/post/bulk

  • Write

    Create a User Profile

    Create a new User Profile under your Primary Profile.

    POST /api/profiles

  • Write

    Update a User Profile

    Change a User Profile's title, disabled social networks, messaging status, tags, and linkage page header or logo settings, using its Profile Key.

    PATCH /api/profiles

  • Write

    Generate a Linking URL (generateJWT) (deprecated)

    Create a social-linking URL for a User Profile with the generateJWT endpoint.

    POST /api/profiles/generateJWT

  • Write

    Reply to a Review

    Post a text reply to a Facebook or Google Business Profile review by sending the platform and review ID, and see the success and error responses returned.

    POST /api/reviews

  • Write

    Update User

    Update the account or user data of the social network

    PATCH /api/user/{platform}

  • Write

    Set YouTube Watermark

    Set a watermark on your YouTube channel

    POST /api/post/youTubeWatermark

  • Write

    Register Webhook

    Register a webhook URL for an action such as scheduled, messages, or comments on the Primary Profile or a User Profile, with an optional HMAC secret.

    POST /api/hook/webhook

  • Destructive

    Boost Post

    Boost an existing Facebook post into a paid ad with custom targeting, budget, scheduling, and ad goals, plus the payment method and settings Meta requires.

    POST /api/ads/facebook/boost

  • Destructive

    Update Ad

    Set a Facebook boosted ad to active, paused, deleted, or archived by adId, and see how status changes apply to boosts attached to an existing campaign.

    PUT /api/ads/facebook/ads

  • Destructive

    Boost Post

    Boost an existing Instagram post into a paid ad with custom targeting, budget, scheduling, and ad goals, plus the payment method and settings Meta requires.

    POST /api/ads/instagram/boost

  • Destructive

    Update Ad

    Change an Instagram boosted ad's status with adId via PUT /ads/instagram/ads. Learn why attachTo campaigns keep their status and when untracked ads fail.

    PUT /api/ads/instagram/ads

  • Destructive

    Delete Auto Schedule

    Delete an auto schedule by its title, or the default schedule if no title is given, and optionally reset the schedule's starting point to the current time.

    DELETE /api/auto-schedule/delete

  • Destructive

    Update Automation

    Update an existing automation

    PUT /api/automations/{id}

  • Destructive

    Delete Automation

    Soft-delete an automation by ID to stop new dispatches. Activity history stays queryable, it no longer counts against your cap, and it can't be restored.

    DELETE /api/automations/{id}

  • Destructive

    Delete Comments

    Delete either a single comment or all comments under a post

    DELETE /api/comments/{id}

  • Destructive

    Delete RSS Feed

    Delete an RSS Feed that was previously added

    DELETE /api/feed

  • Destructive

    Update RSS Feed

    Change settings on an existing RSS feed by its id, toggling useFirstImage to add the article's top image and autoHashtag to add up to 3 relevant hashtags.

    PUT /api/feed

  • Destructive

    Update Short Link

    Update the destination URL of an existing short link

    PUT /api/links/{id}

  • Destructive

    Update Messages

    Update status of a conversation

    PUT /api/messages/{platform}/{conversationId}

  • Destructive

    Delete a Post

    Delete a post using the post ID

    DELETE /api/post

  • Destructive

    Retry a Post

    Retry to publish a post that failed

    PUT /api/post/retry

  • Destructive

    Delete a User Profile

    Delete a user profile you are the owner of.

    DELETE /api/profiles

  • Destructive

    Unlink a Social Network

    Unlink a social network for a given user profile.

    DELETE /api/profiles/social

  • Destructive

    Delete a Review Reply

    Remove a reply you posted on a Google Business Profile review by sending its reviewId and the gmb platform value. Only the reply owner can delete it.

    DELETE /api/reviews

  • Destructive

    Remove YouTube Watermark

    Remove the watermark from your YouTube channel

    DELETE /api/post/youTubeWatermark

  • Destructive

    Unregister Webhook

    Unregister a Webhook associated with an action

    DELETE /api/hook/webhook

  • Destructive

    Rotate Signing Secret

    Safely rotate your webhook signing secret with a 24-hour dual-signing grace window

    POST /api/hook/webhook/secret

  • Destructive

    Run GraphQL query or mutation

    Query supported Ayrshare social media operations through a single GraphQL endpoint.

    POST /graphql

See How connections work for access and permissions, or browse all integrations.

Reference date: October 28, 2026. Ayrshare API docs.