Mentions

Explain why a mention scored the way it did

Fills in relevanceReason, tags and aiReplySuggestion when they are missing, which runs AI scoring. A mention that already has a reason and a reply comes back as it is, with no new AI call, and so does one whose website has no description or whose scoring fails. An id that matches no mention in this workspace answers 201 with an empty body, not 404.

post/mentions/{id}/explain

Request

  • Base URL: https://ai.redreplier.com/ai-app/api/v1
  • URL: https://ai.redreplier.com/ai-app/api/v1/mentions/{id}/explain
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Mention id

Headers

X-Workspace-Idstring

The workspace to act in, for OAuth sign-ins that reach several workspaces. Take the id from GET /workspaces. Without it the call lands in the default workspace. A workspace the caller cannot reach answers 403 with code: workspace_access_denied. An API key belongs to one workspace: send its own id or leave the header out

Response

The mention with its scoring rationale, or an empty body when no mention in this workspace has this id

idstring uuid required
websiteIdstring uuid required
source'REDDIT_POST' | 'REDDIT_COMMENT' | 'TWITTER' | 'BLUESKY' | 'HACKERNEWS' | 'FACEBOOK' | 'FACEBOOK_GROUP' required
keywordstring nullable

The monitored keyword this conversation matched.

titlestring nullable
contentTextstring nullable
urlstring uri nullable

Link to the conversation. Null when the platform gives no public link, as with some Facebook and Bluesky posts.

authorstring nullable
subredditstring nullable

The subreddit on Reddit and the group id on Facebook. Null on other platforms.

status'NEW' | 'REJECTED' | 'APPROVED' required
relevanceScorenumber nullable

Higher means more likely to be worth a reply.

relevanceReasonstring nullable

Why the scorer landed on that number.

aiReplySuggestionstring nullable

Draft reply for a human to review before posting.

tagsstring[]
publishedAtstring date-time nullable
ingestedAtstring date-time nullable
reviewedAtstring date-time nullable
createdAtstring date-time nullable
updatedAtstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.