Skip to main content
Rypl

What endpoints does the Rypl API have?

Updated

The Rypl API has endpoints for your channels, comments, direct messages, posts and ads, your agent's replies, counts for a period, the Needs attention list, your agents and your Global rules, plus actions to hide, unhide and mark a comment as reviewed and to change your Global moderation rules. It reads with GET, changes with POST and PATCH, and answers in JSON.

Basics

Addresshttps://app.rypl.is/api/v1
KeyAuthorization: Bearer rypl_… with every request
Limits120 requests a minute per connection, 30 changes a minute. Over that: 429 with Retry-After
TimesISO 8601: 2026-11-01 or 2026-11-01T09:30:00Z. since and until are inclusive
ListsNewest first, as { "data": [...], "next_cursor": "…" }. Send cursor=<next_cursor> for the next page; null means the end
IdsChannels, authors and posts keep their Facebook, Instagram or TikTok ids. A row's id is Rypl's own, and is the one actions take

The data can be a few seconds behind your Inbox. Errors are listed in Why can't my app connect to Rypl?

Endpoints

EndpointWhat it returnsNeeds
GET /meWhose key this is, what it may read, its channels and when it endsAny key
GET /channelsYour connected channels, with their settings if allowedAny key
GET /commentsComments on your posts and adsComments
GET /messagesDirect messages on Facebook Messenger and InstagramDirect messages
GET /postsPosts and ads people commented on, with countsComments
GET /repliesYour agent's replies, each with what it answeredComments or Direct messages
GET /summaryCounts for a period, optionally groupedComments or Direct messages
GET /attentionThe Needs attention listComments or Direct messages
GET /agentsYour agents: instructions, knowledge, reply rulesSettings
GET /rulesYour Global rules: rule cards and banned wordsSettings
POST /comments/{id}/hideHides a comment on its platformModerate comments
POST /comments/{id}/unhideShows a hidden comment againModerate comments
POST /comments/{id}/reviewMarks a comment as reviewed; {"undo": true} takes it backModerate comments
POST /rules/cardsAdds a rule to your Global rulesChange moderation rules
PATCH /rules/cards/{id}Changes a rule's text or action, or switches it off or onChange moderation rules
PATCH /rulesChanges the mode, the default action or the banned wordsChange moderation rules

Filters for /comments and /messages

ParameterValues
period, timezonetoday, yesterday, last_7_days, last_30_days; timezone is a name such as Europe/Berlin (UTC without it). Not together with since and until
since, untilWhen the row was written on the platform
updated_sinceRows that changed in Rypl since then: analysed, replied to, hidden or deleted
channel, platformA channel id from /channels; facebook, instagram, tiktok
viewAn Inbox tab: needs_review, reply_needed, negative, ai_replies, hidden_or_deleted, unanswered_questions
sentiment, urgency, intentFor example negative, high, complaint
languageA language code, for example en
is_question, replied, hidden, deleted, from_pagetrue or false. from_page=false keeps only customers' rows
post, parent, authorA post id; a comment's id, for its replies; an author id
author_namePart of a name or username, 2 to 60 characters
search, search_anyText or a name, up to 100 characters; or up to 10 words or phrases, separated by commas, matching any of them
containsphone, email or link
flag, min_severityprofanity, scam_accusation, sarcasm, human_review, emoji_only, mixed_language; severity 1 to 5
moderated_byWhy it was hidden or deleted: banned_words, rules, tone_filter, spam_filter, hide_all, legal_filter, blocked_author, you, with_parent, platform, other
ai_reply, agentsent, failed, none, edited; an agent id from /agents
rule_taskopen: comments your rules handed to you that are still open
limit, cursor1 to 200, 100 by default

A row

Every comment or message has id, type, platform, platform_id, created_at, updated_at, from_page, text, parent_id, channel, author, and post for comments or recipient_id for messages. Then:

  • analysis: language, sentiment, urgency, intent, is_question, severity, flags.
  • hidden, deleted, and moderation when either is true: by what (one of the moderated_by names), the label and reason as your Inbox words them, the rule that fired, and when.
  • rule_task when one of your rules handed the comment to you: review or reply_needed, when it was reviewed, the rule, and what it would have done.
  • ai_reply: text, agent, published_at, response_seconds, delivered, failed, deleted, style.
  • manual_reply: a reply written by a person.

post.text is the first 280 characters, and often empty on Instagram and TikTok; post.url is always there.

The other lists

  • /posts ranks your posts and ads by comments, negative or recent for a period (limit up to 100, 25 by default; no cursor). Each comes with counts: comments, negative, positive, questions, replied, hidden, deleted.
  • /replies lists your agent's replies (sent by default, or failed, edited), each with the customer's text it answered and how many seconds it took.
  • /summary counts rows for a period, the last 7 days by default: total, comments, messages, positive, neutral, negative, urgent, questions, unanswered questions, replied, AI replies, hidden, deleted. group_by splits them by day (up to 92 days, every day listed), channel, platform, sentiment, intent or language.
  • /attention returns the conversations in Needs attention, in your Inbox's order, each with its reasons: needs_review, reply_needed, negative, urgent.
  • /channels, /agents and /rules return your setup as the dashboard shows it. They are read-only.

Actions

hide and unhide act on Facebook, Instagram or TikTok, like the buttons in your Inbox; review closes a comment your rules handed to you and changes nothing on the platform. They work only on customers' comments, on the channels the connection covers, with Moderate comments on.

With Change moderation rules on, POST /rules/cards adds a rule (text up to 300 characters, action one of keep, review, reply_needed, hide), PATCH /rules/cards/{id} edits one or switches it off, and PATCH /rules sets mode (review, apply, paused), default_action and banned_words (add, remove, action none or hide). Each answers your rules as they are after the change. Nothing can be set to delete: see Can a connected app change my moderation rules?

There is no endpoint to reply or delete.

MCP server

https://app.rypl.is/api/mcp, Streamable HTTP, with the same key in Authorization: Bearer. An app sees only the tools its connection allows:

ToolWhat it does
list_channelsYour connected channels
list_comments, list_messagesRows, with the filters above, 25 per call and up to 100
list_postsWhich post or ad draws the most comments or complaints
list_repliesYour agent's replies
get_summaryCounts for a period
list_attentionWhat needs your attention
list_agents, get_moderation_rulesYour agents and Global rules
hide_comment, unhide_comment, mark_comment_reviewedModeration, if you allowed it
add_moderation_rule, update_moderation_rule, update_moderation_settingsChanging your Global rules, if you allowed it

On this page