{"openapi":"3.1.0","info":{"title":"Ayrshare (BYOK) API","version":"0.1.0","description":"Ayrshare (BYOK) lets an AI assistant read your own Ayrshare data through the Ayrshare API with a key you supply (Ayrshare API key of the primary profile (paid plan or trial)). Read-only: 6 tools (get_user_profile, list_post_history, get_post_history_by_id, get_post_comments, list_user_profiles, list_auto_schedules). The BYOK key travels with each request, is used for that one call only and is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-ayrshare.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-ayrshare/docs"},"termsOfService":"https://connectorbay.com/byok-ayrshare/terms"},"servers":[{"url":"https://byok-ayrshare.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-ayrshare/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_user_profile":{"post":{"operationId":"get_user_profile","summary":"Show the Ayrshare profile of the key: which social networks are linked, linked account names and creation time. Use for ","description":"Show the Ayrshare profile of the key: which social networks are linked, linked account names and creation time. Use for \"Which social networks are linked to my Ayrshare account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_user_profileArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_post_history":{"post":{"operationId":"list_post_history","summary":"List posts sent through Ayrshare, newest first, filtered by social network, status, send type or date range. Needs the P","description":"List posts sent through Ayrshare, newest first, filtered by social network, status, send type or date range. Needs the Premium plan or higher. Use for \"What did I post through Ayrshare in the last week\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many of the latest posts to return (default 25, maximum 1000).","title":"Limit"},"platforms":{"anyOf":[{"enum":["bluesky","facebook","gmb","instagram","linkedin","pinterest","reddit","snapchat","telegram","threads","tiktok","twitter","youtube"],"type":"string"},{"type":"null"}],"default":null,"description":"Only posts for this network.","title":"Platforms"},"status":{"anyOf":[{"enum":["success","error","processing","pending","paused","deleted","awaiting approval"],"type":"string"},{"type":"null"}],"default":null,"description":"Only posts with this status.","title":"Status"},"type":{"anyOf":[{"enum":["immediate","scheduled"],"type":"string"},{"type":"null"}],"default":null,"description":"Only immediate posts or only scheduled posts.","title":"Type"},"last_days":{"anyOf":[{"maximum":3650,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only posts from the last n days, by publish date (default 30).","title":"Last Days"},"start_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only posts from this time on, ISO 8601 such as 2026-10-01T00:00:00Z.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only posts up to this time, ISO 8601 such as 2026-10-15T23:59:59Z.","title":"End Date"}},"title":"list_post_historyArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_post_history_by_id":{"post":{"operationId":"get_post_history_by_id","summary":"Get one post by its Ayrshare post id with text, networks, status, schedule date, per-network post ids and errors. Use fo","description":"Get one post by its Ayrshare post id with text, networks, status, schedule date, per-network post ids and errors. Use for \"Show the details of Ayrshare post TBEAAqAMMJoweA9wKHUl\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Ayrshare post id as returned by list_post_history.","maxLength":200,"title":"Id","type":"string"},"search_all_posts":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to search the post id across all user profiles.","title":"Search All Posts"}},"required":["id"],"title":"get_post_history_by_idArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_post_comments":{"post":{"operationId":"get_post_comments","summary":"Get the comments on a post, grouped by social network, using an Ayrshare post id. Use for \"What comments did Ayrshare po","description":"Get the comments on a post, grouped by social network, using an Ayrshare post id. Use for \"What comments did Ayrshare post TBEAAqAMMJoweA9wKHUl get\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Ayrshare post id from list_post_history.","maxLength":200,"title":"Id","type":"string"}},"required":["id"],"title":"get_post_commentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_user_profiles":{"post":{"operationId":"list_user_profiles","summary":"List the user profiles of a business or enterprise Ayrshare account with title, status, reference id and linked networks","description":"List the user profiles of a business or enterprise Ayrshare account with title, status, reference id and linked networks. Use for \"Which user profiles exist in my Ayrshare account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"title":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only the profile with this title.","title":"Title"},"has_active_social_accounts":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for profiles with at least one linked network, false for those with none.","title":"Has Active Social Accounts"},"limit":{"anyOf":[{"maximum":5000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many profiles to return (default and maximum 5000).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: nextCursor from the previous answer when hasMore is true.","title":"Cursor"}},"title":"list_user_profilesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_auto_schedules":{"post":{"operationId":"list_auto_schedules","summary":"List the auto-schedule posting time slots by schedule title with days of week and last scheduled date. Use for \"What aut","description":"List the auto-schedule posting time slots by schedule title with days of week and last scheduled date. Use for \"What auto-schedule times have I set in Ayrshare\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_auto_schedulesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}