Skip to content
warmupDocs

Tools

The server exposes 16 tools. Each one maps to a REST API endpoint and returns its JSON response. API errors come back as a tool error that includes the HTTP status and error code, for example 409 project_limit_reached.

Hints in the tables: read-only tools don’t change anything; destructive tools ask for confirmation in most clients; external tools reach Meta.

Projects

Section titled “Projects”
Tool What it does Hints
list_projects All projects with status, profile, connected networks and the plan limit. read-only
get_project One project by id. read-only
create_project Create a project.
update_project Partially update a project. idempotent
delete_project Delete a project. destructive

Parameters

  • get_project, delete_project: id — project UUID.
  • create_project: name — 1–80 characters.
  • update_project: id, and any of name, status (farm · active · paused · archived), gender (male · female), language (BCP 47, e.g. en-US), geo (ISO country code, e.g. US). Pass null to clear gender, language or geo.

Connections

Section titled “Connections”
Tool What it does Hints
start_connection Start connecting a network; returns authUrl. Also reconnects an account that needs re-authorization. external
list_pending_facebook_pages Facebook Pages to choose from after sign-in. read-only
select_facebook_page Finish connecting Facebook with the chosen Page. external
disconnect Disconnect a network from a project. destructive, external

Parameters

  • start_connection: id, platform (facebook · instagram · threads), optional timezone (IANA, e.g. Europe/Berlin) for daily refreshes.
  • list_pending_facebook_pages: id, selectionId.
  • select_facebook_page: id, selectionId, pageId.
  • disconnect: id, platform.

The agent can’t complete OAuth itself: it gives you authUrl, you open it and approve access. See Connect a social network.

Analytics

Section titled “Analytics”

All analytics tools are read-only and work on tracked accounts — your own (role: own, default) or competitors (role: competitor).

Tool What it returns
get_analytics_filters Tracked accounts (id, network, username) and collections. Call it first to get ids for filters.
get_analytics_overview Views, posts, ER, likes, comments, shares, saves, followers with change against the previous period, plus a daily series.
compare_platforms Posts, views, likes, comments, average views per post and ER per network.
get_top_posts Best posts of the period with links, captions and metrics.
get_content_insights Performance by content type, by weekday and hour, and top hashtags.
get_video_duration_insights Views by video length bucket and the best-performing length.
get_posting_activity Posts per day for the last N days and the date of the last post.

Common filters (all analytics tools except get_analytics_filters, which takes only role):

Parameter Description
role own (default) or competitor.
from, to Period, YYYY-MM-DD, inclusive. Default: the last 30 days. Max 365 days.
tz IANA time zone for day boundaries and posting hours. Default UTC.
platforms Only these networks: instagram, tiktok, facebook.
groups Only accounts from these collections.
accountIds Only these accounts.

Extra parameters

  • get_top_posts: sort — views (default), er, likes, comments, shares; limit — 1–50, default 10.
  • get_posting_activity: days — 7–365, default 180. It ignores from and to.

How the numbers are calculated: Analytics guide.