Ayrshare connects to a Nagent workspace with an API key. Once it is connected, agents can call 3 Ayrshare actions: "Create Auto Schedule", "Get Post History" and "Delete a previously published Ayrshare post". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Ayrshare, with input parameters and output schema.
AYRSHARE_CREATE_AUTO_SCHEDULETool to create a new auto-post schedule with specified times and optional weekday filters. Use when setting up recurring posting plans.
Input parameters
The title of the schedule. Defaults to 'default'.
List of scheduled times in HH:MMZ format, e.g., \['13:05Z', '22:14Z'\]
Optional days of the week to post (0=Sunday ... 6=Saturday). Defaults to every day if omitted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
AYRSHARE_DELETE_DELETE_POSTTool to delete an Ayrshare post. Use when you need to remove a published or scheduled post by its Ayrshare Post ID, after confirming the correct ID. Note: Instagram and TikTok published posts cannot be deleted via API; set `mark_manual_deleted=True` or remove manually.
Input parameters
Ayrshare Post ID to delete. Required if neither `bulk` nor `delete_all_scheduled` is set.
List of Ayrshare Post IDs to delete in bulk. Required if neither `id` nor `delete_all_scheduled` is set.
If true, marks the post as deleted in Ayrshare without calling social APIs. Use when a post was manually removed on the networks.
If true, deletes all pending scheduled posts for this profile. Ignores `id` and `bulk` when set.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
AYRSHARE_GET_POST_HISTORYTool to retrieve Ayrshare post history with metrics. Use when you need to fetch and filter past posts by date, status, or record count.
Input parameters
Number of records to return per page (default 20; max 500).
Filter by post status.
End date in ISO 8601 format (inclusive).
Return posts from the last X days (default 30; 0 returns all posts).
Start date in ISO 8601 format (inclusive).
Profile Key of a User Profile. Omit to use the primary profile.
Return the last X posts, regardless of date filters.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 3 Ayrshare actions on Nagent: "Create Auto Schedule", "Get Post History" and "Delete a previously published Ayrshare post". Create Auto Schedule: Create a new auto-post schedule with specified times and optional weekday filters. Each action is listed on this page with its input parameters and its output.
Ayrshare connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create Auto Schedule takes 1 required input: schedule. It also takes 2 optional inputs: title and daysOfWeek. It returns data, error and successful.