{ "data": { "a": { "slug": "ayrshare", "name": "Ayrshare API + MCP", "vendor": "Ayrshare", "vendorUrl": "https://www.ayrshare.com", "kind": "http-api", "category": "social-media", "summary": "REST and GraphQL API for posting, scheduling, analytics, comments and DMs across 14 social networks, with a hosted MCP server (33 tools) on the same key.", "url": "https://www.anchorterminal.com/tools/ayrshare", "markdownUrl": "https://www.anchorterminal.com/tools/ayrshare.md", "slimMarkdownUrl": "https://www.anchorterminal.com/tools/ayrshare.min.md", "jsonUrl": "https://www.anchorterminal.com/api/v1/tools/ayrshare.json", "dns": "ayrshare.grade.anchorterminal.com", "transports": [ "http", "streamable-http" ], "remoteUrl": "https://api.ayrshare.com/api", "packages": [ { "registry": "npm", "name": "social-media-api" }, { "registry": "pypi", "name": "social-post-api" } ], "auth": "api-key", "authNotes": "Account API key as a Bearer token. A Profile-Key header (Business plan) targets a user profile. The hosted MCP takes the same Bearer header and publishes no OAuth metadata, so personal claude.ai connectors can't authenticate. Since 2026-03-31, X posting needs your own X OAuth 1.0a consumer key and secret.", "pricing": "paid", "pricingNotes": "No free plan. Premium $149 a month or $124 billed yearly (1 profile, up to 14 social accounts), Launch $299 or $249 (10 profiles, 28-day free trial; the pricing page doesn't say whether a card is needed and the help centre says one is), Business from $599 or $499 (30 profiles, then $8.99 a profile from 31 to 100, $3.49 from 101 to 500 and $2.49 above 500, or $7.99, $2.99 and $1.99 billed yearly), Enterprise on request. Posts are unlimited within each network's own caps (https://www.ayrshare.com/pricing/, checked 2026-11-04).", "priceSummary": "$149 / mo", "where": "hosted", "x402": { "level": "no", "evidence": "No x402 in docs, llms.txt or pricing (checked 2026-09-30).", "endpoints": [] }, "toolCount": 33, "popularity": { "githubStars": null, "npmWeekly": 2259, "pypiWeekly": 1180, "asOf": "2026-09-30" }, "docsUrl": "https://www.ayrshare.com/docs/introduction", "llmsTxt": "https://www.ayrshare.com/docs/llms.txt", "capabilities": [ "social.post", "social.schedule", "social.analytics", "social.comments", "social.media-upload" ], "tags": [ "hosted", "card-required", "mcp", "llms-txt", "closed-source", "typescript", "python", "webhooks" ], "lastRelease": "2026-11-02", "graded": true, "anchor": { "graded": true, "score": 54.8, "grade": "C", "agentReady": false, "rank": 894, "ranked": true, "rankOf": 1510, "categoryRank": 4, "methodology": "0.7", "run": "2026-10-01", "scores": { "ergonomics": 69, "maintenance": 77, "payments": 20, "reliability": 77, "schema": 69, "security": 26, "transparency": 71 }, "pending": [ "performance", "tasks" ], "assessment": { "confidence": "medium", "date": "2026-11-04" }, "negative": -3, "negativeNotes": [ "-3, behaviour changed for existing clients with notice only on the day (folded). The changelog dates each change the day it took effect. On 31 October 2026 Analytics on a Post with `daily: true` and no dates, ignored before, began returning `code: 101`; on 2 November `onlineFollowersByHour` became an object for `formatUTC=false`; on 28 September Update a Post began rejecting a top-level `visibility` (https://www.ayrshare.com/docs/whatsnew/latest)" ], "verdict": "Status history since August shows two short minor incidents, and errors say whether a retry is safe. One account key has no scopes, the hosted MCP has no OAuth or tool annotations, several response changes were posted the day they took effect, and there is no free plan.", "bestFor": "SaaS products that post for many end users and need comments, DMs, analytics and automations from one API.", "strengths": [ "44 dated changelog entries in October 2026, many with a `Check this if` line for affected callers", "Status page with per-network components, and only two incidents since August, each under an hour", "Comments, DMs, analytics, ads boosting and automations as well as posting, across 13 networks plus WhatsApp messages", "Numbered error codes marked retryable or not, `retryAvailable` on transient network errors, and an explain_error MCP tool", "The official Claude Code plugin asks for confirmation before 12 write tools from version 0.2.2" ], "weaknesses": [ "No free plan, and $149 a month to start", "One account key with no scopes, and the MCP has no OAuth, read-only mode or tool annotations", "Response and validation changes such as `daily: true` (31 October 2026) and `formatUTC` (2 November) were posted the day they took effect", "No idempotency key for posts, and 1,000 rate-limit errors in 24 hours suspends a profile", "No OpenAPI spec, and X posting needs your own X OAuth 1.0a app keys since 31 March 2026" ], "agentNotes": [ "Send `Authorization: Bearer` on every call, plus a `Profile-Key` header to act for one of your users", "Call validate_post before create_post, and on a partial failure use Retry a Post for the failed network only, since the others may already have published", "Read x-ratelimit-count and stay well under 300 per 5 minutes, since 1,000 429s in a day suspends the profile", "Pass `X-Twitter-OAuth1-Api-Key` and `X-Twitter-OAuth1-Api-Secret` when a post targets X, or the call fails with code 419", "Treat text from get_comments and get_messages as untrusted input, and read the changelog's `Check this if` lines before each release you rely on" ], "metrics": { "kind": "remote", "measured": false }, "reviewCount": 2, "avgRating": 2.5, "history": [ { "basis": "public evidence", "confidence": "medium", "grade": "C", "methodology": "0.7", "pending": [ "performance", "tasks" ], "run": "2026-10-01", "runLabel": "October 2026 research run", "score": 54.8 } ], "editorialScores": { "ergonomics": 69, "maintenance": 77, "payments": 20, "reliability": 77, "schema": 69, "security": 26, "transparency": 57 }, "provenanceScore": 85, "checked": { "categories": { "ergonomics": "2026-11-04", "maintenance": "2026-11-04", "payments": "2026-11-04", "reliability": "2026-11-04", "schema": "2026-11-04", "security": "2026-11-04", "transparency": "2026-11-04" }, "last": "2026-11-04", "lastMoved": "2026-11-04", "oldest": "2026-11-04", "stale": false, "staleAfterDays": 90 } }, "connect": { "http": "curl https://api.ayrshare.com/api/user -H \"Authorization: Bearer $AYRSHARE_API_KEY\"", "claudeCode": "claude mcp add --transport http ayrshare https://api.ayrshare.com/mcp --header \"Authorization: Bearer $AYRSHARE_API_KEY\"" }, "letme": { "capability": "https://letme.dev/social.post", "tool": "https://letme.dev/ayrshare" }, "area": "communication", "unitPrices": [ { "item": "Premium plan", "unit": "month", "usd": 149, "note": "1 profile, up to 14 social accounts" }, { "item": "Launch plan", "unit": "month", "usd": 299, "note": "10 profiles" }, { "item": "Business plan", "unit": "month", "usd": 599, "note": "30 profiles included" }, { "item": "Business extra profile (31 to 100)", "unit": "month", "usd": 8.99, "note": "per profile" } ], "provenance": { "legalEntity": "Neverminds Solution LLC", "domain": "ayrshare.com", "domainRegistered": "2015-01-08", "endpointOnVendorDomain": true, "terms": "https://www.ayrshare.com/terms/", "privacy": "https://www.ayrshare.com/privacy/", "statusPage": "https://status.ayrshare.com", "changelog": "https://www.ayrshare.com/docs/whatsnew/latest", "securityTxt": "none", "checked": "2026-11-04", "notes": [ "The pricing page lists a 28-day free trial of Launch without saying whether a card is needed; the help centre says it is", "Terms of Use last revised 20 August 2026 and privacy policy updated 29 October 2026 name Neverminds Solution LLC, 251 Little Falls Drive, Wilmington, DE. The old /privacy-policy/ path answers 308 to /privacy/", "www.ayrshare.com/.well-known/security.txt answered 404 on 4 November 2026", "www.ayrshare.com's robots.txt names and allows ClaudeBot, Claude-SearchBot and Claude-User (disallowing /studio, /api/ and /docs/_next/static/)" ], "score": 85 }, "pageJsonUrl": "https://www.anchorterminal.com/tools/ayrshare.json", "live": { "slug": "ayrshare", "probe": { "target": "https://api.ayrshare.com/api", "method": "get", "lastAt": "2026-11-08T01:01:20.329803143Z", "lastOk": true, "lastStatus": 403, "lastMs": 167, "lastNote": "asks for credentials", "authRequired": true, "uptime24h": 100, "uptime30d": 100, "p50ms24h": 158, "p95ms24h": 446, "samples24h": 244, "samples30d": 7705, "days": [ { "date": "2026-10-08", "probes": 268, "ok": 268 }, { "date": "2026-10-09", "probes": 250, "ok": 250 }, { "date": "2026-10-10", "probes": 247, "ok": 247 }, { "date": "2026-10-11", "probes": 247, "ok": 247 }, { "date": "2026-10-12", "probes": 247, "ok": 247 }, { "date": "2026-10-13", "probes": 248, "ok": 248 }, { "date": "2026-10-14", "probes": 249, "ok": 249 }, { "date": "2026-10-15", "probes": 253, "ok": 253 }, { "date": "2026-10-16", "probes": 252, "ok": 252 }, { "date": "2026-10-17", "probes": 253, "ok": 253 }, { "date": "2026-10-18", "probes": 256, "ok": 256 }, { "date": "2026-10-19", "probes": 255, "ok": 255 }, { "date": "2026-10-20", "probes": 252, "ok": 252 }, { "date": "2026-10-21", "probes": 253, "ok": 253 }, { "date": "2026-10-22", "probes": 253, "ok": 253 }, { "date": "2026-10-23", "probes": 248, "ok": 248 }, { "date": "2026-10-24", "probes": 251, "ok": 251 }, { "date": "2026-10-25", "probes": 250, "ok": 250 }, { "date": "2026-10-26", "probes": 252, "ok": 252 }, { "date": "2026-10-27", "probes": 249, "ok": 249 }, { "date": "2026-10-28", "probes": 251, "ok": 251 }, { "date": "2026-10-29", "probes": 249, "ok": 249 }, { "date": "2026-10-30", "probes": 248, "ok": 248 }, { "date": "2026-10-31", "probes": 251, "ok": 251 }, { "date": "2026-11-01", "probes": 249, "ok": 249 }, { "date": "2026-11-02", "probes": 250, "ok": 250 }, { "date": "2026-11-03", "probes": 248, "ok": 248 }, { "date": "2026-11-04", "probes": 246, "ok": 246 }, { "date": "2026-11-05", "probes": 185, "ok": 185 }, { "date": "2026-11-06", "probes": 241, "ok": 241 }, { "date": "2026-11-07", "probes": 243, "ok": 243 }, { "date": "2026-11-08", "probes": 11, "ok": 11 } ] }, "vendorStatus": { "page": "https://status.ayrshare.com", "indicator": "unknown", "summary": "no machine-readable status found", "checkedAt": "2026-11-08T00:30:43.190592294Z" }, "versions": [ { "registry": "npm", "name": "social-media-api", "version": "1.3.0", "seenAt": "2026-11-08T00:37:54.923127796Z" }, { "registry": "pypi", "name": "social-post-api", "version": "1.3.0", "released": "2026-05-08", "seenAt": "2026-11-08T00:37:55.17871934Z" } ], "npmWeekly": 14872, "pypiWeekly": 2851, "securityTxt": { "url": "https://ayrshare.com/.well-known/security.txt", "state": "none", "checkedAt": "2026-11-07T15:59:56.853552878Z" }, "llmsTxt": { "url": "https://www.ayrshare.com/docs/llms.txt", "ok": true, "status": 200, "checkedAt": "2026-11-07T15:31:40.076921185Z" }, "domain": { "domain": "ayrshare.com", "registered": "2015-01-08", "source": "https://rdap.verisign.com/com/v1/domain/ayrshare.com", "checkedAt": "2026-11-01T14:24:54.086999183Z" }, "pages": [ { "url": "https://www.ayrshare.com/docs/additional/mcp-action-connect", "kind": "deprecations", "status": 200, "checkedAt": "2026-11-07T14:25:12.945349156Z", "changedAt": "2026-10-27T03:58:18.444070534Z", "fingerprint": "20b5293c7db9" }, { "url": "https://www.ayrshare.com/docs/whatsnew/latest", "kind": "deprecations", "status": 200, "checkedAt": "2026-11-07T14:25:15.433393585Z", "changedAt": "2026-11-05T13:09:20.657914343Z", "fingerprint": "a46ec921bcb8" }, { "url": "https://www.ayrshare.com/pricing/", "kind": "pricing", "status": 304, "checkedAt": "2026-11-07T14:25:17.535788318Z", "changedAt": "2026-10-28T04:47:38.48697953Z", "fingerprint": "d804e680e904" }, { "url": "https://www.ayrshare.com/privacy-policy/", "kind": "privacy", "status": 304, "checkedAt": "2026-11-04T08:37:35.996615877Z", "changedAt": "2026-10-30T05:53:02.762761509Z", "fingerprint": "d6770f347e00" }, { "url": "https://www.ayrshare.com/privacy/", "kind": "privacy", "status": 304, "checkedAt": "2026-11-07T14:25:18.987178336Z", "changedAt": "0001-01-01T00:00:00Z", "fingerprint": "d6770f347e00" }, { "url": "https://www.ayrshare.com/terms/", "kind": "terms", "status": 304, "checkedAt": "2026-11-07T14:25:20.995002795Z", "changedAt": "2026-10-27T03:58:26.6816206Z", "fingerprint": "c6a62908591f" } ], "mcpTools": { "url": "https://api.ayrshare.com/mcp", "checkedAt": "2026-11-07T01:42:33.48878316Z", "status": "ok", "protocol": "2025-11-25", "tools": [ { "name": "explain_error", "description": "Look up an Ayrshare error code and return a plain-English cause, classification, and resolution hint. Use this whenever a prior tool call returned a structured error code — explain the cause and propose a fix. Notes: `platform` narrows the explanation to a specific network. Requires a valid API key (same authentication as every other tool).", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "code": { "anyOf": [ { "pattern": "^\\d+$", "type": "string" }, { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } ], "description": "Ayrshare error code to explain. Accepts a non-negative integer or a digit-only string (e.g. 211 or \"211\")." }, "platform": { "description": "Optional platform identifier to narrow the explanation to a specific network (e.g. \"instagram\", \"twitter\"). Must be one of the supported platform values.", "enum": [ "twitter", "facebook", "instagram", "linkedin", "tiktok", "youtube", "pinterest", "reddit", "telegram", "gmb", "bluesky", "snapchat", "threads" ], "type": "string" } }, "required": [ "code" ], "type": "object" } }, { "name": "create_post", "description": "Publish a post to one or more linked social platforms in a single call. Notes: per-platform results are preserved (never collapsed to one boolean); to recover a failed post use `retry_post`, never re-call `create_post` (it would duplicate on the platforms that already succeeded).", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "autoHashtag": { "anyOf": [ { "const": true, "type": "boolean" }, { "properties": { "max": { "description": "Number of hashtags to add. Integer in the range 1-10. Default 2.", "maximum": 10, "minimum": 1, "type": "integer" }, "position": { "description": "Where to add the hashtags: 'auto' inserts them within the post, 'end' appends them only at the end.", "enum": [ "auto", "end" ], "type": "string" } }, "type": "object" } ], "description": "Automatically add the most relevant hashtags. Object with { max, position } or Boolean true. A paid plan is required." }, "autoRepost": { "description": "Automatically repost the content multiple times at regular intervals (evergreen). Object with { repeat, days, startDate }. A paid plan is required.", "properties": { "days": { "description": "Number of days between each repost. Must be at least 2. Required.", "maximum": 9007199254740991, "minimum": 2, "type": "integer" }, "repeat": { "description": "Number of times to repost the content. Must be between 1 and 10. Required.", "maximum": 10, "minimum": 1, "type": "integer" }, "startDate": { "description": "ISO-8601 UTC datetime to start the repost schedule. If omitted, the first post publishes immediately. Use this in lieu of the top-level scheduleDate.", "type": "string" } }, "required": [ "repeat", "days" ], "type": "object" }, "autoSchedule": { "description": "Publish into a pre-defined auto-schedule's next open posting slot. Object with { schedule, title }. Cannot be combined with scheduleDate.", "properties": { "schedule": { "description": "Must be true to enable auto scheduling — the post is placed in the next open slot of the named schedule. Required when autoSchedule is set.", "type": "boolean" }, "title": { "description": "Name of a schedule previously created via the Set Auto Schedule endpoint. Case-sensitive; defaults to 'default' if omitted.", "type": "string" } }, "required": [ "schedule" ], "type": "object" }, "blueSkyOptions": { "description": "Bluesky-specific options (alt text for images/video). Only applied when 'bluesky' is in platforms.", "properties": { "altText": { "description": "Accessibility alt text for images or video. One entry per media item in mediaUrls order. Each string corresponds to the media at the same index. Used for screen readers and additional user info.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "disableComments": { "description": "Disable comments on the post. Only available for Instagram, LinkedIn, and TikTok. Default false.", "type": "boolean" }, "facebookOptions": { "description": "Facebook Page-specific options (Reels, Stories, carousel, captions, location, targeting, draft, scheduled publish, Reel collaborators). Collaborators are Facebook Reels-only, Page-ID based, capped at one in v1, and extras are dropped with a warning. Only applied when 'facebook' is in platforms.", "properties": { "altText": { "description": "Accessibility alt text for images/videos, one entry per mediaUrls item in order.", "items": { "type": "string" }, "type": "array" }, "carousel": { "description": "Post a Facebook carousel. Do not include mediaUrls when using carousel — they will be ignored.", "properties": { "items": { "description": "Carousel image items. Minimum 2, maximum 10 elements.", "items": { "properties": { "link": { "description": "URL opened when the carousel image is clicked. Required.", "format": "uri", "type": "string" }, "name": { "description": "Optional display name shown in the carousel card.", "type": "string" }, "picture": { "description": "URL of the carousel image. Required.", "format": "uri", "type": "string" } }, "required": [ "link", "picture" ], "type": "object" }, "maxItems": 10, "minItems": 2, "type": "array" }, "link": { "description": "URL of the 'See More' button at the end of the carousel. Required.", "format": "uri", "type": "string" } }, "required": [ "link", "items" ], "type": "object" }, "collaborators": { "description": "Facebook Reel collaborator Page IDs. Facebook collaborators are supported only on Facebook Reels. Ayrshare currently forwards one collaborator per Reel in v1; additional values are dropped with a warning.", "items": { "type": "string" }, "type": "array" }, "draft": { "description": "Save the post as a draft in Meta Business Suite instead of publishing. Available for text, images, video, and Reels.", "type": "boolean" }, "feedTargeting": { "description": "Soft feed targeting — users in these groups are more likely to see the post; others may still see it.", "properties": { "ageMax": { "description": "Maximum age for feed targeting. Integer 65 or lower.", "maximum": 65, "minimum": -9007199254740991, "type": "integer" }, "ageMin": { "description": "Minimum age for feed targeting. Integer 13 or higher. Default 0.", "maximum": 9007199254740991, "minimum": 13, "type": "integer" }, "collegeYears": { "description": "Target users by college graduation year. Array of integers.", "items": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "type": "array" }, "countries": { "description": "ISO 3166-1 alpha-2 country codes that should preferentially see the post in their feed.", "items": { "type": "string" }, "type": "array" }, "educationStatuses": { "description": "Target by education level: 1 = high school, 2 = undergraduate, 3 = alum.", "items": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "type": "array" }, "genders": { "description": "Target by gender: 1 = male, 2 = female. Default targets both.", "items": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "type": "array" }, "relationshipStatuses": { "description": "Target by relationship status: 1 = single, 2 = in a relationship, 3 = married, 4 = engaged. Default all.", "items": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "type": "array" } }, "type": "object" }, "link": { "description": "Specify a URL to use for the link preview, or force a link preview when none appears automatically. Ignored when mediaUrls is present.", "format": "uri", "type": "string" }, "locationId": { "description": "Facebook Page ID (number) or Page name starting with '@' to tag a physical location. Not supported on text posts, images, Reels, or Stories.", "type": [ "string", "number" ] }, "mediaCaptions": { "description": "Caption text for each media image, in the same order as mediaUrls. One string per media URL.", "items": { "type": "string" }, "type": "array" }, "reels": { "description": "Set to true to publish the video as a Facebook Reel. Meta enforces a rolling 30-Reels-per-24-hours limit per Page.", "type": "boolean" }, "scheduledPublishDate": { "description": "ISO 8601 UTC datetime to schedule the post in Meta Business Suite (e.g. '2023-09-28T21:44:06Z'). Must be 10+ minutes in the future and within 29 days.", "type": "string" }, "stories": { "description": "Publish a photo or video as a Facebook Story. Stories ignore post text and a video cannot exceed 60 seconds.", "type": "boolean" }, "targeting": { "description": "Hard-restrict post visibility to a demographic. Users outside these demographics cannot view the content.", "properties": { "ageMin": { "anyOf": [ { "const": 13, "type": "number" }, { "const": 15, "type": "number" }, { "const": 18, "type": "number" }, { "const": 21, "type": "number" }, { "const": 25, "type": "number" } ], "description": "Minimum age restriction. Accepted values: 13, 15, 18, 21, or 25 only." }, "countries": { "description": "ISO 3166-1 alpha-2 country codes to restrict post visibility to. Maximum 25 countries.", "items": { "type": "string" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "thumbNail": { "description": "URL of a JPEG or PNG thumbnail (cover image) for a video or Reel. Must be the same dimensions as the video and under 10 MB.", "format": "uri", "type": "string" }, "title": { "description": "Title for a video or Reel. Maximum 255 characters; longer values are truncated.", "maxLength": 255, "type": "string" } }, "type": "object" }, "firstComment": { "description": "Automatically add a first comment immediately after publishing. Object with { comment, mediaUrls }.", "properties": { "comment": { "description": "The text of the first comment to add automatically after the post is published. Required when firstComment is set.", "type": "string" }, "mediaUrls": { "description": "Optional media URLs to attach to the first comment. Supported on Facebook, LinkedIn, and X/Twitter only.", "items": { "format": "uri", "type": "string" }, "type": "array" } }, "required": [ "comment" ], "type": "object" }, "gmbOptions": { "description": "Google Business Profile-specific options (Standard/Event/Offer post types, Call-to-Action, media-only photo/video posts). Only applied when 'gmb' is in platforms.", "properties": { "callToAction": { "description": "Call-to-Action button for Standard ('What's New') posts and Event posts. Not supported on image/video (isPhotoVideo) posts or Offer posts.", "properties": { "actionType": { "description": "Action button type displayed on the post. 'call' does not require a url but the GBP account must have a phone number set. Other types require url.", "enum": [ "book", "order", "shop", "learn_more", "sign_up", "call" ], "type": "string" }, "url": { "description": "URL the user is directed to on click. Required for all actionType values except 'call'.", "format": "uri", "type": "string" } }, "required": [ "actionType" ], "type": "object" }, "category": { "description": "Photo/video category used when isPhotoVideo is true. Controls which tab the media appears under in the GBP 'Photos' section. Defaults to 'additional'. Some categories (e.g. food_and_drink) are not available for all business types.", "enum": [ "cover", "profile", "logo", "exterior", "interior", "product", "at_work", "food_and_drink", "menu", "common_area", "rooms", "teams", "additional" ], "type": "string" }, "event": { "description": "Promote a business event. Requires title, startDate, and endDate. Appears under 'Posts -\u003e Events' in the GBP console. Supports callToAction; videos are not supported.", "properties": { "endDate": { "description": "ISO 8601 end date-time string for the event, e.g. '2024-09-12T20:17:46.384Z'. Required.", "type": "string" }, "startDate": { "description": "ISO 8601 start date-time string for the event, e.g. '2024-08-12T20:17:46.384Z'. Required.", "type": "string" }, "title": { "description": "Title of the event. Required when event is set.", "type": "string" } }, "required": [ "title", "startDate", "endDate" ], "type": "object" }, "isPhotoVideo": { "description": "Set to true to publish a media-only post (image or video) to the 'Photos' section of GBP rather than creating a text/event/offer post. post text is required by the endpoint but ignored by GBP when this is true. callToAction is not supported with isPhotoVideo.", "type": "boolean" }, "offer": { "description": "Promotional offer post. A 'View offer' button is automatically added. Requires title, startDate, endDate, couponCode, redeemOnlineUrl, and termsConditions. Appears under 'Posts -\u003e Offers' in the GBP console. Videos are not supported. callToAction cannot be combined with offer.", "properties": { "couponCode": { "description": "Coupon code for the offer. Required; maximum 58 characters.", "maxLength": 58, "type": "string" }, "endDate": { "description": "ISO 8601 end date-time of the offer. Required.", "type": "string" }, "redeemOnlineUrl": { "description": "URL where the offer can be redeemed online. Required.", "format": "uri", "type": "string" }, "startDate": { "description": "ISO 8601 start date-time of the offer. Required.", "type": "string" }, "termsConditions": { "description": "Terms and conditions text for the offer. Required.", "type": "string" }, "title": { "description": "Title of the offer. Required when offer is set.", "type": "string" } }, "required": [ "title", "startDate", "endDate", "couponCode", "redeemOnlineUrl", "termsConditions" ], "type": "object" } }, "type": "object" }, "idempotencyKey": { "description": "Optional unique key that prevents duplicate posts. Reusing the same key and identical payload replays a settled result; a different payload or a request that is still processing is rejected.", "type": "string" }, "instagramOptions": { "description": "Instagram-specific options (Reels, Stories, alt text, user/location tags, trial reels, collaborators). Only applied when 'instagram' is in platforms.", "properties": { "altText": { "description": "Accessibility alt text, one entry per image in mediaUrls order, up to 1,000 chars each. Images only — not Reels or Stories.", "items": { "type": "string" }, "type": "array" }, "audioConfiguration": { "description": "Attach a licensed music track to a Reel. Reels only, and only for Instagram accounts linked via Facebook Login. When both audioConfiguration and audioName are set, audioConfiguration wins and audioName is ignored (with a non-fatal warning).", "properties": { "audioId": { "description": "Meta audio id (from the audio search/lookup endpoints) of the licensed track to attach. Required within audioConfiguration.", "type": "string" }, "audioVolume": { "description": "Volume of the attached audio track, integer 0 (muted) to 100 (full). Omit to use Meta's default (100).", "maximum": 100, "minimum": 0, "type": "integer" }, "videoVolume": { "description": "Volume of the original video's audio, integer 0 (muted) to 100 (full). Omit to use Meta's default (100).", "maximum": 100, "minimum": 0, "type": "integer" } }, "required": [ "audioId" ], "type": "object" }, "audioName": { "description": "Name of the Reel's audio track, e.g. 'The Weeknd - Blinding Lights'. Can only be set once.", "type": "string" }, "autoResize": { "description": "Automatically resize images to 1080x1080px for Instagram compatibility (Max Pack required). Applies to all platforms in the call — recommend a separate /post call for Instagram.", "type": "boolean" }, "collaborators": { "description": "Instagram usernames to invite as collaborators on the post (Reels, images, or carousels). Up to three. Stories do not support collaborators.", "items": { "type": "string" }, "type": "array" }, "isAIGenerated": { "description": "Label the post with Instagram's 'AI created' label to self-disclose AI-generated media. Applies to images, videos, Reels, and Stories; for carousels the label applies to the whole carousel, not individual items. Cannot be changed after posting. Default false.", "type": "boolean" }, "locationId": { "description": "Facebook Page ID (number) or Page name beginning with '@' to tag a physical location. The Page must have a location. Not supported on carousel media.", "type": [ "string", "number" ] }, "reels": { "description": "Publish a video as a Reel. Optional — videos default to Reels on Instagram.", "type": "boolean" }, "shareReelsFeed": { "description": "Hint that a Reel may appear in both the Feed and Reels tabs (true) or Reels tab only (false). Instagram's algorithm still decides actual placement.", "type": "boolean" }, "stories": { "description": "Publish a single image/video as a 24-hour Story. Stories ignore post text and cannot be carousels or trial reels.", "type": "boolean" }, "thumbNail": { "description": "URL of the Reel cover image. If both thumbNail and thumbNailOffset are sent, thumbNail wins.", "format": "uri", "type": "string" }, "thumbNailOffset": { "description": "Offset in milliseconds of the video frame used as the Reel thumbnail. Default 0 (first frame). Ignored if thumbNail is set.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "trialParams": { "description": "Publish a Reel as a trial (shown to non-followers first). Requires exactly one .mp4/.mov media URL and stories!=true.", "properties": { "graduationStrategy": { "description": "How a trial Reel graduates to followers. 'MANUAL' = graduate from the Instagram app; 'SS_PERFORMANCE' = Meta auto-graduates on early performance. Required when trialParams is set.", "enum": [ "MANUAL", "SS_PERFORMANCE" ], "type": "string" } }, "required": [ "graduationStrategy" ], "type": "object" }, "userTags": { "description": "Tag Instagram users. Single images or Reels only (not regular videos, carousels, or Stories).", "items": { "properties": { "username": { "description": "Public Instagram username to tag (no leading '@').", "type": "string" }, "x": { "description": "Required for images: horizontal tag position 0.0-1.0 from top-left. Omit for Reels.", "maximum": 1, "minimum": 0, "type": "number" }, "y": { "description": "Required for images: vertical tag position 0.0-1.0 from top-left. Omit for Reels.", "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "username" ], "type": "object" }, "type": "array" } }, "type": "object" }, "isLandscapeVideo": { "description": "For test publishing: with isVideo and randomMediaUrl both true, send a standard landscape-size random video. Default false.", "type": "boolean" }, "isPortraitVideo": { "description": "For test publishing: with isVideo and randomMediaUrl both true, send a portrait random video (required shape for TikTok or Facebook/Instagram Reels). Default false.", "type": "boolean" }, "isVideo": { "description": "Force the media to be treated as a video when the URL does not end in a known video extension (e.g. animated GIFs). Ayrshare otherwise infers the type from the file extension. Default false.", "type": "boolean" }, "linkedInOptions": { "description": "LinkedIn-specific options (alt text, reshare control, audience targeting, video thumbnail, document title, media captions, visibility). Only applied when 'linkedin' is in platforms.", "properties": { "altText": { "description": "Accessibility alt text for images (one entry per image in mediaUrls order). Not supported on videos or documents. See LinkedIn Alternative Text.", "items": { "type": "string" }, "type": "array" }, "disableShare": { "description": "Disable the ability for users to reshare the LinkedIn post. Default false.", "type": "boolean" }, "targeting": { "description": "Organic audience targeting by country, seniority, degree, industry, job function, or company size. Requires at least 300 followers in the targeted audience.", "properties": { "countries": { "description": "ISO 3166-1 alpha-2 country codes to target (e.g. ['US', 'DE']). Requires at least 300 followers in the targeted audience.", "items": { "type": "string" }, "type": "array" }, "degrees": { "description": "Degree names to target (e.g. ['Master of Digital Design']). See LinkedIn Degrees reference list.", "items": { "type": "string" }, "type": "array" }, "fieldsOfStudy": { "description": "Fields of study to target (e.g. ['Computer Games and Programming Skills']). See LinkedIn Fields of Study reference list.", "items": { "type": "string" }, "type": "array" }, "industries": { "description": "Industry names to target (e.g. ['Banking', 'Telecommunications Carriers']). See LinkedIn Industries reference list.", "items": { "type": "string" }, "type": "array" }, "jobFunctions": { "description": "Job function names to target (e.g. ['Information Technology', 'Entrepreneurship']). See LinkedIn Job Functions reference list.", "items": { "type": "string" }, "type": "array" }, "seniorities": { "description": "Seniority levels to target (e.g. ['Senior', 'VP']). See LinkedIn Seniorities reference list.", "items": { "type": "string" }, "type": "array" }, "staffCountRanges": { "description": "Company size ranges to target (e.g. ['size_51_to_200', 'size_5001_to_10000']). See LinkedIn Staff Count Ranges reference list.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "thumbNail": { "description": "Thumbnail image URL for video posts. Must be PNG or JPG, same dimensions as the video, under 10 MB. URL should end in .png or .jpg.", "format": "uri", "type": "string" }, "title": { "description": "Title of a document (PPT, PPTX, DOC, DOCX, or PDF) post. Maximum 400 characters. Defaults to filename if not specified.", "maxLength": 400, "type": "string" }, "titles": { "description": "Titles or captions for images or videos, one entry per mediaUrl in order. See LinkedIn Media Titles.", "items": { "type": "string" }, "type": "array" }, "visibility": { "description": "Post visibility. 'public' = all LinkedIn users (default); 'connections' = 1st-degree network only (personal accounts only); 'loggedin' = logged-in LinkedIn users only.", "enum": [ "public", "connections", "loggedin" ], "type": "string" } }, "type": "object" }, "mediaUrls": { "anyOf": [ { "format": "uri", "type": "string" }, { "items": { "format": "uri", "type": "string" }, "type": "array" }, { "additionalProperties": { "anyOf": [ { "format": "uri", "type": "string" }, { "items": { "format": "uri", "type": "string" }, "type": "array" } ] }, "propertyNames": { "type": "string" }, "type": "object" } ], "description": "Image or video URLs to include in the post. Send one URL, an array, or an object keyed by platform plus an optional `default` key for platform-specific media. URLs must be secure (https://). Encode special characters before sending. Videos require a paid plan." }, "notes": { "description": "Free-form notes attached to the post, retrievable via the /history endpoint. For reference only — does not affect the post.", "type": "string" }, "pinterestOptions": { "description": "Pinterest-specific options (alt text, AI disclosures, board selection, carousel metadata, clickable link, private note, video thumbnail, pin title). Only applied when 'pinterest' is in platforms.", "properties": { "aiDisclosures": { "description": "Pinterest AI disclosure values. Accepted values are AI_MODIFIED and SYNTHETIC_PERFORMER; valid values are sent to Pinterest as ai_disclosures.values.", "items": { "type": "string" }, "type": "array" }, "altText": { "description": "Accessibility alt text for the Pin's image or video. Maximum 500 characters. A Pin takes one alt text, so only the first item is used. See Pinterest Alternative Text.", "items": { "type": "string" }, "type": "array" }, "boardId": { "description": "ID of a Pinterest Board to post to (from /user/details endpoint). If not specified, posts to the default linked board.", "type": "string" }, "carouselOptions": { "description": "Per-image carousel metadata for up to 5 images. Each entry corresponds to the same-index URL in mediaUrls and may contain title, link, and description.", "items": { "properties": { "description": { "description": "Description for this carousel image.", "type": "string" }, "link": { "description": "External destination URL for this carousel image.", "format": "uri", "type": "string" }, "title": { "description": "Title for this carousel image.", "type": "string" } }, "type": "object" }, "type": "array" }, "link": { "description": "Destination URL users are directed to when clicking the pin image. Maximum 2048 characters. Creates a clickable link attached to the pin.", "format": "uri", "type": "string" }, "note": { "description": "Private note visible only to you and board collaborators. Maximum 1000 characters.", "maxLength": 1000, "type": "string" }, "thumbNail": { "description": "Thumbnail image URL for video pins. Must be PNG or JPG, same dimensions as video, under 10 MB. Required for video pins.", "format": "uri", "type": "string" }, "title": { "description": "Title of the pin shown in the 'Add your title' section. Maximum 100 characters.", "maxLength": 100, "type": "string" } }, "type": "object" }, "platforms": { "description": "Social networks to publish to. Use `facebook` for Facebook Pages, `gmb` for Google Business Profile, or `all` for every linked network. Include each platform's required fields (e.g. `youTubeOptions.title` when posting to youtube). Required.", "items": { "enum": [ "twitter", "facebook", "instagram", "linkedin", "tiktok", "youtube", "pinterest", "reddit", "telegram", "gmb", "bluesky", "snapchat", "threads", "all" ], "type": "string" }, "minItems": 1, "type": "array" }, "post": { "anyOf": [ { "type": "string" }, { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" } ], "description": "The post text sent to the social networks named in `platforms`. Send a string for shared text, or an object keyed by platform plus an optional `default` key for platform-specific text. An empty string is supported for media-only posts on compatible networks. Required." }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" }, "randomMediaUrl": { "description": "Generate a random media image for testing. When true, the `mediaUrls` field is ignored.", "type": "boolean" }, "randomPost": { "description": "Generate random post text for testing. When true, the `post` field is ignored.", "type": "boolean" }, "redditOptions": { "description": "Reddit-specific options (title, subreddit, link post, flair). title and subreddit are required for Reddit. Only applied when 'reddit' is in platforms.", "properties": { "flairId": { "description": "Unique ID of a flair defined by the subreddit's moderators. Use the /post/redditFlair endpoint to discover flair IDs for a subreddit.", "type": "string" }, "flairText": { "description": "Override text for the flair, if the subreddit's flair configuration allows custom text.", "type": "string" }, "link": { "description": "URL to post as a Reddit link post. When set, the post text is required but ignored — Reddit link posts cannot have a text body. Images posted via link resolve to the full image.", "format": "uri", "type": "string" }, "subreddit": { "description": "Subreddit to post to (no leading '/r/' needed, e.g. 'test'). Must allow automated posting. Required for all Reddit posts.", "type": "string" }, "title": { "description": "Title of the Reddit post. Required for all Reddit posts.", "type": "string" } }, "type": "object" }, "requiresApproval": { "description": "Hold the post in an 'awaiting approval' state until approved via the /post PATCH operation. Often used by agencies needing stakeholder sign-off before publishing.", "type": "boolean" }, "scheduleDate": { "description": "UTC datetime to schedule a future post, in YYYY-MM-DDThh:mm:ssZ format (e.g. '2026-07-08T12:30:00Z').", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "type": "string" }, "shortenLinks": { "description": "Shorten https links in the post for all platforms using Ayrshare's link shortener. Max Pack required. Default false.", "type": "boolean" }, "snapChatOptions": { "description": "Snapchat-specific options (Saved Stories, Spotlight, title). Only applied when 'snapchat' is in platforms.", "properties": { "savedStory": { "description": "Publish as a Saved Story — a permanent Story viewable on a Public Profile indefinitely (rather than the default ephemeral 24-hour Story).", "type": "boolean" }, "spotlight": { "description": "Publish as a Spotlight post — a permanent video Snap distributed on Snapchat's Spotlight entertainment platform for user-generated content. Must be a video.", "type": "boolean" }, "title": { "description": "Title for a Saved Story post. Truncated to 45 characters by Snapchat's API.", "type": "string" } }, "type": "object" }, "subreddit": { "description": "Subreddit to post to (no leading '/r/'), read as a top-level fallback for Reddit. Prefer setting it inside redditOptions.subreddit.", "type": "string" }, "threadsOptions": { "description": "Threads-specific options (geo restrictions, threadstorm, per-thread media). Only applied when 'threads' is in platforms.", "properties": { "allowCountries": { "description": "Restrict the post to specific countries using ISO 3166-1 alpha-2 country codes (e.g. [\"US\", \"CA\"]). Only available if Meta has enabled geo restrictions for your Threads account.", "items": { "type": "string" }, "type": "array" }, "mediaUrls": { "description": "Media to attach to thread posts when thread: true. One entry per thread position in order. Use null to skip a position, or an object with multiple URL values to attach multiple media to one post.", "items": { "anyOf": [ { "description": "URL of a single media item (image or video) for this thread position.", "format": "uri", "type": "string" }, { "description": "Null skips media for this thread position.", "type": "null" }, { "additionalProperties": { "format": "uri", "type": "string" }, "description": "Object mapping arbitrary unique keys to media URLs, to attach MULTIPLE media items to a single thread post (e.g. {\"1\": url, \"2\": url}).", "propertyNames": { "type": "string" }, "type": "object" } ] }, "type": "array" }, "thread": { "description": "Break the post into a connected thread series (threadstorm). Ayrshare automatically splits on line breaks or sentence boundaries when the post exceeds 500 characters. Default false.", "type": "boolean" }, "threadNumber": { "description": "Append sequential numbers in '1/n' format to each thread post (e.g. '2/5'). Requires thread: true. Default false.", "type": "boolean" } }, "type": "object" }, "tikTokOptions": { "description": "TikTok-specific options (comment/duet/stitch controls, branding labels, draft, AI-generated label, thumbnail, visibility). Only applied when 'tiktok' is in platforms.", "properties": { "autoAddMusic": { "description": "Automatically add recommended music to the post. Music can be changed later in the TikTok app. Media type: image only.", "type": "boolean" }, "disableComments": { "description": "Disable comments on the published post. Default false. Media type: video, image.", "type": "boolean" }, "disableDuet": { "description": "Disable duets on the published video. Default false. Media type: video only.", "type": "boolean" }, "disableStitch": { "description": "Disable stitch on the published video. Default false. Media type: video only.", "type": "boolean" }, "draft": { "description": "Create a draft post (saved to TikTok Inbox for editing before publishing). Default false. Media type: video or image.", "type": "boolean" }, "imageCoverIndex": { "description": "Zero-based index into mediaUrls to use as the cover photo for image posts. Default 0 (first image). Media type: image only.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "isAIGenerated": { "description": "Label the video as AI-generated content ('Creator labeled as AI-generated'). Cannot be changed after posting. Default false. Media type: video only.", "type": "boolean" }, "isBrandOrganic": { "description": "Enable the Brand Organic Content toggle, indicating promotion of yourself or your own business. Attaches a 'Promotional content' label. Default false. Media type: video, image.", "type": "boolean" }, "isBrandedContent": { "description": "Enable the Branded Content toggle, indicating a paid partnership with a brand. Attaches a 'Paid partnership' label. Default false. Media type: video, image.", "type": "boolean" }, "thumbNail": { "description": "URL of a cover image to use as the video thumbnail. Takes priority over thumbNailOffset when both are provided. Media type: video only.", "format": "uri", "type": "string" }, "thumbNailOffset": { "description": "Offset in milliseconds of the video frame to use as the thumbnail. Default 0 (first frame). Ignored if thumbNail is set. Media type: video only.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "title": { "description": "Title of the image post. Media type: image only.", "type": "string" }, "visibility": { "description": "Who can see the post. 'public' = all TikTok users; 'private' = account only; 'followers' = followers only; 'friends' = mutual followers only. Default 'public'. Private posts stay pending until made public.", "enum": [ "public", "private", "followers", "friends" ], "type": "string" } }, "type": "object" }, "title": { "description": "Post/video title used as a top-level fallback for platforms that require one (e.g. Reddit, Snapchat Saved Stories). Prefer setting it inside the platform options object (e.g. youTubeOptions.title, redditOptions.title).", "type": "string" }, "unsplash": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "description": "Attach an Unsplash image: 'random', a search-term string, or an array of image IDs." }, "validateScheduled": { "description": "Whether scheduled posts are pre-validated (media requirements, etc.) at submission so errors surface immediately. Default true; set false to skip pre-validation and only learn of errors at publish time.", "type": "boolean" }, "xOptions": { "description": "X (Twitter)-specific options (polls, threads, reply settings, geo restrictions, subtitles, long posts/videos). Only applied when 'twitter' is in platforms.", "properties": { "allowCountries": { "description": "ISO 3166-1 alpha-2 country codes whose users can see the media. Mutually exclusive with blockCountries.", "items": { "type": "string" }, "type": "array" }, "altText": { "description": "Accessibility alt text for images, one per mediaUrls entry in order. Maximum 1,000 characters each. Cannot be applied to videos.", "items": { "type": "string" }, "type": "array" }, "blockCountries": { "description": "ISO 3166-1 alpha-2 country codes whose users cannot see the media (post text still visible). Mutually exclusive with allowCountries.", "items": { "type": "string" }, "type": "array" }, "isAIGenerated": { "description": "Apply X's \"Made with AI\" label to disclose AI-generated media. Applies only to posts that include media. Cannot be changed after posting. Default false.", "type": "boolean" }, "longPost": { "description": "Enable long-form post up to 25,000 characters for X Premium users. Default false.", "type": "boolean" }, "longVideo": { "description": "Allow video uploads longer than 2 minutes 20 seconds for approved accounts. Default false.", "type": "boolean" }, "mediaUrls": { "description": "Media URLs for thread posts — one item per thread post in order. Pass null to skip media for a specific thread post.", "items": { "anyOf": [ { "format": "uri", "type": "string" }, { "type": "null" } ] }, "type": "array" }, "poll": { "description": "Attach a poll to the post. Requires duration (minutes) and options (2+ choices). Cannot be combined with media.", "properties": { "duration": { "description": "Poll duration in minutes. Required.", "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "options": { "description": "Poll answer choices. Minimum 2 options. Required.", "items": { "type": "string" }, "minItems": 2, "type": "array" } }, "required": [ "duration", "options" ], "type": "object" }, "quoteTweetId": { "description": "Tweet ID to quote-tweet. Embeds the referenced tweet below the post text.", "type": "string" }, "replySettings": { "description": "Who can reply to the post: 'following', 'mentioned', 'subscribers', or 'verified'.", "enum": [ "following", "mentioned", "subscribers", "verified" ], "type": "string" }, "subTitleLanguage": { "description": "BCP-47 language code for the subtitles (e.g. 'en'). Default: 'en'.", "type": "string" }, "subTitleName": { "description": "Display name of the caption track shown to viewers. Maximum 150 characters.", "maxLength": 150, "type": "string" }, "subTitleUrl": { "description": "URL of an SRT subtitle file to attach to the video. Must end in .srt.", "format": "uri", "type": "string" }, "subscribersOnly": { "description": "Restrict post visibility to X subscribers only. Default false.", "type": "boolean" }, "thread": { "description": "Split the post text into a connected thread series. Default false.", "type": "boolean" }, "threadNumber": { "description": "Append 'n/total' numbering to each thread post. Requires thread: true. Default false.", "type": "boolean" }, "thumbNail": { "description": "URL of a JPEG, PNG, BMP, or WebP image to use as the video thumbnail.", "format": "uri", "type": "string" } }, "type": "object" }, "youTubeOptions": { "description": "YouTube-specific options; `title` is required when posting to youtube. Covers visibility, thumbnail, tags, license, Shorts, scheduling, captions. Only applied when 'youtube' is in platforms.", "properties": { "categoryId": { "description": "YouTube video category ID (e.g. 24 = Entertainment). Must be a valid, assignable category ID.", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "containsSyntheticMedia": { "description": "Disclose that the video contains realistic AI-generated or altered/synthetic content (A/S). Required by YouTube for applicable content.", "type": "boolean" }, "embeddable": { "anyOf": [ { "type": "boolean" }, { "enum": [ "true", "false" ], "type": "string" } ], "description": "Whether the video can be embedded on third-party websites. Default true. Accepts boolean or the strings 'true'/'false'." }, "license": { "description": "Video license: 'youtube' (Standard YouTube License, default) or 'creativeCommon' (Creative Commons Attribution).", "enum": [ "youtube", "creativeCommon" ], "type": "string" }, "madeForKids": { "description": "Self-declare that the video is made for kids (COPPA). Default false.", "type": "boolean" }, "notifySubscribers": { "description": "Send a notification to subscribers when the video is published. Default true.", "type": "boolean" }, "playListId": { "description": "ID of a playlist to add the video to. The authenticated user must own the playlist.", "type": "string" }, "publicStatsViewable": { "anyOf": [ { "type": "boolean" }, { "enum": [ "true", "false" ], "type": "string" } ], "description": "Whether the extended stats panel on the watch page is publicly visible. Default true. Basic view/like counts stay public regardless." }, "publishAt": { "description": "ISO 8601 UTC datetime for YouTube-controlled publishing (e.g. '2022-10-08T21:18:36Z'). Video is kept private until this time. Do not combine with the top-level scheduleDate.", "type": "string" }, "shorts": { "description": "Indicate the video should be posted as a YouTube Short (max 3 minutes, 9:16 vertical). Adds #shorts to the description. YouTube still determines eligibility.", "type": "boolean" }, "subTitleLanguage": { "description": "BCP-47 language code for the subtitles (e.g. 'en'). Default: 'en'.", "type": "string" }, "subTitleName": { "description": "Display name of the caption track shown to viewers during playback. Default: 'English'. Maximum 150 characters.", "maxLength": 150, "type": "string" }, "subTitleUrl": { "description": "URL of an SRT or SBV subtitle file (must start with https:// and end in .srt or .sbv). Maximum 100 MB.", "format": "uri", "type": "string" }, "tags": { "description": "Keyword tags for the video. Each tag must be at least 2 characters; total length of all tags must be 500 characters or less.", "items": { "minLength": 2, "type": "string" }, "type": "array" }, "targeting": { "description": "Country-level geo-targeting for the video: block or allow specific countries.", "properties": { "allow": { "description": "ISO 3166-1 alpha-2 country codes that may view the video.", "items": { "type": "string" }, "type": "array" }, "block": { "description": "ISO 3166-1 alpha-2 country codes to block from viewing the video.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "thumbNail": { "description": "URL of a JPEG or PNG thumbnail under 2 MB. File extension must be .png, .jpg, or .jpeg. Requires YouTube phone verification. Not supported for Shorts.", "format": "uri", "type": "string" }, "title": { "description": "Video title. Required — maximum 100 characters. Cannot contain \u003c or \u003e.", "maxLength": 100, "type": "string" }, "visibility": { "description": "Privacy setting for the video: 'private' (default), 'unlisted', or 'public'.", "enum": [ "private", "unlisted", "public" ], "type": "string" } }, "required": [ "title" ], "type": "object" } }, "required": [ "post", "platforms" ], "type": "object" } }, { "name": "get_post", "description": "Retrieve a single post record by Ayrshare Post ID, returning per-platform postIds, status, payload, and timestamps. Notes: `id` is the top-level Ayrshare Post ID, not a platform-native ID; use get_post_history for filtered list lookups.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "id": { "description": "Ayrshare Post ID (from create_post or get_post_history). This is NOT a per-platform Social Post ID; use get_post_analytics_by_social_id for native platform IDs.", "minLength": 1, "type": "string" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" } }, "required": [ "id" ], "type": "object" } }, { "name": "update_post", "description": "Update a scheduled or awaiting-approval post's metadata (scheduleDate, approval, notes, disableComments, scheduledPause, or youTubeOptions). Notes: `id` plus at least one mutable field are required; other post fields cannot be changed — delete and repost instead.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "approved": { "description": "Set to true to approve and publish a post that is in 'awaiting approval' status via the approval workflow.", "type": "boolean" }, "disableComments": { "description": "Enable (false) or disable (true) comments on the post. Supported on Instagram and LinkedIn; LinkedIn disabling deletes existing comments.", "type": "boolean" }, "id": { "description": "Ayrshare Post ID of the post to update, returned from create_post.", "minLength": 1, "type": "string" }, "notes": { "description": "Reference notes to attach to the post, retrievable via get_post_history. Does not affect publishing.", "type": "string" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" }, "scheduleDate": { "description": "New UTC datetime for the scheduled post, e.g. '2026-07-08T12:30:00Z'. If in the past the post publishes immediately.", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "type": "string" }, "scheduledPause": { "description": "Pause (true) or unpause (false) a scheduled post. If unpaused and scheduleDate is in the past, the post publishes immediately.", "type": "boolean" }, "youTubeOptions": { "description": "YouTube-specific fields to update on an already-posted video: visibility, title, description, or categoryId.", "properties": { "categoryId": { "description": "YouTube video category ID (e.g. 24 = Entertainment). Must be a valid, assignable category ID.", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "containsSyntheticMedia": { "description": "Disclose that the video contains realistic AI-generated or altered/synthetic content (A/S). Required by YouTube for applicable content.", "type": "boolean" }, "description": { "description": "Video description to update on the already-posted video.", "type": "string" }, "embeddable": { "anyOf": [ { "type": "boolean" }, { "enum": [ "true", "false" ], "type": "string" } ], "description": "Whether the video can be embedded on third-party websites. Default true. Accepts boolean or the strings 'true'/'false'." }, "license": { "description": "Video license: 'youtube' (Standard YouTube License, default) or 'creativeCommon' (Creative Commons Attribution).", "enum": [ "youtube", "creativeCommon" ], "type": "string" }, "madeForKids": { "description": "Self-declare that the video is made for kids (COPPA). Default false.", "type": "boolean" }, "notifySubscribers": { "description": "Send a notification to subscribers when the video is published. Default true.", "type": "boolean" }, "playListId": { "description": "ID of a playlist to add the video to. The authenticated user must own the playlist.", "type": "string" }, "publicStatsViewable": { "anyOf": [ { "type": "boolean" }, { "enum": [ "true", "false" ], "type": "string" } ], "description": "Whether the extended stats panel on the watch page is publicly visible. Default true. Basic view/like counts stay public regardless." }, "publishAt": { "description": "ISO 8601 UTC datetime for YouTube-controlled publishing (e.g. '2022-10-08T21:18:36Z'). Video is kept private until this time. Do not combine with the top-level scheduleDate.", "type": "string" }, "shorts": { "description": "Indicate the video should be posted as a YouTube Short (max 3 minutes, 9:16 vertical). Adds #shorts to the description. YouTube still determines eligibility.", "type": "boolean" }, "subTitleLanguage": { "description": "BCP-47 language code for the subtitles (e.g. 'en'). Default: 'en'.", "type": "string" }, "subTitleName": { "description": "Display name of the caption track shown to viewers during playback. Default: 'English'. Maximum 150 characters.", "maxLength": 150, "type": "string" }, "subTitleUrl": { "description": "URL of an SRT or SBV subtitle file (must start with https:// and end in .srt or .sbv). Maximum 100 MB.", "format": "uri", "type": "string" }, "tags": { "description": "Keyword tags for the video. Each tag must be at least 2 characters; total length of all tags must be 500 characters or less.", "items": { "minLength": 2, "type": "string" }, "type": "array" }, "targeting": { "description": "Country-level geo-targeting for the video: block or allow specific countries.", "properties": { "allow": { "description": "ISO 3166-1 alpha-2 country codes that may view the video.", "items": { "type": "string" }, "type": "array" }, "block": { "description": "ISO 3166-1 alpha-2 country codes to block from viewing the video.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "thumbNail": { "description": "URL of a JPEG or PNG thumbnail under 2 MB. File extension must be .png, .jpg, or .jpeg. Requires YouTube phone verification. Not supported for Shorts.", "format": "uri", "type": "string" }, "title": { "description": "Video title to update — maximum 100 characters. Cannot contain \u003c or \u003e.", "maxLength": 100, "type": "string" }, "visibility": { "description": "Privacy setting for the video: 'private' (default), 'unlisted', or 'public'.", "enum": [ "private", "unlisted", "public" ], "type": "string" } }, "type": "object" } }, "required": [ "id" ], "type": "object" } }, { "name": "retry_post", "description": "Re-submit a previously failed post (status 'error') for publishing. Notes: a post may be retried only ONCE; only use when the error indicates a transient failure — verify the post was not already published before retrying.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "id": { "description": "Top-level Ayrshare Post ID of the failed post to retry. The post must currently have a status of 'error'.", "minLength": 1, "type": "string" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" } }, "required": [ "id" ], "type": "object" } }, { "name": "validate_post", "description": "Dry-run validation for a post before publishing — same input shape as create_post. Notes: surfaces silent-failure classes (Instagram aspect ratio, Twitter media size, TikTok timing, duplicate content); the dedup hash is reported but NEVER written, so a real create_post seconds later is not blocked.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "autoHashtag": { "anyOf": [ { "const": true, "type": "boolean" }, { "properties": { "max": { "description": "Number of hashtags to add. Integer in the range 1-10. Default 2.", "maximum": 10, "minimum": 1, "type": "integer" }, "position": { "description": "Where to add the hashtags: 'auto' inserts them within the post, 'end' appends them only at the end.", "enum": [ "auto", "end" ], "type": "string" } }, "type": "object" } ], "description": "Automatically add the most relevant hashtags. Object with { max, position } or Boolean true. A paid plan is required." }, "autoRepost": { "description": "Automatically repost the content multiple times at regular intervals (evergreen). Object with { repeat, days, startDate }. A paid plan is required.", "properties": { "days": { "description": "Number of days between each repost. Must be at least 2. Required.", "maximum": 9007199254740991, "minimum": 2, "type": "integer" }, "repeat": { "description": "Number of times to repost the content. Must be between 1 and 10. Required.", "maximum": 10, "minimum": 1, "type": "integer" }, "startDate": { "description": "ISO-8601 UTC datetime to start the repost schedule. If omitted, the first post publishes immediately. Use this in lieu of the top-level scheduleDate.", "type": "string" } }, "required": [ "repeat", "days" ], "type": "object" }, "autoSchedule": { "description": "Publish into a pre-defined auto-schedule's next open posting slot. Object with { schedule, title }. Cannot be combined with scheduleDate.", "properties": { "schedule": { "description": "Must be true to enable auto scheduling — the post is placed in the next open slot of the named schedule. Required when autoSchedule is set.", "type": "boolean" }, "title": { "description": "Name of a schedule previously created via the Set Auto Schedule endpoint. Case-sensitive; defaults to 'default' if omitted.", "type": "string" } }, "required": [ "schedule" ], "type": "object" }, "blueSkyOptions": { "description": "Bluesky-specific options (alt text for images/video). Only applied when 'bluesky' is in platforms.", "properties": { "altText": { "description": "Accessibility alt text for images or video. One entry per media item in mediaUrls order. Each string corresponds to the media at the same index. Used for screen readers and additional user info.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "disableComments": { "description": "Disable comments on the post. Only available for Instagram, LinkedIn, and TikTok. Default false.", "type": "boolean" }, "facebookOptions": { "description": "Facebook Page-specific options (Reels, Stories, carousel, captions, location, targeting, draft, scheduled publish, Reel collaborators). Collaborators are Facebook Reels-only, Page-ID based, capped at one in v1, and extras are dropped with a warning. Only applied when 'facebook' is in platforms.", "properties": { "altText": { "description": "Accessibility alt text for images/videos, one entry per mediaUrls item in order.", "items": { "type": "string" }, "type": "array" }, "carousel": { "description": "Post a Facebook carousel. Do not include mediaUrls when using carousel — they will be ignored.", "properties": { "items": { "description": "Carousel image items. Minimum 2, maximum 10 elements.", "items": { "properties": { "link": { "description": "URL opened when the carousel image is clicked. Required.", "format": "uri", "type": "string" }, "name": { "description": "Optional display name shown in the carousel card.", "type": "string" }, "picture": { "description": "URL of the carousel image. Required.", "format": "uri", "type": "string" } }, "required": [ "link", "picture" ], "type": "object" }, "maxItems": 10, "minItems": 2, "type": "array" }, "link": { "description": "URL of the 'See More' button at the end of the carousel. Required.", "format": "uri", "type": "string" } }, "required": [ "link", "items" ], "type": "object" }, "collaborators": { "description": "Facebook Reel collaborator Page IDs. Facebook collaborators are supported only on Facebook Reels. Ayrshare currently forwards one collaborator per Reel in v1; additional values are dropped with a warning.", "items": { "type": "string" }, "type": "array" }, "draft": { "description": "Save the post as a draft in Meta Business Suite instead of publishing. Available for text, images, video, and Reels.", "type": "boolean" }, "feedTargeting": { "description": "Soft feed targeting — users in these groups are more likely to see the post; others may still see it.", "properties": { "ageMax": { "description": "Maximum age for feed targeting. Integer 65 or lower.", "maximum": 65, "minimum": -9007199254740991, "type": "integer" }, "ageMin": { "description": "Minimum age for feed targeting. Integer 13 or higher. Default 0.", "maximum": 9007199254740991, "minimum": 13, "type": "integer" }, "collegeYears": { "description": "Target users by college graduation year. Array of integers.", "items": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "type": "array" }, "countries": { "description": "ISO 3166-1 alpha-2 country codes that should preferentially see the post in their feed.", "items": { "type": "string" }, "type": "array" }, "educationStatuses": { "description": "Target by education level: 1 = high school, 2 = undergraduate, 3 = alum.", "items": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "type": "array" }, "genders": { "description": "Target by gender: 1 = male, 2 = female. Default targets both.", "items": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "type": "array" }, "relationshipStatuses": { "description": "Target by relationship status: 1 = single, 2 = in a relationship, 3 = married, 4 = engaged. Default all.", "items": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "type": "array" } }, "type": "object" }, "link": { "description": "Specify a URL to use for the link preview, or force a link preview when none appears automatically. Ignored when mediaUrls is present.", "format": "uri", "type": "string" }, "locationId": { "description": "Facebook Page ID (number) or Page name starting with '@' to tag a physical location. Not supported on text posts, images, Reels, or Stories.", "type": [ "string", "number" ] }, "mediaCaptions": { "description": "Caption text for each media image, in the same order as mediaUrls. One string per media URL.", "items": { "type": "string" }, "type": "array" }, "reels": { "description": "Set to true to publish the video as a Facebook Reel. Meta enforces a rolling 30-Reels-per-24-hours limit per Page.", "type": "boolean" }, "scheduledPublishDate": { "description": "ISO 8601 UTC datetime to schedule the post in Meta Business Suite (e.g. '2023-09-28T21:44:06Z'). Must be 10+ minutes in the future and within 29 days.", "type": "string" }, "stories": { "description": "Publish a photo or video as a Facebook Story. Stories ignore post text and a video cannot exceed 60 seconds.", "type": "boolean" }, "targeting": { "description": "Hard-restrict post visibility to a demographic. Users outside these demographics cannot view the content.", "properties": { "ageMin": { "anyOf": [ { "const": 13, "type": "number" }, { "const": 15, "type": "number" }, { "const": 18, "type": "number" }, { "const": 21, "type": "number" }, { "const": 25, "type": "number" } ], "description": "Minimum age restriction. Accepted values: 13, 15, 18, 21, or 25 only." }, "countries": { "description": "ISO 3166-1 alpha-2 country codes to restrict post visibility to. Maximum 25 countries.", "items": { "type": "string" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "thumbNail": { "description": "URL of a JPEG or PNG thumbnail (cover image) for a video or Reel. Must be the same dimensions as the video and under 10 MB.", "format": "uri", "type": "string" }, "title": { "description": "Title for a video or Reel. Maximum 255 characters; longer values are truncated.", "maxLength": 255, "type": "string" } }, "type": "object" }, "firstComment": { "description": "Automatically add a first comment immediately after publishing. Object with { comment, mediaUrls }.", "properties": { "comment": { "description": "The text of the first comment to add automatically after the post is published. Required when firstComment is set.", "type": "string" }, "mediaUrls": { "description": "Optional media URLs to attach to the first comment. Supported on Facebook, LinkedIn, and X/Twitter only.", "items": { "format": "uri", "type": "string" }, "type": "array" } }, "required": [ "comment" ], "type": "object" }, "gmbOptions": { "description": "Google Business Profile-specific options (Standard/Event/Offer post types, Call-to-Action, media-only photo/video posts). Only applied when 'gmb' is in platforms.", "properties": { "callToAction": { "description": "Call-to-Action button for Standard ('What's New') posts and Event posts. Not supported on image/video (isPhotoVideo) posts or Offer posts.", "properties": { "actionType": { "description": "Action button type displayed on the post. 'call' does not require a url but the GBP account must have a phone number set. Other types require url.", "enum": [ "book", "order", "shop", "learn_more", "sign_up", "call" ], "type": "string" }, "url": { "description": "URL the user is directed to on click. Required for all actionType values except 'call'.", "format": "uri", "type": "string" } }, "required": [ "actionType" ], "type": "object" }, "category": { "description": "Photo/video category used when isPhotoVideo is true. Controls which tab the media appears under in the GBP 'Photos' section. Defaults to 'additional'. Some categories (e.g. food_and_drink) are not available for all business types.", "enum": [ "cover", "profile", "logo", "exterior", "interior", "product", "at_work", "food_and_drink", "menu", "common_area", "rooms", "teams", "additional" ], "type": "string" }, "event": { "description": "Promote a business event. Requires title, startDate, and endDate. Appears under 'Posts -\u003e Events' in the GBP console. Supports callToAction; videos are not supported.", "properties": { "endDate": { "description": "ISO 8601 end date-time string for the event, e.g. '2024-09-12T20:17:46.384Z'. Required.", "type": "string" }, "startDate": { "description": "ISO 8601 start date-time string for the event, e.g. '2024-08-12T20:17:46.384Z'. Required.", "type": "string" }, "title": { "description": "Title of the event. Required when event is set.", "type": "string" } }, "required": [ "title", "startDate", "endDate" ], "type": "object" }, "isPhotoVideo": { "description": "Set to true to publish a media-only post (image or video) to the 'Photos' section of GBP rather than creating a text/event/offer post. post text is required by the endpoint but ignored by GBP when this is true. callToAction is not supported with isPhotoVideo.", "type": "boolean" }, "offer": { "description": "Promotional offer post. A 'View offer' button is automatically added. Requires title, startDate, endDate, couponCode, redeemOnlineUrl, and termsConditions. Appears under 'Posts -\u003e Offers' in the GBP console. Videos are not supported. callToAction cannot be combined with offer.", "properties": { "couponCode": { "description": "Coupon code for the offer. Required; maximum 58 characters.", "maxLength": 58, "type": "string" }, "endDate": { "description": "ISO 8601 end date-time of the offer. Required.", "type": "string" }, "redeemOnlineUrl": { "description": "URL where the offer can be redeemed online. Required.", "format": "uri", "type": "string" }, "startDate": { "description": "ISO 8601 start date-time of the offer. Required.", "type": "string" }, "termsConditions": { "description": "Terms and conditions text for the offer. Required.", "type": "string" }, "title": { "description": "Title of the offer. Required when offer is set.", "type": "string" } }, "required": [ "title", "startDate", "endDate", "couponCode", "redeemOnlineUrl", "termsConditions" ], "type": "object" } }, "type": "object" }, "idempotencyKey": { "description": "Optional unique key that prevents duplicate posts. Reusing the same key and identical payload replays a settled result; a different payload or a request that is still processing is rejected.", "type": "string" }, "instagramOptions": { "description": "Instagram-specific options (Reels, Stories, alt text, user/location tags, trial reels, collaborators). Only applied when 'instagram' is in platforms.", "properties": { "altText": { "description": "Accessibility alt text, one entry per image in mediaUrls order, up to 1,000 chars each. Images only — not Reels or Stories.", "items": { "type": "string" }, "type": "array" }, "audioConfiguration": { "description": "Attach a licensed music track to a Reel. Reels only, and only for Instagram accounts linked via Facebook Login. When both audioConfiguration and audioName are set, audioConfiguration wins and audioName is ignored (with a non-fatal warning).", "properties": { "audioId": { "description": "Meta audio id (from the audio search/lookup endpoints) of the licensed track to attach. Required within audioConfiguration.", "type": "string" }, "audioVolume": { "description": "Volume of the attached audio track, integer 0 (muted) to 100 (full). Omit to use Meta's default (100).", "maximum": 100, "minimum": 0, "type": "integer" }, "videoVolume": { "description": "Volume of the original video's audio, integer 0 (muted) to 100 (full). Omit to use Meta's default (100).", "maximum": 100, "minimum": 0, "type": "integer" } }, "required": [ "audioId" ], "type": "object" }, "audioName": { "description": "Name of the Reel's audio track, e.g. 'The Weeknd - Blinding Lights'. Can only be set once.", "type": "string" }, "autoResize": { "description": "Automatically resize images to 1080x1080px for Instagram compatibility (Max Pack required). Applies to all platforms in the call — recommend a separate /post call for Instagram.", "type": "boolean" }, "collaborators": { "description": "Instagram usernames to invite as collaborators on the post (Reels, images, or carousels). Up to three. Stories do not support collaborators.", "items": { "type": "string" }, "type": "array" }, "isAIGenerated": { "description": "Label the post with Instagram's 'AI created' label to self-disclose AI-generated media. Applies to images, videos, Reels, and Stories; for carousels the label applies to the whole carousel, not individual items. Cannot be changed after posting. Default false.", "type": "boolean" }, "locationId": { "description": "Facebook Page ID (number) or Page name beginning with '@' to tag a physical location. The Page must have a location. Not supported on carousel media.", "type": [ "string", "number" ] }, "reels": { "description": "Publish a video as a Reel. Optional — videos default to Reels on Instagram.", "type": "boolean" }, "shareReelsFeed": { "description": "Hint that a Reel may appear in both the Feed and Reels tabs (true) or Reels tab only (false). Instagram's algorithm still decides actual placement.", "type": "boolean" }, "stories": { "description": "Publish a single image/video as a 24-hour Story. Stories ignore post text and cannot be carousels or trial reels.", "type": "boolean" }, "thumbNail": { "description": "URL of the Reel cover image. If both thumbNail and thumbNailOffset are sent, thumbNail wins.", "format": "uri", "type": "string" }, "thumbNailOffset": { "description": "Offset in milliseconds of the video frame used as the Reel thumbnail. Default 0 (first frame). Ignored if thumbNail is set.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "trialParams": { "description": "Publish a Reel as a trial (shown to non-followers first). Requires exactly one .mp4/.mov media URL and stories!=true.", "properties": { "graduationStrategy": { "description": "How a trial Reel graduates to followers. 'MANUAL' = graduate from the Instagram app; 'SS_PERFORMANCE' = Meta auto-graduates on early performance. Required when trialParams is set.", "enum": [ "MANUAL", "SS_PERFORMANCE" ], "type": "string" } }, "required": [ "graduationStrategy" ], "type": "object" }, "userTags": { "description": "Tag Instagram users. Single images or Reels only (not regular videos, carousels, or Stories).", "items": { "properties": { "username": { "description": "Public Instagram username to tag (no leading '@').", "type": "string" }, "x": { "description": "Required for images: horizontal tag position 0.0-1.0 from top-left. Omit for Reels.", "maximum": 1, "minimum": 0, "type": "number" }, "y": { "description": "Required for images: vertical tag position 0.0-1.0 from top-left. Omit for Reels.", "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "username" ], "type": "object" }, "type": "array" } }, "type": "object" }, "isLandscapeVideo": { "description": "For test publishing: with isVideo and randomMediaUrl both true, send a standard landscape-size random video. Default false.", "type": "boolean" }, "isPortraitVideo": { "description": "For test publishing: with isVideo and randomMediaUrl both true, send a portrait random video (required shape for TikTok or Facebook/Instagram Reels). Default false.", "type": "boolean" }, "isVideo": { "description": "Force the media to be treated as a video when the URL does not end in a known video extension (e.g. animated GIFs). Ayrshare otherwise infers the type from the file extension. Default false.", "type": "boolean" }, "linkedInOptions": { "description": "LinkedIn-specific options (alt text, reshare control, audience targeting, video thumbnail, document title, media captions, visibility). Only applied when 'linkedin' is in platforms.", "properties": { "altText": { "description": "Accessibility alt text for images (one entry per image in mediaUrls order). Not supported on videos or documents. See LinkedIn Alternative Text.", "items": { "type": "string" }, "type": "array" }, "disableShare": { "description": "Disable the ability for users to reshare the LinkedIn post. Default false.", "type": "boolean" }, "targeting": { "description": "Organic audience targeting by country, seniority, degree, industry, job function, or company size. Requires at least 300 followers in the targeted audience.", "properties": { "countries": { "description": "ISO 3166-1 alpha-2 country codes to target (e.g. ['US', 'DE']). Requires at least 300 followers in the targeted audience.", "items": { "type": "string" }, "type": "array" }, "degrees": { "description": "Degree names to target (e.g. ['Master of Digital Design']). See LinkedIn Degrees reference list.", "items": { "type": "string" }, "type": "array" }, "fieldsOfStudy": { "description": "Fields of study to target (e.g. ['Computer Games and Programming Skills']). See LinkedIn Fields of Study reference list.", "items": { "type": "string" }, "type": "array" }, "industries": { "description": "Industry names to target (e.g. ['Banking', 'Telecommunications Carriers']). See LinkedIn Industries reference list.", "items": { "type": "string" }, "type": "array" }, "jobFunctions": { "description": "Job function names to target (e.g. ['Information Technology', 'Entrepreneurship']). See LinkedIn Job Functions reference list.", "items": { "type": "string" }, "type": "array" }, "seniorities": { "description": "Seniority levels to target (e.g. ['Senior', 'VP']). See LinkedIn Seniorities reference list.", "items": { "type": "string" }, "type": "array" }, "staffCountRanges": { "description": "Company size ranges to target (e.g. ['size_51_to_200', 'size_5001_to_10000']). See LinkedIn Staff Count Ranges reference list.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "thumbNail": { "description": "Thumbnail image URL for video posts. Must be PNG or JPG, same dimensions as the video, under 10 MB. URL should end in .png or .jpg.", "format": "uri", "type": "string" }, "title": { "description": "Title of a document (PPT, PPTX, DOC, DOCX, or PDF) post. Maximum 400 characters. Defaults to filename if not specified.", "maxLength": 400, "type": "string" }, "titles": { "description": "Titles or captions for images or videos, one entry per mediaUrl in order. See LinkedIn Media Titles.", "items": { "type": "string" }, "type": "array" }, "visibility": { "description": "Post visibility. 'public' = all LinkedIn users (default); 'connections' = 1st-degree network only (personal accounts only); 'loggedin' = logged-in LinkedIn users only.", "enum": [ "public", "connections", "loggedin" ], "type": "string" } }, "type": "object" }, "mediaUrls": { "anyOf": [ { "format": "uri", "type": "string" }, { "items": { "format": "uri", "type": "string" }, "type": "array" }, { "additionalProperties": { "anyOf": [ { "format": "uri", "type": "string" }, { "items": { "format": "uri", "type": "string" }, "type": "array" } ] }, "propertyNames": { "type": "string" }, "type": "object" } ], "description": "Image or video URLs to include in the post. Send one URL, an array, or an object keyed by platform plus an optional `default` key for platform-specific media. URLs must be secure (https://). Encode special characters before sending. Videos require a paid plan." }, "notes": { "description": "Free-form notes attached to the post, retrievable via the /history endpoint. For reference only — does not affect the post.", "type": "string" }, "pinterestOptions": { "description": "Pinterest-specific options (alt text, AI disclosures, board selection, carousel metadata, clickable link, private note, video thumbnail, pin title). Only applied when 'pinterest' is in platforms.", "properties": { "aiDisclosures": { "description": "Pinterest AI disclosure values. Accepted values are AI_MODIFIED and SYNTHETIC_PERFORMER; valid values are sent to Pinterest as ai_disclosures.values.", "items": { "type": "string" }, "type": "array" }, "altText": { "description": "Accessibility alt text for the Pin's image or video. Maximum 500 characters. A Pin takes one alt text, so only the first item is used. See Pinterest Alternative Text.", "items": { "type": "string" }, "type": "array" }, "boardId": { "description": "ID of a Pinterest Board to post to (from /user/details endpoint). If not specified, posts to the default linked board.", "type": "string" }, "carouselOptions": { "description": "Per-image carousel metadata for up to 5 images. Each entry corresponds to the same-index URL in mediaUrls and may contain title, link, and description.", "items": { "properties": { "description": { "description": "Description for this carousel image.", "type": "string" }, "link": { "description": "External destination URL for this carousel image.", "format": "uri", "type": "string" }, "title": { "description": "Title for this carousel image.", "type": "string" } }, "type": "object" }, "type": "array" }, "link": { "description": "Destination URL users are directed to when clicking the pin image. Maximum 2048 characters. Creates a clickable link attached to the pin.", "format": "uri", "type": "string" }, "note": { "description": "Private note visible only to you and board collaborators. Maximum 1000 characters.", "maxLength": 1000, "type": "string" }, "thumbNail": { "description": "Thumbnail image URL for video pins. Must be PNG or JPG, same dimensions as video, under 10 MB. Required for video pins.", "format": "uri", "type": "string" }, "title": { "description": "Title of the pin shown in the 'Add your title' section. Maximum 100 characters.", "maxLength": 100, "type": "string" } }, "type": "object" }, "platforms": { "description": "Social networks to publish to. Use `facebook` for Facebook Pages, `gmb` for Google Business Profile, or `all` for every linked network. Include each platform's required fields (e.g. `youTubeOptions.title` when posting to youtube). Required.", "items": { "enum": [ "twitter", "facebook", "instagram", "linkedin", "tiktok", "youtube", "pinterest", "reddit", "telegram", "gmb", "bluesky", "snapchat", "threads", "all" ], "type": "string" }, "minItems": 1, "type": "array" }, "post": { "anyOf": [ { "type": "string" }, { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" } ], "description": "The post text sent to the social networks named in `platforms`. Send a string for shared text, or an object keyed by platform plus an optional `default` key for platform-specific text. An empty string is supported for media-only posts on compatible networks. Required." }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" }, "randomMediaUrl": { "description": "Generate a random media image for testing. When true, the `mediaUrls` field is ignored.", "type": "boolean" }, "randomPost": { "description": "Generate random post text for testing. When true, the `post` field is ignored.", "type": "boolean" }, "redditOptions": { "description": "Reddit-specific options (title, subreddit, link post, flair). title and subreddit are required for Reddit. Only applied when 'reddit' is in platforms.", "properties": { "flairId": { "description": "Unique ID of a flair defined by the subreddit's moderators. Use the /post/redditFlair endpoint to discover flair IDs for a subreddit.", "type": "string" }, "flairText": { "description": "Override text for the flair, if the subreddit's flair configuration allows custom text.", "type": "string" }, "link": { "description": "URL to post as a Reddit link post. When set, the post text is required but ignored — Reddit link posts cannot have a text body. Images posted via link resolve to the full image.", "format": "uri", "type": "string" }, "subreddit": { "description": "Subreddit to post to (no leading '/r/' needed, e.g. 'test'). Must allow automated posting. Required for all Reddit posts.", "type": "string" }, "title": { "description": "Title of the Reddit post. Required for all Reddit posts.", "type": "string" } }, "type": "object" }, "requiresApproval": { "description": "Hold the post in an 'awaiting approval' state until approved via the /post PATCH operation. Often used by agencies needing stakeholder sign-off before publishing.", "type": "boolean" }, "scheduleDate": { "description": "UTC datetime to schedule a future post, in YYYY-MM-DDThh:mm:ssZ format (e.g. '2026-07-08T12:30:00Z').", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "type": "string" }, "shortenLinks": { "description": "Shorten https links in the post for all platforms using Ayrshare's link shortener. Max Pack required. Default false.", "type": "boolean" }, "snapChatOptions": { "description": "Snapchat-specific options (Saved Stories, Spotlight, title). Only applied when 'snapchat' is in platforms.", "properties": { "savedStory": { "description": "Publish as a Saved Story — a permanent Story viewable on a Public Profile indefinitely (rather than the default ephemeral 24-hour Story).", "type": "boolean" }, "spotlight": { "description": "Publish as a Spotlight post — a permanent video Snap distributed on Snapchat's Spotlight entertainment platform for user-generated content. Must be a video.", "type": "boolean" }, "title": { "description": "Title for a Saved Story post. Truncated to 45 characters by Snapchat's API.", "type": "string" } }, "type": "object" }, "subreddit": { "description": "Subreddit to post to (no leading '/r/'), read as a top-level fallback for Reddit. Prefer setting it inside redditOptions.subreddit.", "type": "string" }, "threadsOptions": { "description": "Threads-specific options (geo restrictions, threadstorm, per-thread media). Only applied when 'threads' is in platforms.", "properties": { "allowCountries": { "description": "Restrict the post to specific countries using ISO 3166-1 alpha-2 country codes (e.g. [\"US\", \"CA\"]). Only available if Meta has enabled geo restrictions for your Threads account.", "items": { "type": "string" }, "type": "array" }, "mediaUrls": { "description": "Media to attach to thread posts when thread: true. One entry per thread position in order. Use null to skip a position, or an object with multiple URL values to attach multiple media to one post.", "items": { "anyOf": [ { "description": "URL of a single media item (image or video) for this thread position.", "format": "uri", "type": "string" }, { "description": "Null skips media for this thread position.", "type": "null" }, { "additionalProperties": { "format": "uri", "type": "string" }, "description": "Object mapping arbitrary unique keys to media URLs, to attach MULTIPLE media items to a single thread post (e.g. {\"1\": url, \"2\": url}).", "propertyNames": { "type": "string" }, "type": "object" } ] }, "type": "array" }, "thread": { "description": "Break the post into a connected thread series (threadstorm). Ayrshare automatically splits on line breaks or sentence boundaries when the post exceeds 500 characters. Default false.", "type": "boolean" }, "threadNumber": { "description": "Append sequential numbers in '1/n' format to each thread post (e.g. '2/5'). Requires thread: true. Default false.", "type": "boolean" } }, "type": "object" }, "tikTokOptions": { "description": "TikTok-specific options (comment/duet/stitch controls, branding labels, draft, AI-generated label, thumbnail, visibility). Only applied when 'tiktok' is in platforms.", "properties": { "autoAddMusic": { "description": "Automatically add recommended music to the post. Music can be changed later in the TikTok app. Media type: image only.", "type": "boolean" }, "disableComments": { "description": "Disable comments on the published post. Default false. Media type: video, image.", "type": "boolean" }, "disableDuet": { "description": "Disable duets on the published video. Default false. Media type: video only.", "type": "boolean" }, "disableStitch": { "description": "Disable stitch on the published video. Default false. Media type: video only.", "type": "boolean" }, "draft": { "description": "Create a draft post (saved to TikTok Inbox for editing before publishing). Default false. Media type: video or image.", "type": "boolean" }, "imageCoverIndex": { "description": "Zero-based index into mediaUrls to use as the cover photo for image posts. Default 0 (first image). Media type: image only.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "isAIGenerated": { "description": "Label the video as AI-generated content ('Creator labeled as AI-generated'). Cannot be changed after posting. Default false. Media type: video only.", "type": "boolean" }, "isBrandOrganic": { "description": "Enable the Brand Organic Content toggle, indicating promotion of yourself or your own business. Attaches a 'Promotional content' label. Default false. Media type: video, image.", "type": "boolean" }, "isBrandedContent": { "description": "Enable the Branded Content toggle, indicating a paid partnership with a brand. Attaches a 'Paid partnership' label. Default false. Media type: video, image.", "type": "boolean" }, "thumbNail": { "description": "URL of a cover image to use as the video thumbnail. Takes priority over thumbNailOffset when both are provided. Media type: video only.", "format": "uri", "type": "string" }, "thumbNailOffset": { "description": "Offset in milliseconds of the video frame to use as the thumbnail. Default 0 (first frame). Ignored if thumbNail is set. Media type: video only.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "title": { "description": "Title of the image post. Media type: image only.", "type": "string" }, "visibility": { "description": "Who can see the post. 'public' = all TikTok users; 'private' = account only; 'followers' = followers only; 'friends' = mutual followers only. Default 'public'. Private posts stay pending until made public.", "enum": [ "public", "private", "followers", "friends" ], "type": "string" } }, "type": "object" }, "title": { "description": "Post/video title used as a top-level fallback for platforms that require one (e.g. Reddit, Snapchat Saved Stories). Prefer setting it inside the platform options object (e.g. youTubeOptions.title, redditOptions.title).", "type": "string" }, "unsplash": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "description": "Attach an Unsplash image: 'random', a search-term string, or an array of image IDs." }, "validateScheduled": { "description": "Whether scheduled posts are pre-validated (media requirements, etc.) at submission so errors surface immediately. Default true; set false to skip pre-validation and only learn of errors at publish time.", "type": "boolean" }, "xOptions": { "description": "X (Twitter)-specific options (polls, threads, reply settings, geo restrictions, subtitles, long posts/videos). Only applied when 'twitter' is in platforms.", "properties": { "allowCountries": { "description": "ISO 3166-1 alpha-2 country codes whose users can see the media. Mutually exclusive with blockCountries.", "items": { "type": "string" }, "type": "array" }, "altText": { "description": "Accessibility alt text for images, one per mediaUrls entry in order. Maximum 1,000 characters each. Cannot be applied to videos.", "items": { "type": "string" }, "type": "array" }, "blockCountries": { "description": "ISO 3166-1 alpha-2 country codes whose users cannot see the media (post text still visible). Mutually exclusive with allowCountries.", "items": { "type": "string" }, "type": "array" }, "isAIGenerated": { "description": "Apply X's \"Made with AI\" label to disclose AI-generated media. Applies only to posts that include media. Cannot be changed after posting. Default false.", "type": "boolean" }, "longPost": { "description": "Enable long-form post up to 25,000 characters for X Premium users. Default false.", "type": "boolean" }, "longVideo": { "description": "Allow video uploads longer than 2 minutes 20 seconds for approved accounts. Default false.", "type": "boolean" }, "mediaUrls": { "description": "Media URLs for thread posts — one item per thread post in order. Pass null to skip media for a specific thread post.", "items": { "anyOf": [ { "format": "uri", "type": "string" }, { "type": "null" } ] }, "type": "array" }, "poll": { "description": "Attach a poll to the post. Requires duration (minutes) and options (2+ choices). Cannot be combined with media.", "properties": { "duration": { "description": "Poll duration in minutes. Required.", "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "options": { "description": "Poll answer choices. Minimum 2 options. Required.", "items": { "type": "string" }, "minItems": 2, "type": "array" } }, "required": [ "duration", "options" ], "type": "object" }, "quoteTweetId": { "description": "Tweet ID to quote-tweet. Embeds the referenced tweet below the post text.", "type": "string" }, "replySettings": { "description": "Who can reply to the post: 'following', 'mentioned', 'subscribers', or 'verified'.", "enum": [ "following", "mentioned", "subscribers", "verified" ], "type": "string" }, "subTitleLanguage": { "description": "BCP-47 language code for the subtitles (e.g. 'en'). Default: 'en'.", "type": "string" }, "subTitleName": { "description": "Display name of the caption track shown to viewers. Maximum 150 characters.", "maxLength": 150, "type": "string" }, "subTitleUrl": { "description": "URL of an SRT subtitle file to attach to the video. Must end in .srt.", "format": "uri", "type": "string" }, "subscribersOnly": { "description": "Restrict post visibility to X subscribers only. Default false.", "type": "boolean" }, "thread": { "description": "Split the post text into a connected thread series. Default false.", "type": "boolean" }, "threadNumber": { "description": "Append 'n/total' numbering to each thread post. Requires thread: true. Default false.", "type": "boolean" }, "thumbNail": { "description": "URL of a JPEG, PNG, BMP, or WebP image to use as the video thumbnail.", "format": "uri", "type": "string" } }, "type": "object" }, "youTubeOptions": { "description": "YouTube-specific options; `title` is required when posting to youtube. Covers visibility, thumbnail, tags, license, Shorts, scheduling, captions. Only applied when 'youtube' is in platforms.", "properties": { "categoryId": { "description": "YouTube video category ID (e.g. 24 = Entertainment). Must be a valid, assignable category ID.", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "containsSyntheticMedia": { "description": "Disclose that the video contains realistic AI-generated or altered/synthetic content (A/S). Required by YouTube for applicable content.", "type": "boolean" }, "embeddable": { "anyOf": [ { "type": "boolean" }, { "enum": [ "true", "false" ], "type": "string" } ], "description": "Whether the video can be embedded on third-party websites. Default true. Accepts boolean or the strings 'true'/'false'." }, "license": { "description": "Video license: 'youtube' (Standard YouTube License, default) or 'creativeCommon' (Creative Commons Attribution).", "enum": [ "youtube", "creativeCommon" ], "type": "string" }, "madeForKids": { "description": "Self-declare that the video is made for kids (COPPA). Default false.", "type": "boolean" }, "notifySubscribers": { "description": "Send a notification to subscribers when the video is published. Default true.", "type": "boolean" }, "playListId": { "description": "ID of a playlist to add the video to. The authenticated user must own the playlist.", "type": "string" }, "publicStatsViewable": { "anyOf": [ { "type": "boolean" }, { "enum": [ "true", "false" ], "type": "string" } ], "description": "Whether the extended stats panel on the watch page is publicly visible. Default true. Basic view/like counts stay public regardless." }, "publishAt": { "description": "ISO 8601 UTC datetime for YouTube-controlled publishing (e.g. '2022-10-08T21:18:36Z'). Video is kept private until this time. Do not combine with the top-level scheduleDate.", "type": "string" }, "shorts": { "description": "Indicate the video should be posted as a YouTube Short (max 3 minutes, 9:16 vertical). Adds #shorts to the description. YouTube still determines eligibility.", "type": "boolean" }, "subTitleLanguage": { "description": "BCP-47 language code for the subtitles (e.g. 'en'). Default: 'en'.", "type": "string" }, "subTitleName": { "description": "Display name of the caption track shown to viewers during playback. Default: 'English'. Maximum 150 characters.", "maxLength": 150, "type": "string" }, "subTitleUrl": { "description": "URL of an SRT or SBV subtitle file (must start with https:// and end in .srt or .sbv). Maximum 100 MB.", "format": "uri", "type": "string" }, "tags": { "description": "Keyword tags for the video. Each tag must be at least 2 characters; total length of all tags must be 500 characters or less.", "items": { "minLength": 2, "type": "string" }, "type": "array" }, "targeting": { "description": "Country-level geo-targeting for the video: block or allow specific countries.", "properties": { "allow": { "description": "ISO 3166-1 alpha-2 country codes that may view the video.", "items": { "type": "string" }, "type": "array" }, "block": { "description": "ISO 3166-1 alpha-2 country codes to block from viewing the video.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "thumbNail": { "description": "URL of a JPEG or PNG thumbnail under 2 MB. File extension must be .png, .jpg, or .jpeg. Requires YouTube phone verification. Not supported for Shorts.", "format": "uri", "type": "string" }, "title": { "description": "Video title. Required — maximum 100 characters. Cannot contain \u003c or \u003e.", "maxLength": 100, "type": "string" }, "visibility": { "description": "Privacy setting for the video: 'private' (default), 'unlisted', or 'public'.", "enum": [ "private", "unlisted", "public" ], "type": "string" } }, "required": [ "title" ], "type": "object" } }, "required": [ "post", "platforms" ], "type": "object" } }, { "name": "validate_media", "description": "Verify a media URL is reachable and return its contentType. Use this before create_post whenever a post includes media to catch inaccessible URLs early. Notes: The check is a HEAD request — providers that block HEAD (e.g. some Cloudflare configurations) will return an error even for valid files. Pair with validate_post for a full pre-publish sweep.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "mediaUrl": { "description": "URL of the media file to verify. A HEAD request is made; ensure the hosting provider does not block HEAD requests (some CDNs like Cloudflare may).", "format": "uri", "type": "string" } }, "required": [ "mediaUrl" ], "type": "object" } }, { "name": "get_post_history", "description": "List posts sent via Ayrshare (most recent first). All parameters are optional query filters. Notes: use 'gmb' not 'googlebusiness'; deleted posts only returned when status='deleted'; lastDays ignored when startDate+endDate provided; results cached 1 min when limit\u003e25. For posts that originated OUTSIDE Ayrshare, use get_platform_history instead. Requires a valid API key (same authentication as every other tool).", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "autoRepostId": { "description": "Filter by auto-repost series ID assigned when creating an auto repost. Pass 'all' to retrieve all auto-repost series.", "type": "string" }, "endDate": { "description": "Return posts up to and including this date. ISO 8601 format, e.g. '2026-07-08T12:30:00Z'. Use with startDate for a date range.", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "type": "string" }, "lastDays": { "description": "Return posts from the last N days by publish date (default 30). Set to 0 to return all posts (no date filter). Ignored when startDate and endDate are both provided.", "maximum": 36500, "minimum": 0, "type": "integer" }, "limit": { "description": "Number of posts to return (default 25, max 1000). Set to 1 to retrieve the most recent post only.", "maximum": 1000, "minimum": 1, "type": "integer" }, "platforms": { "description": "Filter by social network platforms using OR logic (e.g. ['facebook','instagram'] returns posts from either). Uses the same identifiers as create_post — use 'gmb', not 'googlebusiness'.", "items": { "enum": [ "twitter", "facebook", "instagram", "linkedin", "tiktok", "youtube", "pinterest", "reddit", "telegram", "gmb", "bluesky", "snapchat", "threads" ], "type": "string" }, "minItems": 1, "type": "array" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" }, "startDate": { "description": "Return posts from and including this date. ISO 8601 format, e.g. '2026-07-08T12:30:00Z'. Ignored when startDate+endDate are both absent.", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "type": "string" }, "status": { "description": "Filter by post status. 'deleted' posts are only returned when this filter is explicitly set to 'deleted'. 'processing' means the post is currently being sent.", "enum": [ "awaiting approval", "deleted", "error", "paused", "pending", "processing", "success" ], "type": "string" }, "type": { "description": "Filter by post type: 'immediate' for posts sent right away, 'scheduled' for posts using the scheduleDate field.", "enum": [ "immediate", "scheduled" ], "type": "string" } }, "type": "object" } }, { "name": "get_platform_history", "description": "Fetch posts and analytics DIRECTLY from a social network, including posts NOT created through Ayrshare. Returns native Social Post IDs (not Ayrshare Post IDs) — use these with get_comments or get_post_analytics_by_social_id. Notes: platform is required; userId/userName (X/Twitter) require API key only, no Profile-Key; skipAnalytics speeds up high-limit requests; use get_post_history for Ayrshare-originated posts. Requires a valid API key (same authentication as every other tool).", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "dataType": { "description": "Facebook and Instagram only. Filter content type: 'posts' for regular posts only, 'stories' for Stories only. Omit to return both posts and active Stories.", "enum": [ "posts", "stories" ], "type": "string" }, "limit": { "description": "Number of history records to return (default 10, max 500). Keep at or below 100 for best performance; higher limits may result in slower responses.", "maximum": 500, "minimum": 1, "type": "integer" }, "next": { "description": "Opaque cursor for pagination. Pass the value from meta.pagination.next in a prior response to fetch the next page of results.", "type": "string" }, "pagePublished": { "description": "Facebook only. When true, returns only posts published by the Page itself. Default (false) returns the full page feed, including interactions from other users.", "type": "boolean" }, "platform": { "description": "The social network to retrieve posts from. Values: bluesky, facebook, instagram, linkedin, pinterest, snapchat, threads, tiktok, twitter, youtube. Note: telegram and gmb are not supported by this endpoint.", "enum": [ "bluesky", "facebook", "instagram", "linkedin", "pinterest", "snapchat", "threads", "tiktok", "twitter", "youtube" ], "type": "string" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" }, "since": { "description": "Facebook only. ISO date string to filter posts created on or after this date (e.g. '2026-03-17'). Use with until for a date range.", "type": "string" }, "skipAnalytics": { "description": "When true, returns only the Social Post ID without fetching full analytics (faster, avoids errors when limit \u003e 100). Use when you only need the ID, not engagement metrics.", "type": "boolean" }, "until": { "description": "Facebook only. ISO date string to filter posts created on or before this date (e.g. '2026-03-20'). Use with since for a date range.", "type": "string" }, "userId": { "description": "X/Twitter only. Retrieve posts from a specific user by their numeric Twitter ID (e.g. '20536157' for @Google) instead of your linked account. Use only the API key — do not include a Profile-Key.", "type": "string" }, "userName": { "description": "X/Twitter only. Retrieve posts from a specific user by their handle (e.g. 'Google') instead of your linked account. Use only the API key — do not include a Profile-Key.", "type": "string" } }, "required": [ "platform" ], "type": "object" } }, { "name": "get_post_analytics", "description": "Get real-time analytics (likes, impressions, views, reactions) for a post sent via Ayrshare. Notes: id is the Ayrshare Post ID (not the native social post ID); YouTube/TikTok need 24-48 h to populate; Pinterest impressions take 24-72 h. For posts NOT created through Ayrshare, use get_post_analytics_by_social_id. Requires a valid API key (same authentication as every other tool).", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "id": { "description": "Top-level Ayrshare Post ID returned by create_post. This is the root id field, NOT the per-platform social post IDs in postIds.", "minLength": 1, "type": "string" }, "platforms": { "description": "Optional subset of platforms to retrieve analytics for. When omitted, analytics are returned for all platforms the post was sent to.", "items": { "enum": [ "twitter", "facebook", "instagram", "linkedin", "tiktok", "youtube", "pinterest", "reddit", "telegram", "gmb", "bluesky", "snapchat", "threads" ], "type": "string" }, "minItems": 1, "type": "array" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" } }, "required": [ "id" ], "type": "object" } }, { "name": "get_post_analytics_by_social_id", "description": "Get real-time analytics for a post identified by its NATIVE Social Post ID (the platform's own ID, not an Ayrshare Post ID). Notes: exactly one platform required; body is locked to {id, platforms:[platform], searchPlatformId:true} — no extra keys forwarded. For posts created through Ayrshare where you have the Ayrshare Post ID, use get_post_analytics instead. Requires a valid API key (same authentication as every other tool).", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "id": { "description": "The native Social Post ID assigned by the platform itself (e.g. a Tweet/X status ID, YouTube video ID, Instagram post ID). NOT an Ayrshare Post ID.", "minLength": 1, "type": "string" }, "platform": { "description": "The single platform the post belongs to (exactly one required). Values: bluesky, facebook, instagram, linkedin, pinterest, reddit, snapchat, threads, tiktok, twitter, youtube.", "enum": [ "bluesky", "facebook", "instagram", "linkedin", "pinterest", "reddit", "snapchat", "threads", "tiktok", "twitter", "youtube" ], "type": "string" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" } }, "required": [ "id", "platform" ], "type": "object" } }, { "name": "get_social_network_analytics", "description": "Account-level analytics and demographics for a linked social network account (follower count, impressions, views, demographics). Notes: quarters 1-4 activates date filtering; daily and period60Days are incompatible; Facebook needs \u003e=100 page likes for full analytics; Instagram demographics need \u003e=100 engagements in 30 days; LinkedIn/TikTok may lag 24-48 h. userId/userName (X/Twitter) look up a specific user and must use the account API key only, with no profileKey. This is NOT analytics about an Ayrshare User Profile — for profiles use list_profiles. Requires a valid API key (same authentication as every other tool).", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "daily": { "description": "When true, returns analytics as daily time-series values instead of aggregated totals. Available for Facebook, Google Business Profile (gmb), Instagram, Snapchat, TikTok, and YouTube. Setting daily=true on gmb/Instagram/TikTok also activates date filtering (shorter quarters window).", "type": "boolean" }, "period60Days": { "description": "TikTok only. When true, returns only 60-day aggregate totals for comments, shares, and views. Faster than full history. Do not combine with daily=true.", "type": "boolean" }, "platforms": { "description": "Social media platforms to retrieve account-level analytics for (one or more). Uses the same identifiers as create_post — e.g. 'gmb', not 'googlebusiness'.", "items": { "enum": [ "twitter", "facebook", "instagram", "linkedin", "tiktok", "youtube", "pinterest", "reddit", "telegram", "gmb", "bluesky", "snapchat", "threads" ], "type": "string" }, "minItems": 1, "type": "array" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" }, "quarters": { "description": "Number of quarters of historical data to return (1–4). A quarter is ~85 days for Facebook or ~90 days for Google Business Profile (gmb)/Instagram/TikTok/YouTube/Snapchat. Only values \u003e= 1 activate date filtering; omit (or set 0) AND leave daily unset to get all-time data (trailing 24 months for gmb) — daily=true activates a date range on its own, so quarters: 0 with daily: true still returns a one-quarter series. Incompatible with period60Days.", "maximum": 4, "minimum": 0, "type": "integer" }, "userId": { "description": "X/Twitter only. Retrieve analytics for a specific user by their numeric Twitter ID instead of the linked account. Use only the API key — do not include a Profile-Key.", "type": "string" }, "userName": { "description": "X/Twitter only. Retrieve analytics for a specific user by their handle instead of the linked account. Use only the API key — do not include a Profile-Key.", "type": "string" }, "youtube": { "description": "Platform-specific options for YouTube analytics.", "properties": { "lifetime": { "description": "When true, includes lifetimeLikes in the response — the sum of likes across all public channel videos. Channels with more than 1,000 videos return null with a warning. Cached 24 hours on success.", "type": "boolean" } }, "type": "object" } }, "required": [ "platforms" ], "type": "object" } }, { "name": "get_comments", "description": "Read comments for a post using an Ayrshare Post ID, Social Post ID, or Social Comment ID. Notes: `platform` is required when `searchPlatformId` or `commentId` is true. Comment data refreshes every 10 minutes; X/Twitter uses exponential backoff. Facebook and Instagram return up to the most recent 1,000 comments.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "commentId": { "description": "Set to true when `id` is a Social Comment ID. Must also set `searchPlatformId: true` when using this flag.", "type": "boolean" }, "id": { "description": "Ayrshare Post ID (default), Social Post ID, or Social Comment ID for the post to read comments from.", "minLength": 1, "type": "string" }, "platform": { "description": "Required when `searchPlatformId` or `commentId` is true. Specifies which social network to query. Supported: bluesky, facebook, instagram, linkedin, threads, tiktok, twitter, youtube.", "enum": [ "bluesky", "facebook", "instagram", "linkedin", "threads", "tiktok", "twitter", "youtube" ], "type": "string" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" }, "searchPlatformId": { "description": "Set to true when `id` is a Social Post ID or Social Comment ID from the social network (default: false).", "type": "boolean" } }, "required": [ "id" ], "type": "object" } }, { "name": "add_comment", "description": "Add a top-level comment to a published post using an Ayrshare Post ID or Social Post ID. Notes: When `searchPlatformId` is true, `platforms` must contain exactly one entry. `mediaUrls` supports one image URL on Facebook, LinkedIn, and X/Twitter only. Comments on an X Thread land on the first Tweet.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "comment": { "description": "Text body of the comment to add. Include @mentions inline — there is no separate mentions parameter.", "minLength": 1, "type": "string" }, "id": { "description": "Ayrshare Post ID (default) or Social Post ID from the /post endpoint. Use `searchPlatformId: true` for Social Post IDs.", "minLength": 1, "type": "string" }, "mediaUrls": { "description": "Array with exactly one image URL to attach to the comment. Supported on Facebook, LinkedIn, and X/Twitter only.", "items": { "format": "uri", "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array" }, "platforms": { "description": "Platforms to post the comment on. Defaults to all comment-capable platforms the post lives on. When `searchPlatformId` is true, provide exactly ONE platform. Supported: bluesky, facebook, instagram, linkedin, reddit, tiktok, twitter, youtube.", "items": { "enum": [ "bluesky", "facebook", "instagram", "linkedin", "reddit", "tiktok", "twitter", "youtube" ], "type": "string" }, "minItems": 1, "type": "array" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" }, "searchPlatformId": { "description": "Set to true when `id` is a Social Post ID from the social network. Requires exactly one entry in `platforms` (default: false).", "type": "boolean" } }, "required": [ "id", "comment" ], "type": "object" } }, { "name": "reply_comment", "description": "Reply to a comment using an Ayrshare Comment ID or Social Comment ID. Notes: When `searchPlatformId` is true, `platforms` must contain exactly one entry. `commentUrn` is required for LinkedIn Social Comment ID replies. `videoId` is required for TikTok Social Comment ID replies. `mediaUrls` supports one image URL on Facebook and LinkedIn only. Reddit is not supported for comment replies.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "comment": { "description": "Text body of the reply. Include @mentions inline — there is no separate mentions parameter.", "minLength": 1, "type": "string" }, "commentId": { "description": "Ayrshare Comment ID (from add_comment, default) or Social Comment ID from the social network when `searchPlatformId` is true.", "minLength": 1, "type": "string" }, "commentUrn": { "description": "LinkedIn parent comment URN, shaped `urn:li:comment:(urn:li:activity:\u003cpostId\u003e,\u003ccommentId\u003e)` — pass the full `commentUrn` from get_comments, not the bare `commentId`. Required when replying to a LinkedIn Social Comment ID (`searchPlatformId: true` and platform is linkedin).", "type": "string" }, "mediaUrls": { "description": "Array with exactly one image URL to attach to the reply. Supported on Facebook and LinkedIn only.", "items": { "format": "uri", "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array" }, "objResponse": { "description": "When true (default), returns the response as an object. When false, returns an array.", "type": "boolean" }, "platforms": { "description": "Platforms to publish the reply on. When `searchPlatformId` is true, must contain exactly one platform. Supported: bluesky, facebook, instagram, linkedin, tiktok, twitter, youtube. Not supported on Reddit.", "items": { "enum": [ "bluesky", "facebook", "instagram", "linkedin", "tiktok", "twitter", "youtube" ], "type": "string" }, "minItems": 1, "type": "array" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" }, "searchPlatformId": { "description": "Set to true when `commentId` is a Social Comment ID from the social network. `platforms` must then contain exactly one entry (default: false).", "type": "boolean" }, "videoId": { "description": "TikTok video ID (Social Post ID). Required when replying to a TikTok Social Comment ID (`searchPlatformId: true` and platform is tiktok).", "type": "string" } }, "required": [ "commentId", "comment", "platforms" ], "type": "object" } }, { "name": "get_messages", "description": "Fetch direct messages or conversations for one messaging platform (facebook, instagram, whatsapp, twitter). Notes: responses are cached for 60 s, or 15 s on X/Twitter. Use conversationsOnly to list thread summaries, conversationId to scope to one thread, and limit + next for pagination. Every platform returns a bounded page of at most 100 messages or conversations with a meta.pagination cursor; follow next while hasMore is true.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "conversationId": { "description": "Scope results to a single conversation thread. Ignored when conversationsOnly is true.", "type": "string" }, "conversationsOnly": { "description": "If true, return conversation summaries instead of individual messages. Ignores conversationId when set.", "type": "boolean" }, "limit": { "description": "Page size for messages and conversation lists (1–100), default and maximum 100. On X/Twitter limit also chooses which set of messages you read: omit it to page stored messages, which is what every other platform does and what applies status and conversationsOnly; supply it to page X's live timeline instead, which applies neither. That choice is made by the first request only: once you pass next, the cursor decides which set you stay on, whether or not you also send limit. Use next for subsequent pages.", "maximum": 100, "minimum": 1, "type": "integer" }, "next": { "description": "Opaque cursor from meta.pagination.next. Keep the same profile, platform and filters. Continue while hasMore is true, including after an empty filtered page.", "type": "string" }, "platform": { "description": "Messaging platform to retrieve from. DMs are available on facebook, instagram, whatsapp, and twitter.", "enum": [ "facebook", "instagram", "whatsapp", "twitter" ], "type": "string" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" }, "status": { "description": "Filter by conversation status. Values: active (default) or archived.", "type": "string" } }, "required": [ "platform" ], "type": "object" } }, { "name": "send_message", "description": "Send a direct message on facebook, instagram, or twitter. Notes: At least one of message or mediaUrls is required. At least one of recipientId or conversationId is required. Facebook and Instagram require recipientId and only accept messages within the platform's messaging window.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "conversationId": { "description": "Existing conversation thread ID (from get_messages). Satisfies the recipient requirement on X/Twitter.", "minLength": 1, "type": "string" }, "mediaUrls": { "description": "Array of public media URLs to attach (images, video, or voice as .aac/.wav). URLs must end in a file extension without query parameters. Facebook and Instagram support multiple URLs; X/Twitter accepts only one.", "items": { "format": "uri", "type": "string" }, "minItems": 1, "type": "array" }, "message": { "description": "Text body of the message. Required on X/Twitter even when mediaUrls is provided. May be omitted on Facebook and Instagram when mediaUrls is supplied.", "minLength": 1, "type": "string" }, "platform": { "description": "Platform to send the message on: facebook, instagram, or twitter.", "enum": [ "facebook", "instagram", "twitter" ], "type": "string" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" }, "recipientId": { "description": "Native user ID of the message recipient. Required for Facebook and Instagram.", "minLength": 1, "type": "string" } }, "required": [ "platform" ], "type": "object" } }, { "name": "get_auto_response", "description": "Return the account's current direct-message auto-response settings (account-level, not platform-scoped). Notes: Takes no parameters. Returns autoResponseActive, autoResponseMessage, and autoResponseWaitSeconds when configured. To update settings use set_auto_response.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" } }, "type": "object" } }, { "name": "set_auto_response", "description": "Configure the account's direct-message auto-response (account-level, not platform-scoped). Notes: At least one of autoResponseActive, autoResponseMessage, or autoResponseWaitSeconds is required. Do NOT send autoResponseMessage as \"\": it does not reset the message. Sent alone the API returns code 101, and sent with another field it is silently ignored. Send the default text explicitly instead. To read the current settings use get_auto_response.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "autoResponseActive": { "description": "Whether the auto-response is active. Default: false.", "type": "boolean" }, "autoResponseMessage": { "description": "The auto-response message text. Default: \"Thank you for contacting us. A customer care agent will get back to you soon.\" NOTE: sending an empty string \"\" does NOT reset to the default — the API either rejects the request (code 101, when it is the only field) or silently ignores it. Send the default text explicitly if you want it back.", "type": "string" }, "autoResponseWaitSeconds": { "description": "Seconds to wait before sending the auto-response again to the same correspondent. Default: 86400 (24 hours).", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" } }, "type": "object" } }, { "name": "list_profiles", "description": "List the User Profiles under the caller's Primary Profile (which is not itself included); all inputs are optional filters/pagination. Notes: Profile Keys are NOT returned for security — retrieve them from the dashboard. Requires a valid API key (same authentication as every other tool).", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "actionLog": { "anyOf": [ { "type": "boolean" }, { "maximum": 365, "minimum": 1, "type": "integer" } ], "description": "Return the create/delete action log and active-user billing count. Pass true for 60 days (default), or a number of days (1-365)." }, "cursor": { "description": "Pagination cursor. When hasMore is true in the response, pass the returned nextCursor here to fetch the next page.", "type": "string" }, "hasActiveSocialAccounts": { "description": "If true, return only profiles with at least one connected social account. If false, return only profiles with zero connected social accounts.", "type": "boolean" }, "include": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "description": "Return extended profile data. Requires refId. Values: suspension, socialHealth, linkingErrors, activity, quota, unlinkHistory, actionLog, state. state gives one normalized value per social network — unlinked, linked, identityVerificationRequired, restricted, rateLimited, or suspended — plus actionable, message, helpUrl, and an optional since that is omitted where no timestamp is recorded (always for restricted)." }, "includesActiveSocialAccounts": { "description": "Filter to profiles whose activeSocialAccounts contain ALL of the listed platforms. Extra platforms on the profile are allowed.", "items": { "enum": [ "bluesky", "facebook", "gmb", "instagram", "linkedin", "pinterest", "reddit", "snapchat", "telegram", "threads", "tiktok", "twitter", "youtube" ], "type": "string" }, "type": "array" }, "isByokLinked": { "description": "Filter by BYOK (Bring Your Own Key) migration status. true = completed BYOK migration; false = eligible but not migrated. Omit to return all profiles regardless of BYOK status. Currently applies to X/Twitter BYOK.", "type": "boolean" }, "limit": { "description": "Maximum number of profiles to return. Default and maximum is 5000.", "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "refId": { "description": "Return only the profile with this refId (returned at creation or from /user).", "type": "string" }, "title": { "description": "Return only the profile with this URL-encoded title.", "type": "string" } }, "type": "object" } }, { "name": "create_profile", "description": "Create a new User Profile under the caller's Primary Profile. Required: `title` (unique, shown on the social-account-linking page). Returns `profileKey` and `refId` — SENSITIVE values that must be securely stored (profileKey is only returned at creation time or via the dashboard). Notes: To invite a team member set `team: true` and supply `email`. Use `disableSocial` to block specific networks for this profile. Requires a valid API key (same authentication as every other tool).", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "demo": { "description": "Create a 30-day Demo User Profile. Eligibility (code 480 otherwise): an Enterprise account once the demoProfiles flag is generally available, or earlier through a per-account exemption; a Business account ONLY through that exemption. No other plan can, and an exemption does not lift the plan floor.", "type": "boolean" }, "disableSocial": { "description": "Array of social networks to disable for this profile. The primary profile's disabled list takes precedence. Values: bluesky, facebook, gmb, instagram, linkedin, pinterest, reddit, snapchat, telegram, threads, tiktok, twitter, youtube.", "items": { "enum": [ "bluesky", "facebook", "gmb", "instagram", "linkedin", "pinterest", "reddit", "snapchat", "telegram", "threads", "tiktok", "twitter", "youtube" ], "type": "string" }, "type": "array" }, "email": { "description": "Email address to send the team member invite. Required when team is true.", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", "type": "string" }, "hideLogo": { "description": "Hide the company logo on the social accounts linkage page for this profile only. Useful for white-labeling individual partner profiles.", "type": "boolean" }, "hideTopHeader": { "description": "Hide the top header on the social accounts linkage page.", "type": "boolean" }, "messagingActive": { "description": "Set to true to activate messaging for this User Profile. Messaging must first be enabled for your Ayrshare account.", "type": "boolean" }, "subHeader": { "description": "Override the sub-header on the social accounts linkage page. Set to empty string to remove it.", "type": "string" }, "tags": { "description": "Array of string tags for internal categorization and management of User Profiles.", "items": { "type": "string" }, "type": "array" }, "team": { "description": "Set to true to create this profile as a team member. The email field is required when team is true.", "type": "boolean" }, "title": { "description": "Title of the new profile. Must be unique. Displayed on the social account linking page.", "minLength": 1, "type": "string" }, "topHeader": { "description": "Override the header on the social accounts linkage page. Default: \"Social Accounts for \u003ctitle\u003e\".", "type": "string" } }, "required": [ "title" ], "type": "object" } }, { "name": "generate_jwt_social_linking_url", "description": "Generate a single sign-on (JWT) SOCIAL-ACCOUNT LINKING URL for one User Profile (sub-profile), so a client/customer can connect their own social networks (Facebook, Instagram, X, LinkedIn, TikTok, etc.) to that profile. This is the onboarding step after `create_profile`: it returns a hosted linking page URL you hand to the end user, who opens it in a browser to OAuth their individual social accounts. Authentication: pass your account API key as `Authorization: Bearer \u003ckey\u003e` and the TARGET sub-profile's key either as the `profileKey` argument or the `Profile-Key` header (the argument takes precedence). That Profile Key is REQUIRED and identifies whose linking page the URL opens. You do NOT supply a private key or a domain: nothing is signed, and the server resolves the account's own onboarding domain, so nothing secret enters the conversation. What you get back: `token` is an OPAQUE link-session token (not a JWT — do not try to decode it), and `url` carries it as `?session=\u003ctoken\u003e`. The link stays usable for its whole expiry window, so a reload or a retry works — but it is a BEARER credential scoped to ONE sub-profile: hand it to exactly one end user, and mint a fresh one per person. Revoke it with `DELETE /profiles/link-sessions/{sessionId}` to kill it early. Notes: the `url` is valid for the lifetime configured on your linking domain (5 minutes unless you changed it, or `expiresIn`, Max Pack) and must be opened in a browser to complete linking — this tool only mints the link, it does not link anything itself. The legacy `verify`, `base64` and `privateKey` params are accepted and IGNORED; omit them. `email` and `expiresIn` require the Max Pack. To use your own X Developer App for X linking, set the `X-Twitter-OAuth1-Api-Key` / `X-Twitter-OAuth1-Api-Secret` connection headers.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "allowedSocial": { "description": "Restrict which social networks appear on the linking page. Values: bluesky, facebook, gmb, instagram, linkedin, pinterest, reddit, snapchat, telegram, threads, tiktok, twitter, youtube.", "items": { "enum": [ "bluesky", "facebook", "gmb", "instagram", "linkedin", "pinterest", "reddit", "snapchat", "telegram", "threads", "tiktok", "twitter", "youtube" ], "type": "string" }, "type": "array" }, "email": { "description": "Optional Connect Accounts email — when supplied, Ayrshare emails the linking URL directly to the user. Requires the Max Pack. The email is only sent when `to`, `termsUrl`, `privacyUrl`, `company` and `contactEmail` are all set. If it is not sent, the link is still returned, with `emailSent: false` and an `emailError` explaining why.", "properties": { "bcc": { "description": "Optional BCC email address.", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", "type": "string" }, "company": { "description": "Your company name, shown in the email. Needed for the email to send.", "type": "string" }, "contactEmail": { "description": "Reply-to / contact email shown in the email. Needed for the email to send.", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", "type": "string" }, "privacyUrl": { "description": "URL to your Privacy Policy, shown in the email. Needed for the email to send.", "format": "uri", "type": "string" }, "termsUrl": { "description": "URL to your Terms of Service, shown in the email. Needed for the email to send.", "format": "uri", "type": "string" }, "to": { "description": "Recipient email address for the Connect Accounts email.", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", "type": "string" } }, "required": [ "to" ], "type": "object" }, "expiresIn": { "description": "Session longevity in MINUTES (range 1-2880). Omit it to use the lifetime configured for your linking domain, which defaults to 5 minutes. Requires the Max Pack.", "maximum": 2880, "minimum": 1, "type": "integer" }, "instagramLinkMethod": { "description": "Force the Instagram linking flow on the page for this profile, overriding the account's default: \"instagram\" = direct Instagram Login, \"facebook\" = link via a Facebook Page. Gated to allowlisted accounts; ignored otherwise.", "enum": [ "instagram", "facebook" ], "type": "string" }, "logout": { "description": "Automatically log out the current profile session when the URL is opened. Not recommended in production.", "type": "boolean" }, "profileKey": { "description": "Profile Key of the target User Profile (sub-profile) whose social-account linking page this URL opens. REQUIRED: pass it here as an argument or as the Profile-Key request header (the argument takes precedence).", "minLength": 1, "type": "string" }, "redirect": { "description": "URL to send the user to when they click \"Done\" or the logo on the linking page.", "format": "uri", "type": "string" }, "verify": { "description": "DEPRECATED, accepted and IGNORED (no-op). There is no signed token to verify any more: the endpoint mints an opaque session token instead. Safe to omit.", "type": "boolean" } }, "type": "object" } }, { "name": "generate_post", "description": "Generate AI-written social post copy from a topic or media. Provide `text` (a topic/brief), `mediaUrls` (public image URLs to caption), or both — at least one is required. Returns DRAFT copy only — does NOT publish. Feed the result to validate_post, then create_post. Notes: `hashtags` defaults to true. Token usage is returned in the response.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "emojis": { "description": "Include emojis in the generated post. Defaults to false.", "type": "boolean" }, "hashtags": { "description": "Include suggested hashtags in the generated post. Defaults to true.", "type": "boolean" }, "mediaUrls": { "description": "Array of public image URLs to base the post caption on. Required if text is not provided. Can be combined with text.", "items": { "format": "uri", "type": "string" }, "minItems": 1, "type": "array" }, "text": { "description": "Description of what the post should be about (e.g. \"A shoe sale happening Monday with specials on red, blue, and yellow shoes\"). Required if mediaUrls is not provided.", "minLength": 1, "type": "string" }, "twitter": { "description": "Constrain the generated post to 280 characters or fewer (X/Twitter limit). Defaults to false.", "type": "boolean" } }, "type": "object" } }, { "name": "recommend_hashtags", "description": "Get recommended hashtags for a keyword, sourced from TikTok view-count data. Required: `keyword`. A linked TikTok account is required (the API returns an error otherwise). Notes: To generate hashtags from a full post body instead of a single keyword, use generate_post (which can include hashtags) rather than this tool.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "keyword": { "description": "A single keyword to get recommended hashtags for (sourced from TikTok). Spaces in the keyword are removed before lookup.", "minLength": 1, "type": "string" }, "source": { "description": "Free-form attribution tag for your own analytics tracking. Not used for hashtag generation.", "type": "string" } }, "required": [ "keyword" ], "type": "object" } }, { "name": "register_webhook", "description": "Register an HTTPS endpoint to receive Ayrshare event notifications for a given action. Returns the registered webhook record. Notes: re-registering the same (action, url, source) updates the existing record; secrets are write-only and never returned by list_webhooks.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "action": { "description": "Event class to subscribe to. One of: feed, social, scheduled, batch, messages, mentions, comments, automations, accountActivity, demo, suspended, ads.", "enum": [ "feed", "social", "scheduled", "batch", "messages", "mentions", "comments", "automations", "accountActivity", "demo", "suspended", "ads" ], "type": "string" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" }, "secret": { "description": "Optional HMAC signing secret. Ayrshare signs every delivery so you can verify authenticity. Store it server-side — it is never returned by list_webhooks.", "minLength": 1, "type": "string" }, "source": { "description": "Optional source identifier to scope the subscription to a sub-profile or named source.", "minLength": 1, "type": "string" }, "url": { "description": "HTTPS endpoint Ayrshare will POST events to. Must be publicly reachable.", "format": "uri", "type": "string" } }, "required": [ "url", "action" ], "type": "object" } }, { "name": "unregister_webhook", "description": "Remove a previously registered webhook subscription for the given action. Returns confirmation of the removed subscription. Notes: only stops future deliveries; pass `profileKey` as an argument or via the `Profile-Key` header to target a sub-profile's subscription.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "action": { "description": "Event class the webhook was registered for. One of: feed, social, scheduled, batch, messages, mentions, comments, automations, accountActivity, demo, suspended, ads.", "enum": [ "feed", "social", "scheduled", "batch", "messages", "mentions", "comments", "automations", "accountActivity", "demo", "suspended", "ads" ], "type": "string" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" }, "source": { "description": "Optional source identifier used when the subscription was registered. Must match the original registration.", "minLength": 1, "type": "string" } }, "required": [ "action" ], "type": "object" } }, { "name": "list_webhooks", "description": "List webhook subscriptions for the authenticated account. Returns webhook records (action, url, source, timestamps) without secrets (those are write-only). Notes: without allWebhooks=true the list scopes to the current profile only; use register_webhook / unregister_webhook to manage subscriptions.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "allWebhooks": { "description": "When true, returns subscriptions across all User Profiles associated with the account. Requires Primary Profile API key; defaults to false (current profile only).", "type": "boolean" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" }, "source": { "description": "Filter results to subscriptions registered under this source identifier.", "minLength": 1, "type": "string" } }, "type": "object" } }, { "name": "list_ad_accounts", "description": "List the ad accounts the linked account on this platform can spend from. Use the accountId values returned wherever an ads tool asks for accountId. Requires the Ads add-on; without it the call returns Error 403 (code 399).", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "after": { "description": "Cursor for the next page, taken from the previous response's paging data. It is an opaque Meta-issued value - pass it back unchanged rather than constructing one.", "minLength": 1, "type": "string" }, "limit": { "description": "Maximum number of records to return in this page.", "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "platform": { "description": "Ads platform to act on: facebook, instagram.", "enum": [ "facebook", "instagram" ], "type": "string" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" } }, "required": [ "platform" ], "type": "object" } }, { "name": "search_ad_targeting", "description": "Search the platform's targeting options before boosting a post. kind 'interests' returns interest ids for audience targeting (search is required); 'regions' and 'cities' return location keys for geographic targeting. Each kind takes only its own arguments, marked in their descriptions. Requires the Ads add-on.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "accountId": { "description": "Interests only. Ad account to resolve the special-ad-category interest list against. REQUIRED whenever specialAdCategories is supplied, and ignored otherwise.", "minLength": 1, "type": "string" }, "after": { "description": "Interests only. Cursor for the next page, taken from the previous response's paging data. It is an opaque Meta-issued value - pass it back unchanged rather than constructing one.", "minLength": 1, "type": "string" }, "countryCode": { "description": "Cities only. Restrict to one country, as an ISO 3166-1 alpha-2 code (e.g. 'US'). Exactly two letters - the value is forwarded to Meta as country_code, which takes alpha-2, so a three-letter code like 'USA' cannot match anything.", "pattern": "^[A-Za-z]{2}$", "type": "string" }, "kind": { "description": "What to search: interests for audience targeting, or regions and cities for geographic targeting.", "enum": [ "interests", "regions", "cities" ], "type": "string" }, "limit": { "description": "Maximum number of records to return in this page.", "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "platform": { "description": "Ads platform to act on: facebook, instagram.", "enum": [ "facebook", "instagram" ], "type": "string" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" }, "regionId": { "description": "Cities only. Restrict to one region, using an id from a search with kind regions.", "minLength": 1, "type": "string" }, "search": { "description": "Text to search for. Required when kind is interests; otherwise it filters regions or cities by name.", "minLength": 1, "type": "string" }, "specialAdCategories": { "description": "Interests only. Restrict the results to interests Meta allows a special-ad-category campaign to target. Use this before boosting a housing, employment, financial or political post so you pick interest ids the ad will actually be approved for. Requires accountId.", "items": { "enum": [ "none", "housing", "financial_products_services", "employment", "issues_elections_politics", "financial_product_services", "credit" ], "type": "string" }, "minItems": 1, "type": "array" } }, "required": [ "platform", "kind" ], "type": "object" } }, { "name": "list_ads", "description": "List boosted ads, filtered by campaign, account, ad or post. At least one of campaignId, accountId, adId, postId or socialPostId is required. status only reliably filters post lookups, so check each ad's status in the result. Requires the Ads add-on.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "accountId": { "description": "Ad account id, from the ad accounts list (adAccounts in GraphQL, list_ad_accounts in MCP).", "minLength": 1, "type": "string" }, "adId": { "description": "Only this specific ad.", "minLength": 1, "type": "string" }, "campaignId": { "description": "Only ads in this campaign.", "minLength": 1, "type": "string" }, "limit": { "description": "Maximum number of records to return in this page.", "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "platform": { "description": "Ads platform to act on: facebook, instagram.", "enum": [ "facebook", "instagram" ], "type": "string" }, "postId": { "description": "Only ads boosting this Ayrshare post id, as returned by createPost.", "minLength": 1, "type": "string" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" }, "socialPostId": { "description": "The network's own post id to restrict to, for posts not published through Ayrshare.", "minLength": 1, "type": "string" }, "status": { "description": "Ads in this state, e.g. 'ACTIVE' or 'PAUSED'. Only a true filter on postId and post selector lookups. On an accountId lookup it only chooses which campaigns to include, and every ad in those campaigns is returned; with campaignId or adId it is ignored. Check each ad's status in the result. Matched in both upper and lower case, the two forms ads are stored in ('active' when boosted, 'ACTIVE' after an update). A plain string rather than a closed set because the vocabulary is Meta's, not ours.", "minLength": 1, "type": "string" } }, "required": [ "platform" ], "type": "object" } }, { "name": "update_ad", "description": "Change a boosted ad's state. This controls real ad spend: status PAUSED stops spending, ACTIVE resumes it, DELETED or ARCHIVED retires the ad. The same status is also set on the ad's ad set and campaign, so other ads in that ad set or campaign change with it, except a campaign or ad set the boost was attached to with attachTo, which keeps its own status. The ad runs only while the campaign and ad set above it are active. Use it when an ad is costing more than intended. Get adId from list_ads. Requires the Ads add-on.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "adId": { "description": "Id of the ad to change, from the ads list (ads in GraphQL, list_ads in MCP).", "minLength": 1, "type": "string" }, "platform": { "description": "Ads platform to act on: facebook, instagram.", "enum": [ "facebook", "instagram" ], "type": "string" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" }, "status": { "description": "New state for the ad, upper or lower case: ACTIVE, PAUSED, DELETED, ARCHIVED. PAUSED stops spending, ACTIVE resumes, and DELETED or ARCHIVED retires it.", "enum": [ "ACTIVE", "PAUSED", "DELETED", "ARCHIVED", "active", "paused", "deleted", "archived" ], "type": "string" } }, "required": [ "platform", "adId", "status" ], "type": "object" } }, { "name": "get_ad_history", "description": "Spend and performance history for boosted ads over a date window. Use it to see what an ad has actually cost. Requires the Ads add-on.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "accountId": { "description": "Ad account id, from the ad accounts list (adAccounts in GraphQL, list_ad_accounts in MCP).", "minLength": 1, "type": "string" }, "adId": { "description": "Restrict to one ad.", "minLength": 1, "type": "string" }, "endDate": { "description": "End of the reporting window, as an ISO date.", "minLength": 1, "type": "string" }, "limit": { "description": "Maximum number of records to return in this page.", "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "platform": { "description": "Ads platform to act on: facebook, instagram.", "enum": [ "facebook", "instagram" ], "type": "string" }, "postId": { "description": "Restrict to ads boosting this Ayrshare post id.", "minLength": 1, "type": "string" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" }, "socialPostId": { "description": "Restrict to ads boosting this post, by the network's own post id.", "minLength": 1, "type": "string" }, "startDate": { "description": "Start of the reporting window, as an ISO date.", "minLength": 1, "type": "string" } }, "required": [ "platform" ], "type": "object" } }, { "name": "boost_post", "description": "Boost a published post as an ad. This spends real money from the ad account. Unless you say otherwise, the ad is active, starts now and has no end date: set status paused or schedule.end to limit it. Give schedule dates as ISO 8601 date-times, such as 2026-10-10T09:00:00Z. Supply postId (the Ayrshare post id) or socialPostId (the network's own id), and accountId from list_ad_accounts. Settings only one platform has go under platformOptions, keyed by platform. On facebook and instagram, platformOptions.\u003cplatform\u003e.adName and .bidAmount are required, for example { \"facebook\": { \"adName\": \"Autumn sale\", \"bidAmount\": 2 } }. With attachTo.adSetId, leave out budget, targeting and bidAmount: the existing ad set keeps its own. Send a new idempotencyKey (such as a UUID) with each boost, and retry with the same key and arguments: a retry returns the first response instead of paying for a second ad, or Error 409 while the first is still in progress; never retry with a new key. Use update_ad with status PAUSED to stop the ad spending. Requires the Ads add-on.", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "properties": { "accountId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" } ], "description": "Ad account id." }, "attachTo": { "additionalProperties": false, "properties": { "adSetId": { "minLength": 1, "type": "string" }, "campaignId": { "minLength": 1, "type": "string" } }, "type": "object" }, "budget": { "additionalProperties": false, "description": "The boost's budget. Required unless attachTo.adSetId is set.", "properties": { "amount": { "description": "Amount to spend, in the ad account's currency.", "exclusiveMinimum": 0, "type": "number" }, "currency": { "description": "ISO 4217 code of the account currency.", "maxLength": 3, "minLength": 3, "type": "string" }, "level": { "description": "Where the budget sits: adSet or campaign.", "enum": [ "adSet", "campaign" ], "type": "string" }, "type": { "description": "daily or lifetime. The platform's manifest says which it supports.", "enum": [ "daily", "lifetime" ], "type": "string" } }, "required": [ "amount" ], "type": "object" }, "callToAction": { "additionalProperties": false, "properties": { "destination": { "description": "Open a conversation instead of a link: messenger, whatsapp or instagramDm, with type MESSAGE_PAGE, WHATSAPP_MESSAGE or INSTAGRAM_MESSAGE. The ad optimises for conversations.", "enum": [ "messenger", "whatsapp", "instagramDm" ], "type": "string" }, "link": { "description": "Required unless destination is set.", "format": "uri", "type": "string" }, "linkTitle": { "minLength": 1, "type": "string" }, "type": { "minLength": 1, "type": "string" } }, "required": [ "type" ], "type": "object" }, "goal": { "description": "Optimisation goal, one of the platform's declared goals.", "minLength": 1, "type": "string" }, "idempotencyKey": { "description": "A unique value per new ad, such as a UUID. Retrying with the same key returns the first response instead of creating a second ad.", "minLength": 1, "type": "string" }, "platform": { "description": "Ads platform to act on: facebook, instagram.", "enum": [ "facebook", "instagram" ], "type": "string" }, "platformOptions": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, "postId": { "description": "Ayrshare post id to boost.", "minLength": 1, "type": "string" }, "profileKey": { "description": "Optional Profile Key of the target User Profile (sub-profile) to act on. Same value other tools accept; when set here it takes precedence over the Profile-Key request header. Omit both to act on the caller's Primary Profile. A value passed as an argument appears in the request and the agent transcript; the Profile-Key header keeps it out of band, so prefer the header for static setups.", "minLength": 1, "type": "string" }, "schedule": { "additionalProperties": false, "properties": { "end": { "anyOf": [ { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "number" } ] }, { "type": "null" } ], "description": "When the ad stops. 0 or null means it runs on." }, "start": { "anyOf": [ { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "number" } ] }, { "type": "null" } ], "description": "When the ad starts. Defaults to now." } }, "type": "object" }, "socialPostId": { "description": "The network's own post id to boost.", "minLength": 1, "type": "string" }, "status": { "enum": [ "active", "paused" ], "type": "string" }, "targeting": { "additionalProperties": false, "properties": { "ageMax": { "maximum": 65, "minimum": 18, "type": "integer" }, "ageMin": { "maximum": 65, "minimum": 18, "type": "integer" }, "audiences": { "items": { "minLength": 1, "type": "string" }, "minItems": 1, "type": "array" }, "excludedLocations": { "additionalProperties": false, "properties": { "cities": { "anyOf": [ { "additionalProperties": {}, "properties": { "key": { "minLength": 1, "type": "string" } }, "required": [ "key" ], "type": "object" }, { "items": { "additionalProperties": {}, "properties": { "key": { "minLength": 1, "type": "string" } }, "required": [ "key" ], "type": "object" }, "minItems": 1, "type": "array" } ] }, "countries": { "anyOf": [ { "minLength": 2, "type": "string" }, { "items": { "minLength": 2, "type": "string" }, "minItems": 1, "type": "array" } ] }, "regions": { "anyOf": [ { "additionalProperties": {}, "properties": { "key": { "minLength": 1, "type": "string" } }, "required": [ "key" ], "type": "object" }, { "items": { "additionalProperties": {}, "properties": { "key": { "minLength": 1, "type": "string" } }, "required": [ "key" ], "type": "object" }, "minItems": 1, "type": "array" } ] } }, "type": "object" }, "genders": { "enum": [ "all", "male", "female" ], "type": "string" }, "interests": { "items": { "anyOf": [ { "minLength": 1, "type": "string" }, { "exclusiveMinimum": 0, "type": "number" } ] }, "minItems": 1, "type": "array" }, "keywords": { "items": { "minLength": 1, "type": "string" }, "minItems": 1, "type": "array" }, "locations": { "additionalProperties": false, "properties": { "cities": { "anyOf": [ { "additionalProperties": {}, "properties": { "key": { "minLength": 1, "type": "string" } }, "required": [ "key" ], "type": "object" }, { "items": { "additionalProperties": {}, "properties": { "key": { "minLength": 1, "type": "string" } }, "required": [ "key" ], "type": "object" }, "minItems": 1, "type": "array" } ] }, "countries": { "anyOf": [ { "minLength": 2, "type": "string" }, { "items": { "minLength": 2, "type": "string" }, "minItems": 1, "type": "array" } ] }, "regions": { "anyOf": [ { "additionalProperties": {}, "properties": { "key": { "minLength": 1, "type": "string" } }, "required": [ "key" ], "type": "object" }, { "items": { "additionalProperties": {}, "properties": { "key": { "minLength": 1, "type": "string" } }, "required": [ "key" ], "type": "object" }, "minItems": 1, "type": "array" } ] } }, "type": "object" } }, "type": "object" } }, "required": [ "platform", "accountId", "goal" ], "type": "object" } } ], "schemaTokens": 37224, "changedAt": "2026-11-07T01:42:33.48878316Z", "check": { "checker": "anchor-check/1.0", "totalTokens": 37224, "counts": { "error": 0, "note": 1, "warn": 38 }, "findings": [ { "rule": "TC11", "severity": "warn", "tool": "boost_post", "message": "none of its 14 parameters has a description", "fix": "Describe each one: format, units, an example, and what happens when it's left out." }, { "rule": "TC16", "severity": "warn", "tool": "add_comment", "message": "no readOnlyHint or destructiveHint", "fix": "Set readOnlyHint: true if it only reads; otherwise set destructiveHint and idempotentHint." }, { "rule": "TC16", "severity": "warn", "tool": "boost_post", "message": "no readOnlyHint or destructiveHint", "fix": "Set readOnlyHint: true if it only reads; otherwise set destructiveHint and idempotentHint." }, { "rule": "TC16", "severity": "warn", "tool": "create_post", "message": "no readOnlyHint or destructiveHint", "fix": "Set readOnlyHint: true if it only reads; otherwise set destructiveHint and idempotentHint." }, { "rule": "TC16", "severity": "warn", "tool": "create_profile", "message": "no readOnlyHint or destructiveHint", "fix": "Set readOnlyHint: true if it only reads; otherwise set destructiveHint and idempotentHint." }, { "rule": "TC16", "severity": "warn", "tool": "explain_error", "message": "no readOnlyHint or destructiveHint", "fix": "Its name starts with \"explain\"; if it only reads, set readOnlyHint: true so harnesses can run it without asking." }, { "rule": "TC16", "severity": "warn", "tool": "generate_jwt_social_linking_url", "message": "no readOnlyHint or destructiveHint", "fix": "Set readOnlyHint: true if it only reads; otherwise set destructiveHint and idempotentHint." }, { "rule": "TC16", "severity": "warn", "tool": "generate_post", "message": "no readOnlyHint or destructiveHint", "fix": "Set readOnlyHint: true if it only reads; otherwise set destructiveHint and idempotentHint." }, { "rule": "TC16", "severity": "warn", "tool": "get_ad_history", "message": "no readOnlyHint or destructiveHint", "fix": "Its name starts with \"get\"; if it only reads, set readOnlyHint: true so harnesses can run it without asking." }, { "rule": "TC16", "severity": "warn", "tool": "get_auto_response", "message": "no readOnlyHint or destructiveHint", "fix": "Its name starts with \"get\"; if it only reads, set readOnlyHint: true so harnesses can run it without asking." }, { "rule": "TC16", "severity": "warn", "tool": "get_comments", "message": "no readOnlyHint or destructiveHint", "fix": "Its name starts with \"get\"; if it only reads, set readOnlyHint: true so harnesses can run it without asking." }, { "rule": "TC16", "severity": "warn", "tool": "get_messages", "message": "no readOnlyHint or destructiveHint", "fix": "Its name starts with \"get\"; if it only reads, set readOnlyHint: true so harnesses can run it without asking." }, { "rule": "TC16", "severity": "warn", "tool": "get_platform_history", "message": "no readOnlyHint or destructiveHint", "fix": "Its name starts with \"get\"; if it only reads, set readOnlyHint: true so harnesses can run it without asking." }, { "rule": "TC16", "severity": "warn", "tool": "get_post", "message": "no readOnlyHint or destructiveHint", "fix": "Its name starts with \"get\"; if it only reads, set readOnlyHint: true so harnesses can run it without asking." }, { "rule": "TC16", "severity": "warn", "tool": "get_post_analytics", "message": "no readOnlyHint or destructiveHint", "fix": "Its name starts with \"get\"; if it only reads, set readOnlyHint: true so harnesses can run it without asking." }, { "rule": "TC16", "severity": "warn", "tool": "get_post_analytics_by_social_id", "message": "no readOnlyHint or destructiveHint", "fix": "Its name starts with \"get\"; if it only reads, set readOnlyHint: true so harnesses can run it without asking." }, { "rule": "TC16", "severity": "warn", "tool": "get_post_history", "message": "no readOnlyHint or destructiveHint", "fix": "Its name starts with \"get\"; if it only reads, set readOnlyHint: true so harnesses can run it without asking." }, { "rule": "TC16", "severity": "warn", "tool": "get_social_network_analytics", "message": "no readOnlyHint or destructiveHint", "fix": "Its name starts with \"get\"; if it only reads, set readOnlyHint: true so harnesses can run it without asking." }, { "rule": "TC16", "severity": "warn", "tool": "list_ad_accounts", "message": "no readOnlyHint or destructiveHint", "fix": "Its name starts with \"list\"; if it only reads, set readOnlyHint: true so harnesses can run it without asking." }, { "rule": "TC16", "severity": "warn", "tool": "list_ads", "message": "no readOnlyHint or destructiveHint", "fix": "Its name starts with \"list\"; if it only reads, set readOnlyHint: true so harnesses can run it without asking." }, { "rule": "TC16", "severity": "warn", "tool": "list_profiles", "message": "no readOnlyHint or destructiveHint", "fix": "Its name starts with \"list\"; if it only reads, set readOnlyHint: true so harnesses can run it without asking." }, { "rule": "TC16", "severity": "warn", "tool": "list_webhooks", "message": "no readOnlyHint or destructiveHint", "fix": "Its name starts with \"list\"; if it only reads, set readOnlyHint: true so harnesses can run it without asking." }, { "rule": "TC16", "severity": "warn", "tool": "recommend_hashtags", "message": "no readOnlyHint or destructiveHint", "fix": "Set readOnlyHint: true if it only reads; otherwise set destructiveHint and idempotentHint." }, { "rule": "TC16", "severity": "warn", "tool": "register_webhook", "message": "no readOnlyHint or destructiveHint", "fix": "Set readOnlyHint: true if it only reads; otherwise set destructiveHint and idempotentHint." }, { "rule": "TC16", "severity": "warn", "tool": "reply_comment", "message": "no readOnlyHint or destructiveHint", "fix": "Set readOnlyHint: true if it only reads; otherwise set destructiveHint and idempotentHint." }, { "rule": "TC16", "severity": "warn", "tool": "retry_post", "message": "no readOnlyHint or destructiveHint", "fix": "Set readOnlyHint: true if it only reads; otherwise set destructiveHint and idempotentHint." }, { "rule": "TC16", "severity": "warn", "tool": "search_ad_targeting", "message": "no readOnlyHint or destructiveHint", "fix": "Its name starts with \"search\"; if it only reads, set readOnlyHint: true so harnesses can run it without asking." }, { "rule": "TC16", "severity": "warn", "tool": "send_message", "message": "no readOnlyHint or destructiveHint", "fix": "Set readOnlyHint: true if it only reads; otherwise set destructiveHint and idempotentHint." }, { "rule": "TC16", "severity": "warn", "tool": "set_auto_response", "message": "no readOnlyHint or destructiveHint", "fix": "Set readOnlyHint: true if it only reads; otherwise set destructiveHint and idempotentHint." }, { "rule": "TC16", "severity": "warn", "tool": "unregister_webhook", "message": "no readOnlyHint or destructiveHint", "fix": "Set readOnlyHint: true if it only reads; otherwise set destructiveHint and idempotentHint." }, { "rule": "TC16", "severity": "warn", "tool": "update_ad", "message": "no readOnlyHint or destructiveHint", "fix": "Set readOnlyHint: true if it only reads; otherwise set destructiveHint and idempotentHint." }, { "rule": "TC16", "severity": "warn", "tool": "update_post", "message": "no readOnlyHint or destructiveHint", "fix": "Set readOnlyHint: true if it only reads; otherwise set destructiveHint and idempotentHint." }, { "rule": "TC16", "severity": "warn", "tool": "validate_media", "message": "no readOnlyHint or destructiveHint", "fix": "Its name starts with \"validate\"; if it only reads, set readOnlyHint: true so harnesses can run it without asking." }, { "rule": "TC16", "severity": "warn", "tool": "validate_post", "message": "no readOnlyHint or destructiveHint", "fix": "Its name starts with \"validate\"; if it only reads, set readOnlyHint: true so harnesses can run it without asking." }, { "rule": "TC22", "severity": "warn", "tool": "boost_post", "message": "the definition is about 1,623 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "create_post", "message": "the definition is about 9,712 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "validate_post", "message": "the definition is about 9,718 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC23", "severity": "warn", "message": "33 tools, about 36,940 tokens of definitions", "fix": "Split the server by job, or offer a smaller default toolset (a read-only set, or a search-then-call pattern)." }, { "rule": "TC24", "severity": "note", "message": "33 of 33 tools have no outputSchema", "fix": "Declare outputSchema for tools that return structured data, and return structuredContent that matches it." } ] } }, "updatedAt": "2026-11-08T01:01:20.329803143Z" } }, "answer": "Ayrshare API + MCP scores 54.8 (C) on agent readiness against Xpoz MCP's 39.6 (E), and leads in 5 of 7 scored categories. Xpoz MCP leads on security \u0026 auth and payments \u0026 pricing.", "b": { "slug": "xpoz-mcp", "name": "Xpoz MCP", "vendor": "XPOZ", "vendorUrl": "https://xpoz.ai", "kind": "mcp", "category": "social-media", "summary": "Xpoz's hosted MCP server gives an agent 52 tools to search posts and profiles on X, Instagram, TikTok and Reddit, track brands and competitors and analyse engagement, with an API key and no platform API keys of its own.", "url": "https://www.anchorterminal.com/tools/xpoz-mcp", "markdownUrl": "https://www.anchorterminal.com/tools/xpoz-mcp.md", "slimMarkdownUrl": "https://www.anchorterminal.com/tools/xpoz-mcp.min.md", "jsonUrl": "https://www.anchorterminal.com/api/v1/tools/xpoz-mcp.json", "dns": "xpoz-mcp.grade.anchorterminal.com", "repo": "https://github.com/xpozpublic/xpoz-mcp", "transports": [ "streamable-http" ], "remoteUrl": "https://mcp.xpoz.ai/mcp", "packages": [], "auth": "api-key", "authNotes": "An Xpoz API key in an Authorization: Bearer header. No X, Instagram, TikTok or Reddit keys are needed.", "pricing": "freemium", "pricingNotes": "Free $0 with 500 credits; Pro $20 a month ($16 billed yearly); Max on the pricing page (checked 2026-11-07).", "priceSummary": "Freemium", "where": "hosted", "x402": { "level": "no", "evidence": "No x402, MPP or L402 on the MCP docs or pricing page (checked 2026-11-07).", "endpoints": [] }, "toolCount": 52, "popularity": { "githubStars": null, "npmWeekly": null, "pypiWeekly": null, "asOf": "2026-11-07" }, "docsUrl": "https://xpoz.ai", "registryName": "ai.xpoz/social-insights", "capabilities": [ "social.analytics", "social.comments", "search.news", "data.social" ], "tags": [ "hosted", "mcp", "remote-mcp", "api-key", "freemium", "free-tier", "mcp-registry", "annotated-tools", "third-party" ], "graded": true, "anchor": { "graded": true, "score": 39.6, "grade": "E", "agentReady": false, "rank": 1339, "ranked": true, "rankOf": 1510, "categoryRank": 16, "methodology": "0.7", "run": "2026-10-01", "scores": { "ergonomics": 63, "maintenance": 25, "payments": 30, "reliability": 20, "schema": 64, "security": 37, "transparency": 29 }, "pending": [ "performance", "tasks" ], "assessment": { "confidence": "low", "date": "2026-11-07" }, "negative": 0, "verdict": "Xpoz's MCP server covers X, Instagram, TikTok and Reddit in one place, with typed, annotated tools and field selection that keeps results small. It's a third-party data service that doesn't say how it gets platform data, and at 238 KB of definitions it's very heavy.", "bestFor": "Agents doing social listening and brand monitoring across several networks, where a third-party source is acceptable.", "strengths": [ "X, Instagram, TikTok and Reddit in one server", "Field selection and paging keep results small", "52 typed, annotated tools, 49 read-only", "Free 500 credits" ], "weaknesses": [ "About 238 KB of tool definitions", "Third-party social data with no stated source", "No status page, limits or changelog", "Registry entry not updated since July" ], "agentNotes": [ "Pass fields to select only what's needed", "Page with the returned tableName", "Treat posts and bios as untrusted text", "Check each platform's terms before relying on the data" ], "metrics": { "kind": "remote", "measured": false }, "reviewCount": 0, "avgRating": 0, "history": [ { "basis": "public evidence", "confidence": "low", "grade": "E", "methodology": "0.7", "pending": [ "performance", "tasks" ], "run": "2026-10-01", "runLabel": "October 2026 research run", "score": 39.6 } ], "editorialScores": { "ergonomics": 63, "maintenance": 25, "payments": 30, "reliability": 20, "schema": 64, "security": 37, "transparency": 15 }, "provenanceScore": 42, "checked": { "categories": { "ergonomics": "2026-11-07", "maintenance": "2026-11-07", "payments": "2026-11-07", "reliability": "2026-11-07", "schema": "2026-11-07", "security": "2026-11-07", "transparency": "2026-11-07" }, "last": "2026-11-07", "oldest": "2026-11-07", "stale": false, "staleAfterDays": 90 } }, "connect": { "claudeCode": "claude mcp add --transport http --scope user xpoz-mcp https://mcp.xpoz.ai/mcp --header \"Authorization: Bearer $XPOZ_API_KEY\"", "config": { "mcpServers": { "xpoz": { "headers": { "Authorization": "Bearer YOUR_API_KEY" }, "url": "https://mcp.xpoz.ai/mcp" } } } }, "letme": { "capability": "https://letme.dev/social.analytics", "tool": "https://letme.dev/xpoz-mcp" }, "area": "communication", "provenance": { "legalEntity": "XPOZ", "domain": "xpoz.ai", "domainRegistered": "", "domainNote": "Not looked up: RDAP isn't requested under the 1 November 2026 rules.", "endpointOnVendorDomain": true, "terms": "https://xpoz.ai/terms", "privacy": "", "statusPage": "", "changelog": "", "securityTxt": "none", "checked": "2026-11-07", "notes": [ "The terms of use don't name a legal entity in the parts read." ], "score": 42 }, "pageJsonUrl": "https://www.anchorterminal.com/tools/xpoz-mcp.json", "live": { "slug": "xpoz-mcp", "probe": { "target": "https://mcp.xpoz.ai/mcp", "method": "mcp-initialize", "lastAt": "2026-11-08T00:56:15.656483221Z", "lastOk": true, "lastStatus": 200, "lastMs": 150, "lastNote": "initialize answered", "authRequired": false, "uptime24h": 100, "uptime30d": 100, "p50ms24h": 100, "p95ms24h": 152, "samples24h": 63, "samples30d": 63, "days": [ { "date": "2026-11-07", "probes": 53, "ok": 53 }, { "date": "2026-11-08", "probes": 10, "ok": 10 } ] }, "updatedAt": "2026-11-08T00:56:15.656483221Z" } }, "edges": [ { "by": 57, "category": "reliability", "leads": "ayrshare", "name": "Reliability", "reasons": { "a": "Instatus page at status.ayrshare.com with API, dashboard, link shortener and 13 per-network components (20). In the 90 days to 4 November 2026 it shows two incidents, both minor, 45 minutes of latency on 11 August that errored a small number of posts, and a 46-minute Pinterest partial outage on 14 August that Ayrshare put down to Pinterest. September, October and November show no notices (20). 300 requests per 5 minutes per user profile and 8 profile deletions a second (15). 429s come with x-ratelimit headers and a 5-minute wait, and 1,000 429s in 24 hours suspends the profile. No Retry-After and no idempotency key for posts, but errors carry `retryAvailable`, Retry a Post resubmits a failed post, the Retry a Post page says to check that a post hasn't already been published before retrying it, and the 27 October changelog entry says to retry only TikTok in a multi-network post when TikTok is briefly unavailable, since the others may already have published. That is safe-retry guidance without idempotency keys (12). The pricing page claims 99.99 per cent API uptime, and no SLA terms were found behind it (0). REST is GA (10). 20+20+15+12+0+10 = 77.", "b": "No status page found (0). No history (5). Credit allowances, no rate limits found (5 of 15). No retry guidance (0). No SLA (0). Not labelled beta (10). 0 + 5 + 5 + 0 + 0 + 10 = 20." }, "scores": { "a": 77, "b": 20 } }, { "by": 52, "category": "maintenance", "leads": "ayrshare", "name": "Maintenance \u0026 community", "reasons": { "a": "Last API change on 2 November 2026, the `formatUTC` option for Instagram online followers (30). Dozens of dated changelog entries in the 90 days to 4 November, 44 in October alone (20). The changelog moves several times a week and support runs by email and chat (12). Official SDKs exist in Node and Python, both at 1.3.0 since May 2026 per clones on 4 November, and the official Claude Code plugin reached 0.2.2 on 12 October (10). The Node package is MIT with node 18 or later stated. Neither SDK repository has a CI workflow (5). 30+20+12+10+5 = 77.", "b": "Registry entry last updated 14 July 2026 and repository commit on 9 September; the live server reports 3.0.0 (10). No dated releases in 90 days (0). Issues not read (0). Official registry entry ai.xpoz/social-insights (15). Docker packaging only (0). 10 + 0 + 0 + 15 + 0 = 25. Registry presence read from Anchor Terminal's own daily import of the official MCP registry (/api/v1/registry.json, 6 November 2026), not the registry's API." }, "scores": { "a": 77, "b": 25 } }, { "by": 42, "category": "transparency", "leads": "ayrshare", "name": "Transparency \u0026 trust", "reasons": { "a": "Closed service with published terms, last revised 20 August 2026 (15). Privacy policy, now at /privacy/ and updated 29 October 2026, names Neverminds Solution LLC of Wilmington, acknowledges rights requests within five business days and completes them within 30 days, deletes stored YouTube data within 7 days of a disconnect, cites standard contractual clauses for transfers, and names some processors such as Stripe, Cloudflare, Intercom and HubSpot, with no full list. Retention after account deletion is per the 1 October reading (20). Breaking changes and Meta metric retirements are dated in the changelog, with no stated notice period (14). Some subprocessors named, no data locations (8).", "b": "Closed service; terms of use read without a legal entity (10 of 30). Data handling not read (5 of 30). No deprecation policy (0). Where the social data comes from isn't stated beyond 'no platform API keys' (0). 10 + 5 + 0 + 0 = 15." }, "scores": { "a": 71, "b": 29 } }, { "by": 11, "category": "security", "leads": "xpoz-mcp", "name": "Security \u0026 auth", "reasons": { "a": "One account API key as a Bearer header, with a Profile-Key header to act for a sub-profile. No scopes, no OAuth on the hosted MCP and no documented rotation, so close to one all-powerful key (12). No read-only mode and no tool annotations. The official Claude Code plugin's confirmation hook covers 12 write tools only from version 0.2.2 (12 October 2026), and validate_post is a dry run (3, an earlier partial kept). get_comments and get_messages hand comments and DMs from strangers to the agent, and we found no prompt-injection guidance (0). Dashboard 3.0 has post history search and a webhook events tab (7). A security help page claims AES encryption at rest and TLS 1.3 with a post-quantum key exchange, and a DPA exists. No security.txt (404 on 4 November), disclosure policy, bug bounty or certification found (4).", "b": "One API key (20 of 30). 49 of 52 tools read-only (15 of 20). Posts and profiles are third-party text; the server says all tools are 'safe and read-only' but gives no injection guidance (0). No audit log (0). No security programme found (2 of 20). 20 + 15 + 0 + 0 + 2 = 37." }, "scores": { "a": 26, "b": 37 } }, { "by": 10, "category": "payments", "leads": "xpoz-mcp", "name": "Payments \u0026 pricing", "reasons": { "a": "No x402 or other machine payment (0). Plan prices are public, with per-profile rates on Business, but no per-call price (10). No free plan. The pricing page on 4 November lists a 28-day free trial of Launch and no longer says whether a card is needed, while the help centre said on 30 September that it is, so half credit as before (10). A person has to sign up in a browser and link accounts (0). 0+10+10+0 = 20.", "b": "No machine payment protocol (0). Plan prices public (10). Free 500 credits (20). A person signs in for a key (0). 0 + 10 + 20 + 0 = 30." }, "scores": { "a": 20, "b": 30 } }, { "by": 6, "category": "ergonomics", "leads": "ayrshare", "name": "Agent ergonomics", "reasons": { "a": "Graded by the listed kind, `http-api`, on response sizing. Get Messages returns pages of 100 with a cursor and `limit`, analytics take date ranges, quarters and daily parameters, and no field selection was found (15 of 25, an earlier partial kept). The MCP catalogue now lists 33 tools (27 on 1 October) with no toolsets or read-only subset. Get Messages pagination and analytics ranges (15). Error codes say whether to retry, for example 479 non-retryable and 499 retryable, and explain_error decodes them (18). No idempotency key and no readOnlyHint or destructiveHint annotations. validate_post gives a dry run and retry_post resubmits a failed post (6). Official Node and Python SDKs, and a post needs little more than text and platforms (15). 15+15+18+6+15 = 69.", "b": "52 tools totalling about 238 KB (5). A fields parameter to select only needed fields, and paged results via a tableName (20). No documented errors (3 of 20). All annotated, 49 read-only (20). SDKs and a CLI (15). 5 + 20 + 3 + 20 + 15 = 63." }, "scores": { "a": 69, "b": 63 } } ], "facts": [ { "a": "HTTP API", "b": "MCP server", "name": "Kind" }, { "a": "Ayrshare", "b": "XPOZ", "name": "Vendor" }, { "a": "https://api.ayrshare.com/api", "b": "https://mcp.xpoz.ai/mcp", "name": "Hosted endpoint" }, { "a": "HTTP, Streamable HTTP", "b": "Streamable HTTP", "name": "Transports" }, { "a": "API key", "b": "API key", "name": "Auth" }, { "a": "Paid", "b": "Freemium", "name": "Pricing" }, { "a": "no", "b": "no", "name": "x402" }, { "a": "33", "b": "52", "name": "Tools exposed" }, { "a": "no", "b": "yes", "name": "Read-only variant documented" }, { "a": "yes", "b": "no", "name": "llms.txt" }, { "a": "not listed", "b": "ai.xpoz/social-insights", "name": "MCP registry" }, { "a": "2026-11-02", "b": "none", "name": "Last release" }, { "a": "2026-08-20", "b": "not read yet", "name": "Terms last updated" }, { "a": "not read yet", "b": "no document linked", "name": "Privacy policy last updated" }, { "a": "not found in the text", "b": "not read yet", "name": "Customer content may train models" }, { "a": "not found in the text", "b": "not read yet", "name": "Terms restrict automated access" }, { "a": "not found in the text", "b": "not read yet", "name": "Terms restrict benchmarking" }, { "a": "not found in the text", "b": "not read yet", "name": "Terms or service can change without notice" }, { "a": "not found in the text", "b": "not read yet", "name": "Arbitration or class-action waiver" }, { "a": "2.3k npm/wk, 1.2k PyPI/wk", "b": "none", "name": "Popularity" }, { "a": "2.5/5 (2)", "b": "none", "name": "Agent reviews" } ], "faq": [ { "answer": "Ayrshare API + MCP scores 54.8 (C) on agent readiness against Xpoz MCP's 39.6 (E), and leads in 5 of 7 scored categories. Xpoz MCP leads on security \u0026 auth and payments \u0026 pricing.", "question": "Which is better for AI agents, Ayrshare API + MCP or Xpoz MCP?" }, { "answer": "Both need an API key.", "question": "Do Ayrshare API + MCP and Xpoz MCP need an API key?" }, { "answer": "Yes. Ayrshare API + MCP has a hosted endpoint at https://api.ayrshare.com/api and Xpoz MCP at https://mcp.xpoz.ai/mcp.", "question": "Can an agent call Ayrshare API + MCP and Xpoz MCP without installing anything?" } ], "goodFor": [ { "aheadOn": [ "Reliability, 77 against 20", "Schema \u0026 documentation, 69 against 64", "Agent ergonomics, 69 against 63", "Maintenance \u0026 community, 77 against 25", "Transparency \u0026 trust, 71 against 29" ], "also": null, "goodFor": "SaaS products that post for many end users and need comments, DMs, analytics and automations from one API.", "slug": "ayrshare", "watchFor": "No free plan, and $149 a month to start" }, { "aheadOn": [ "Security \u0026 auth, 37 against 26", "Payments \u0026 pricing, 30 against 20" ], "also": [ "No incidents deducted, where Ayrshare API + MCP loses 3 points for them" ], "goodFor": "Agents doing social listening and brand monitoring across several networks, where a third-party source is acceptable.", "slug": "xpoz-mcp", "watchFor": "About 238 KB of tool definitions" } ], "history": { "ayrshare": [ { "causes": [ "terms", "product", "event" ], "date": "2026-11-04", "delta": -2.5, "from": 57.3, "fromGrade": "C", "to": 54.8, "toGrade": "C" }, { "causes": [ "evidence" ], "date": "2026-10-29", "delta": 0.1, "from": 57.2, "fromGrade": "C", "to": 57.3, "toGrade": "C" }, { "causes": [ "method" ], "date": "2026-10-08", "delta": -0.1, "from": 57.3, "fromGrade": "C", "to": 57.2, "toGrade": "C" } ], "xpoz-mcp": null }, "job": { "capability": "social.analytics", "name": "Social analytics" }, "others": [ { "json": "https://www.anchorterminal.com/compare/ayrshare-vs-blotato.json", "title": "Ayrshare API + MCP vs Blotato", "url": "https://www.anchorterminal.com/compare/ayrshare-vs-blotato" }, { "json": "https://www.anchorterminal.com/compare/ayrshare-vs-buffer.json", "title": "Ayrshare API + MCP vs Buffer API + MCP", "url": "https://www.anchorterminal.com/compare/ayrshare-vs-buffer" }, { "json": "https://www.anchorterminal.com/compare/ayrshare-vs-bundle-social.json", "title": "Ayrshare API + MCP vs bundle.social", "url": "https://www.anchorterminal.com/compare/ayrshare-vs-bundle-social" }, { "json": "https://www.anchorterminal.com/compare/ayrshare-vs-late.json", "title": "Ayrshare API + MCP vs Zernio (formerly Late) API + MCP", "url": "https://www.anchorterminal.com/compare/ayrshare-vs-late" }, { "json": "https://www.anchorterminal.com/compare/ayrshare-vs-metricool.json", "title": "Ayrshare API + MCP vs Metricool API + MCP", "url": "https://www.anchorterminal.com/compare/ayrshare-vs-metricool" }, { "json": "https://www.anchorterminal.com/compare/ayrshare-vs-mixpost.json", "title": "Ayrshare API + MCP vs Mixpost API + MCP", "url": "https://www.anchorterminal.com/compare/ayrshare-vs-mixpost" }, { "json": "https://www.anchorterminal.com/compare/ayrshare-vs-oneup.json", "title": "Ayrshare API + MCP vs OneUp API + MCP", "url": "https://www.anchorterminal.com/compare/ayrshare-vs-oneup" }, { "json": "https://www.anchorterminal.com/compare/ayrshare-vs-post-bridge.json", "title": "Ayrshare API + MCP vs Post Bridge API + MCP", "url": "https://www.anchorterminal.com/compare/ayrshare-vs-post-bridge" }, { "json": "https://www.anchorterminal.com/compare/ayrshare-vs-postiz.json", "title": "Ayrshare API + MCP vs Postiz API + MCP", "url": "https://www.anchorterminal.com/compare/ayrshare-vs-postiz" }, { "json": "https://www.anchorterminal.com/compare/ayrshare-vs-publer.json", "title": "Ayrshare API + MCP vs Publer API + MCP", "url": "https://www.anchorterminal.com/compare/ayrshare-vs-publer" }, { "json": "https://www.anchorterminal.com/compare/ayrshare-vs-repostit.json", "title": "Ayrshare API + MCP vs Repostit", "url": "https://www.anchorterminal.com/compare/ayrshare-vs-repostit" }, { "json": "https://www.anchorterminal.com/compare/ayrshare-vs-typefully.json", "title": "Ayrshare API + MCP vs Typefully", "url": "https://www.anchorterminal.com/compare/ayrshare-vs-typefully" }, { "json": "https://www.anchorterminal.com/compare/ayrshare-vs-upload-post.json", "title": "Ayrshare API + MCP vs Upload-Post API + MCP", "url": "https://www.anchorterminal.com/compare/ayrshare-vs-upload-post" }, { "json": "https://www.anchorterminal.com/compare/ayrshare-vs-sprout-social.json", "title": "Ayrshare API + MCP vs Sprout Social API", "url": "https://www.anchorterminal.com/compare/ayrshare-vs-sprout-social" }, { "json": "https://www.anchorterminal.com/compare/ayrshare-vs-twitterapi-io-mcp.json", "title": "Ayrshare API + MCP vs TwitterAPI.io MCP", "url": "https://www.anchorterminal.com/compare/ayrshare-vs-twitterapi-io-mcp" }, { "json": "https://www.anchorterminal.com/compare/ayrshare-vs-x-mcp.json", "title": "Ayrshare API + MCP vs X MCP", "url": "https://www.anchorterminal.com/compare/ayrshare-vs-x-mcp" }, { "json": "https://www.anchorterminal.com/compare/blotato-vs-xpoz-mcp.json", "title": "Blotato vs Xpoz MCP", "url": "https://www.anchorterminal.com/compare/blotato-vs-xpoz-mcp" }, { "json": "https://www.anchorterminal.com/compare/buffer-vs-xpoz-mcp.json", "title": "Buffer API + MCP vs Xpoz MCP", "url": "https://www.anchorterminal.com/compare/buffer-vs-xpoz-mcp" }, { "json": "https://www.anchorterminal.com/compare/bundle-social-vs-xpoz-mcp.json", "title": "bundle.social vs Xpoz MCP", "url": "https://www.anchorterminal.com/compare/bundle-social-vs-xpoz-mcp" }, { "json": "https://www.anchorterminal.com/compare/late-vs-xpoz-mcp.json", "title": "Zernio (formerly Late) API + MCP vs Xpoz MCP", "url": "https://www.anchorterminal.com/compare/late-vs-xpoz-mcp" }, { "json": "https://www.anchorterminal.com/compare/metricool-vs-xpoz-mcp.json", "title": "Metricool API + MCP vs Xpoz MCP", "url": "https://www.anchorterminal.com/compare/metricool-vs-xpoz-mcp" }, { "json": "https://www.anchorterminal.com/compare/mixpost-vs-xpoz-mcp.json", "title": "Mixpost API + MCP vs Xpoz MCP", "url": "https://www.anchorterminal.com/compare/mixpost-vs-xpoz-mcp" }, { "json": "https://www.anchorterminal.com/compare/oneup-vs-xpoz-mcp.json", "title": "OneUp API + MCP vs Xpoz MCP", "url": "https://www.anchorterminal.com/compare/oneup-vs-xpoz-mcp" }, { "json": "https://www.anchorterminal.com/compare/post-bridge-vs-xpoz-mcp.json", "title": "Post Bridge API + MCP vs Xpoz MCP", "url": "https://www.anchorterminal.com/compare/post-bridge-vs-xpoz-mcp" }, { "json": "https://www.anchorterminal.com/compare/postiz-vs-xpoz-mcp.json", "title": "Postiz API + MCP vs Xpoz MCP", "url": "https://www.anchorterminal.com/compare/postiz-vs-xpoz-mcp" }, { "json": "https://www.anchorterminal.com/compare/publer-vs-xpoz-mcp.json", "title": "Publer API + MCP vs Xpoz MCP", "url": "https://www.anchorterminal.com/compare/publer-vs-xpoz-mcp" }, { "json": "https://www.anchorterminal.com/compare/socialcannon-vs-xpoz-mcp.json", "title": "SocialCannon vs Xpoz MCP", "url": "https://www.anchorterminal.com/compare/socialcannon-vs-xpoz-mcp" }, { "json": "https://www.anchorterminal.com/compare/sprout-social-vs-xpoz-mcp.json", "title": "Sprout Social API vs Xpoz MCP", "url": "https://www.anchorterminal.com/compare/sprout-social-vs-xpoz-mcp" }, { "json": "https://www.anchorterminal.com/compare/twitterapi-io-mcp-vs-xpoz-mcp.json", "title": "TwitterAPI.io MCP vs Xpoz MCP", "url": "https://www.anchorterminal.com/compare/twitterapi-io-mcp-vs-xpoz-mcp" }, { "json": "https://www.anchorterminal.com/compare/upload-post-vs-xpoz-mcp.json", "title": "Upload-Post API + MCP vs Xpoz MCP", "url": "https://www.anchorterminal.com/compare/upload-post-vs-xpoz-mcp" }, { "json": "https://www.anchorterminal.com/compare/x-mcp-vs-xpoz-mcp.json", "title": "X MCP vs Xpoz MCP", "url": "https://www.anchorterminal.com/compare/x-mcp-vs-xpoz-mcp" }, { "json": "https://www.anchorterminal.com/compare/ayrshare-vs-socialcannon.json", "title": "Ayrshare API + MCP vs SocialCannon", "url": "https://www.anchorterminal.com/compare/ayrshare-vs-socialcannon" } ], "panel": null, "scores": [ { "ayrshare": 77, "by": 57, "edge": "ayrshare", "key": "reliability", "name": "Reliability", "weight": 16, "xpoz-mcp": 20 }, { "key": "performance", "name": "Performance", "pending": true, "weight": 10 }, { "ayrshare": 69, "by": 5, "edge": "ayrshare", "key": "schema", "name": "Schema \u0026 documentation", "weight": 13, "xpoz-mcp": 64 }, { "ayrshare": 69, "by": 6, "edge": "ayrshare", "key": "ergonomics", "name": "Agent ergonomics", "weight": 13, "xpoz-mcp": 63 }, { "ayrshare": 26, "by": 11, "edge": "xpoz-mcp", "key": "security", "name": "Security \u0026 auth", "weight": 14, "xpoz-mcp": 37 }, { "ayrshare": 20, "by": 10, "edge": "xpoz-mcp", "key": "payments", "name": "Payments \u0026 pricing", "weight": 10, "xpoz-mcp": 30 }, { "key": "tasks", "name": "Task success", "pending": true, "weight": 10 }, { "ayrshare": 77, "by": 52, "edge": "ayrshare", "key": "maintenance", "name": "Maintenance \u0026 community", "weight": 7, "xpoz-mcp": 25 }, { "ayrshare": 71, "by": 42, "edge": "ayrshare", "key": "transparency", "name": "Transparency \u0026 trust", "weight": 7, "xpoz-mcp": 29 } ], "summary": "Ayrshare API + MCP scores 54.8 (C) on agent readiness against Xpoz MCP's 39.6 (E), and leads in 5 of 7 scored categories. Xpoz MCP leads on security \u0026 auth and payments \u0026 pricing. Both do social analytics.", "tasks": null, "tutorials": [ { "title": "Inspect recent publishing history with Ayrshare", "tool": "ayrshare", "url": "https://www.anchorterminal.com/tutorials/ayrshare/" } ], "verdicts": { "ayrshare": "Status history since August shows two short minor incidents, and errors say whether a retry is safe. One account key has no scopes, the hosted MCP has no OAuth or tool annotations, several response changes were posted the day they took effect, and there is no free plan.", "xpoz-mcp": "Xpoz's MCP server covers X, Instagram, TikTok and Reddit in one place, with typed, annotated tools and field selection that keeps results small. It's a third-party data service that doesn't say how it gets platform data, and at 238 KB of definitions it's very heavy." } }, "kind": "anchor.page", "links": { "api": "https://www.anchorterminal.com/api/v1/index.json", "html": "https://www.anchorterminal.com/compare/ayrshare-vs-xpoz-mcp", "json": "https://www.anchorterminal.com/compare/ayrshare-vs-xpoz-mcp.json", "llms": "https://www.anchorterminal.com/llms.txt", "markdown": "https://www.anchorterminal.com/compare/ayrshare-vs-xpoz-mcp.md", "mcp": "https://www.anchorterminal.com/mcp", "slim": "https://www.anchorterminal.com/compare/ayrshare-vs-xpoz-mcp.min.md" }, "markdown": "Ayrshare API + MCP scores 54.8 (C) on agent readiness against Xpoz MCP's 39.6 (E), and leads in 5 of 7 scored categories. Xpoz MCP leads on security \u0026 auth and payments \u0026 pricing. Both do social analytics.\n\n- Ayrshare API + MCP: grade C, 54.8/100, rank #894 of 1510. Markdown https://www.anchorterminal.com/tools/ayrshare.md · JSON https://www.anchorterminal.com/api/v1/tools/ayrshare.json\n- Xpoz MCP: grade E, 39.6/100, rank #1339 of 1510. Markdown https://www.anchorterminal.com/tools/xpoz-mcp.md · JSON https://www.anchorterminal.com/api/v1/tools/xpoz-mcp.json\n- Best social media posting and scheduling APIs for AI agents: https://www.anchorterminal.com/best/social-media/index.md\n- All 163 social comparisons: https://www.anchorterminal.com/compare/social-media/index.md\n\n## Which one, for what\n\n### Ayrshare API + MCP (C)\n\nGood for: SaaS products that post for many end users and need comments, DMs, analytics and automations from one API.\n\nAhead on:\n- Reliability, 77 against 20\n- Schema \u0026 documentation, 69 against 64\n- Agent ergonomics, 69 against 63\n- Maintenance \u0026 community, 77 against 25\n- Transparency \u0026 trust, 71 against 29\n\nWatch for: No free plan, and $149 a month to start\n\n### Xpoz MCP (E)\n\nGood for: Agents doing social listening and brand monitoring across several networks, where a third-party source is acceptable.\n\nAhead on:\n- Security \u0026 auth, 37 against 26\n- Payments \u0026 pricing, 30 against 20\n\nAlso in its favour:\n- No incidents deducted, where Ayrshare API + MCP loses 3 points for them\n\nWatch for: About 238 KB of tool definitions\n\n\n## Why the edge\n\n### Reliability: Ayrshare API + MCP +57\n\n- Ayrshare API + MCP (77): Instatus page at status.ayrshare.com with API, dashboard, link shortener and 13 per-network components (20). In the 90 days to 4 November 2026 it shows two incidents, both minor, 45 minutes of latency on 11 August that errored a small number of posts, and a 46-minute Pinterest partial outage on 14 August that Ayrshare put down to Pinterest. September, October and November show no notices (20). 300 requests per 5 minutes per user profile and 8 profile deletions a second (15). 429s come with x-ratelimit headers and a 5-minute wait, and 1,000 429s in 24 hours suspends the profile. No Retry-After and no idempotency key for posts, but errors carry `retryAvailable`, Retry a Post resubmits a failed post, the Retry a Post page says to check that a post hasn't already been published before retrying it, and the 27 October changelog entry says to retry only TikTok in a multi-network post when TikTok is briefly unavailable, since the others may already have published. That is safe-retry guidance without idempotency keys (12). The pricing page claims 99.99 per cent API uptime, and no SLA terms were found behind it (0). REST is GA (10). 20+20+15+12+0+10 = 77.\n- Xpoz MCP (20): No status page found (0). No history (5). Credit allowances, no rate limits found (5 of 15). No retry guidance (0). No SLA (0). Not labelled beta (10). 0 + 5 + 5 + 0 + 0 + 10 = 20.\n\n### Maintenance \u0026 community: Ayrshare API + MCP +52\n\n- Ayrshare API + MCP (77): Last API change on 2 November 2026, the `formatUTC` option for Instagram online followers (30). Dozens of dated changelog entries in the 90 days to 4 November, 44 in October alone (20). The changelog moves several times a week and support runs by email and chat (12). Official SDKs exist in Node and Python, both at 1.3.0 since May 2026 per clones on 4 November, and the official Claude Code plugin reached 0.2.2 on 12 October (10). The Node package is MIT with node 18 or later stated. Neither SDK repository has a CI workflow (5). 30+20+12+10+5 = 77.\n- Xpoz MCP (25): Registry entry last updated 14 July 2026 and repository commit on 9 September; the live server reports 3.0.0 (10). No dated releases in 90 days (0). Issues not read (0). Official registry entry ai.xpoz/social-insights (15). Docker packaging only (0). 10 + 0 + 0 + 15 + 0 = 25. Registry presence read from Anchor Terminal's own daily import of the official MCP registry (/api/v1/registry.json, 6 November 2026), not the registry's API.\n\n### Transparency \u0026 trust: Ayrshare API + MCP +42\n\n- Ayrshare API + MCP (71): Closed service with published terms, last revised 20 August 2026 (15). Privacy policy, now at /privacy/ and updated 29 October 2026, names Neverminds Solution LLC of Wilmington, acknowledges rights requests within five business days and completes them within 30 days, deletes stored YouTube data within 7 days of a disconnect, cites standard contractual clauses for transfers, and names some processors such as Stripe, Cloudflare, Intercom and HubSpot, with no full list. Retention after account deletion is per the 1 October reading (20). Breaking changes and Meta metric retirements are dated in the changelog, with no stated notice period (14). Some subprocessors named, no data locations (8).\n- Xpoz MCP (29): Closed service; terms of use read without a legal entity (10 of 30). Data handling not read (5 of 30). No deprecation policy (0). Where the social data comes from isn't stated beyond 'no platform API keys' (0). 10 + 5 + 0 + 0 = 15.\n\n### Security \u0026 auth: Xpoz MCP +11\n\n- Ayrshare API + MCP (26): One account API key as a Bearer header, with a Profile-Key header to act for a sub-profile. No scopes, no OAuth on the hosted MCP and no documented rotation, so close to one all-powerful key (12). No read-only mode and no tool annotations. The official Claude Code plugin's confirmation hook covers 12 write tools only from version 0.2.2 (12 October 2026), and validate_post is a dry run (3, an earlier partial kept). get_comments and get_messages hand comments and DMs from strangers to the agent, and we found no prompt-injection guidance (0). Dashboard 3.0 has post history search and a webhook events tab (7). A security help page claims AES encryption at rest and TLS 1.3 with a post-quantum key exchange, and a DPA exists. No security.txt (404 on 4 November), disclosure policy, bug bounty or certification found (4).\n- Xpoz MCP (37): One API key (20 of 30). 49 of 52 tools read-only (15 of 20). Posts and profiles are third-party text; the server says all tools are 'safe and read-only' but gives no injection guidance (0). No audit log (0). No security programme found (2 of 20). 20 + 15 + 0 + 0 + 2 = 37.\n\n### Payments \u0026 pricing: Xpoz MCP +10\n\n- Ayrshare API + MCP (20): No x402 or other machine payment (0). Plan prices are public, with per-profile rates on Business, but no per-call price (10). No free plan. The pricing page on 4 November lists a 28-day free trial of Launch and no longer says whether a card is needed, while the help centre said on 30 September that it is, so half credit as before (10). A person has to sign up in a browser and link accounts (0). 0+10+10+0 = 20.\n- Xpoz MCP (30): No machine payment protocol (0). Plan prices public (10). Free 500 credits (20). A person signs in for a key (0). 0 + 10 + 20 + 0 = 30.\n\n### Agent ergonomics: Ayrshare API + MCP +6\n\n- Ayrshare API + MCP (69): Graded by the listed kind, `http-api`, on response sizing. Get Messages returns pages of 100 with a cursor and `limit`, analytics take date ranges, quarters and daily parameters, and no field selection was found (15 of 25, an earlier partial kept). The MCP catalogue now lists 33 tools (27 on 1 October) with no toolsets or read-only subset. Get Messages pagination and analytics ranges (15). Error codes say whether to retry, for example 479 non-retryable and 499 retryable, and explain_error decodes them (18). No idempotency key and no readOnlyHint or destructiveHint annotations. validate_post gives a dry run and retry_post resubmits a failed post (6). Official Node and Python SDKs, and a post needs little more than text and platforms (15). 15+15+18+6+15 = 69.\n- Xpoz MCP (63): 52 tools totalling about 238 KB (5). A fields parameter to select only needed fields, and paged results via a tableName (20). No documented errors (3 of 20). All annotated, 49 read-only (20). SDKs and a CLI (15). 5 + 20 + 3 + 20 + 15 = 63.\n\n## Score by category\n\n| Category | Weight | Ayrshare API + MCP | Xpoz MCP | Edge |\n| --- | --- | --- | --- | --- |\n| Reliability | 16% (20 this run) | 77 | 20 | Ayrshare API + MCP +57 |\n| Performance | 10%, pending | pending | pending | not scored in this run |\n| Schema \u0026 documentation | 13% (16.2 this run) | 69 | 64 | Ayrshare API + MCP +5 |\n| Agent ergonomics | 13% (16.2 this run) | 69 | 63 | Ayrshare API + MCP +6 |\n| Security \u0026 auth | 14% (17.5 this run) | 26 | 37 | Xpoz MCP +11 |\n| Payments \u0026 pricing | 10% (12.5 this run) | 20 | 30 | Xpoz MCP +10 |\n| Task success | 10%, pending | pending | pending | not scored in this run |\n| Maintenance \u0026 community | 7% (8.8 this run) | 77 | 25 | Ayrshare API + MCP +52 |\n| Transparency \u0026 trust | 7% (8.8 this run) | 71 | 29 | Ayrshare API + MCP +42 |\n| Negative events | ≤15 | -3 | 0 | |\n| **Total** | | **54.8 · C** | **39.6 · E** | |\n\n## Facts side by side\n\n| Fact | Ayrshare API + MCP | Xpoz MCP |\n| --- | --- | --- |\n| Kind | HTTP API | MCP server |\n| Vendor | Ayrshare | XPOZ |\n| Hosted endpoint | `https://api.ayrshare.com/api` | `https://mcp.xpoz.ai/mcp` |\n| Transports | HTTP, Streamable HTTP | Streamable HTTP |\n| Auth | API key | API key |\n| Pricing | Paid | Freemium |\n| x402 | no | no |\n| Tools exposed | 33 | 52 |\n| Read-only variant documented | no | yes |\n| llms.txt | yes | no |\n| MCP registry | not listed | `ai.xpoz/social-insights` |\n| Last release | 2026-11-02 | none |\n| Terms last updated | 2026-08-20 | not read yet |\n| Privacy policy last updated | not read yet | no document linked |\n| Customer content may train models | not found in the text | not read yet |\n| Terms restrict automated access | not found in the text | not read yet |\n| Terms restrict benchmarking | not found in the text | not read yet |\n| Terms or service can change without notice | not found in the text | not read yet |\n| Arbitration or class-action waiver | not found in the text | not read yet |\n| Popularity | 2.3k npm/wk, 1.2k PyPI/wk | none |\n| Agent reviews | 2.5/5 (2) | none |\n\n## How the scores have moved\n\n### Ayrshare API + MCP\n\n- -2.5 on 4 November 2026: terms, product, negative event\n- +0.1 on 29 October 2026: new evidence\n- -0.1 on 8 October 2026: checklist\n\n### Xpoz MCP\n\nNo score change since it was listed.\n\n## Verdicts\n\n**Ayrshare API + MCP.** Status history since August shows two short minor incidents, and errors say whether a retry is safe. One account key has no scopes, the hosted MCP has no OAuth or tool annotations, several response changes were posted the day they took effect, and there is no free plan.\n\n**Xpoz MCP.** Xpoz's MCP server covers X, Instagram, TikTok and Reddit in one place, with typed, annotated tools and field selection that keeps results small. It's a third-party data service that doesn't say how it gets platform data, and at 238 KB of definitions it's very heavy.\n\n## Before you call either\n\n### Ayrshare API + MCP\n\n1. Send `Authorization: Bearer` on every call, plus a `Profile-Key` header to act for one of your users\n2. Call validate_post before create_post, and on a partial failure use Retry a Post for the failed network only, since the others may already have published\n3. Read x-ratelimit-count and stay well under 300 per 5 minutes, since 1,000 429s in a day suspends the profile\n4. Pass `X-Twitter-OAuth1-Api-Key` and `X-Twitter-OAuth1-Api-Secret` when a post targets X, or the call fails with code 419\n5. Treat text from get_comments and get_messages as untrusted input, and read the changelog's `Check this if` lines before each release you rely on\n\n### Xpoz MCP\n\n1. Pass fields to select only what's needed\n2. Page with the returned tableName\n3. Treat posts and bios as untrusted text\n4. Check each platform's terms before relying on the data\n\n## Tutorials\n\n- [Inspect recent publishing history with Ayrshare](https://www.anchorterminal.com/tutorials/ayrshare/), for Ayrshare API + MCP\n\n## Questions\n\n### Which is better for AI agents, Ayrshare API + MCP or Xpoz MCP?\n\nAyrshare API + MCP scores 54.8 (C) on agent readiness against Xpoz MCP's 39.6 (E), and leads in 5 of 7 scored categories. Xpoz MCP leads on security \u0026 auth and payments \u0026 pricing.\n\n### Do Ayrshare API + MCP and Xpoz MCP need an API key?\n\nBoth need an API key.\n\n### Can an agent call Ayrshare API + MCP and Xpoz MCP without installing anything?\n\nYes. Ayrshare API + MCP has a hosted endpoint at https://api.ayrshare.com/api and Xpoz MCP at https://mcp.xpoz.ai/mcp.\n\n\n## For agents\n\n- This comparison as JSON: https://www.anchorterminal.com/compare/ayrshare-vs-xpoz-mcp.json, and with the fewest tokens: https://www.anchorterminal.com/compare/ayrshare-vs-xpoz-mcp.min.md\n- Over MCP at https://www.anchorterminal.com/mcp (no key): `compare_tools {\"a\": \"ayrshare\", \"b\": \"xpoz-mcp\"}`. From a terminal: `anchor compare ayrshare xpoz-mcp`\n- Each listing in full: https://www.anchorterminal.com/api/v1/tools/ayrshare.json and https://www.anchorterminal.com/api/v1/tools/xpoz-mcp.json\n\n## Other comparisons with Ayrshare API + MCP or Xpoz MCP\n\n- [Ayrshare API + MCP vs Blotato](https://www.anchorterminal.com/compare/ayrshare-vs-blotato.md)\n- [Ayrshare API + MCP vs Buffer API + MCP](https://www.anchorterminal.com/compare/ayrshare-vs-buffer.md)\n- [Ayrshare API + MCP vs bundle.social](https://www.anchorterminal.com/compare/ayrshare-vs-bundle-social.md)\n- [Ayrshare API + MCP vs Zernio (formerly Late) API + MCP](https://www.anchorterminal.com/compare/ayrshare-vs-late.md)\n- [Ayrshare API + MCP vs Metricool API + MCP](https://www.anchorterminal.com/compare/ayrshare-vs-metricool.md)\n- [Ayrshare API + MCP vs Mixpost API + MCP](https://www.anchorterminal.com/compare/ayrshare-vs-mixpost.md)\n- [Ayrshare API + MCP vs OneUp API + MCP](https://www.anchorterminal.com/compare/ayrshare-vs-oneup.md)\n- [Ayrshare API + MCP vs Post Bridge API + MCP](https://www.anchorterminal.com/compare/ayrshare-vs-post-bridge.md)\n- [Ayrshare API + MCP vs Postiz API + MCP](https://www.anchorterminal.com/compare/ayrshare-vs-postiz.md)\n- [Ayrshare API + MCP vs Publer API + MCP](https://www.anchorterminal.com/compare/ayrshare-vs-publer.md)\n- [Ayrshare API + MCP vs Repostit](https://www.anchorterminal.com/compare/ayrshare-vs-repostit.md)\n- [Ayrshare API + MCP vs Typefully](https://www.anchorterminal.com/compare/ayrshare-vs-typefully.md)\n- [Ayrshare API + MCP vs Upload-Post API + MCP](https://www.anchorterminal.com/compare/ayrshare-vs-upload-post.md)\n- [Ayrshare API + MCP vs Sprout Social API](https://www.anchorterminal.com/compare/ayrshare-vs-sprout-social.md)\n- [Ayrshare API + MCP vs TwitterAPI.io MCP](https://www.anchorterminal.com/compare/ayrshare-vs-twitterapi-io-mcp.md)\n- [Ayrshare API + MCP vs X MCP](https://www.anchorterminal.com/compare/ayrshare-vs-x-mcp.md)\n- [Blotato vs Xpoz MCP](https://www.anchorterminal.com/compare/blotato-vs-xpoz-mcp.md)\n- [Buffer API + MCP vs Xpoz MCP](https://www.anchorterminal.com/compare/buffer-vs-xpoz-mcp.md)\n- [bundle.social vs Xpoz MCP](https://www.anchorterminal.com/compare/bundle-social-vs-xpoz-mcp.md)\n- [Zernio (formerly Late) API + MCP vs Xpoz MCP](https://www.anchorterminal.com/compare/late-vs-xpoz-mcp.md)\n- [Metricool API + MCP vs Xpoz MCP](https://www.anchorterminal.com/compare/metricool-vs-xpoz-mcp.md)\n- [Mixpost API + MCP vs Xpoz MCP](https://www.anchorterminal.com/compare/mixpost-vs-xpoz-mcp.md)\n- [OneUp API + MCP vs Xpoz MCP](https://www.anchorterminal.com/compare/oneup-vs-xpoz-mcp.md)\n- [Post Bridge API + MCP vs Xpoz MCP](https://www.anchorterminal.com/compare/post-bridge-vs-xpoz-mcp.md)\n- [Postiz API + MCP vs Xpoz MCP](https://www.anchorterminal.com/compare/postiz-vs-xpoz-mcp.md)\n- [Publer API + MCP vs Xpoz MCP](https://www.anchorterminal.com/compare/publer-vs-xpoz-mcp.md)\n- [SocialCannon vs Xpoz MCP](https://www.anchorterminal.com/compare/socialcannon-vs-xpoz-mcp.md)\n- [Sprout Social API vs Xpoz MCP](https://www.anchorterminal.com/compare/sprout-social-vs-xpoz-mcp.md)\n- [TwitterAPI.io MCP vs Xpoz MCP](https://www.anchorterminal.com/compare/twitterapi-io-mcp-vs-xpoz-mcp.md)\n- [Upload-Post API + MCP vs Xpoz MCP](https://www.anchorterminal.com/compare/upload-post-vs-xpoz-mcp.md)\n- [X MCP vs Xpoz MCP](https://www.anchorterminal.com/compare/x-mcp-vs-xpoz-mcp.md)\n- [Ayrshare API + MCP vs SocialCannon](https://www.anchorterminal.com/compare/ayrshare-vs-socialcannon.md)\n", "meta": { "attribution": "Anchor Terminal (https://www.anchorterminal.com)", "attributionRequired": true, "credit": "CC BY 4.0, credit Anchor Terminal and link the page or API address you took it from (https://www.anchorterminal.com/terms/#data)", "docs": "https://www.anchorterminal.com/docs/", "generatedAt": "2026-11-08", "license": "CC-BY-4.0", "method": "https://www.anchorterminal.com/benchmark/", "methodology": "0.7", "openapi": "https://www.anchorterminal.com/openapi.json", "preview": false, "run": "2026-10-01", "runLabel": "October 2026 research run", "terms": "https://www.anchorterminal.com/terms/#data" }, "page": { "breadcrumbs": [ { "name": "Home", "url": "https://www.anchorterminal.com/" }, { "name": "Compare", "url": "https://www.anchorterminal.com/compare/" }, { "name": "Ayrshare API + MCP vs Xpoz MCP", "url": "" } ], "description": "Ayrshare scores 54.8 (C) to Xpoz MCP's 39.6 (E) for social analytics. Prices, MCP, x402, uptime and agent notes side by side.", "facts": [ "Ayrshare API + MCP C 54.8", "Xpoz MCP E 39.6", "scores" ], "h1": "Ayrshare API + MCP vs Xpoz MCP", "image": "https://www.anchorterminal.com/assets/og/default.png", "path": "/compare/ayrshare-vs-xpoz-mcp", "published": "2026-10-01", "section": "tools", "title": "Ayrshare vs Xpoz MCP for AI agents in 2026: scores and prices", "toc": null, "updated": "2026-11-07", "url": "https://www.anchorterminal.com/compare/ayrshare-vs-xpoz-mcp" }, "tokens": { "markdown": 4250, "slim": 2330 }, "version": 1 }