Dokumentacja APIPOST

Wyjaśnij wzmiankę

Wygeneruj lub pobierz uzasadnienie trafności od AI oraz tagi, które wyjaśniają, dlaczego wzmianka pasuje do twoich słów kluczowych.

POSThttps://ai.redreplier.com/ai-app/api/v1/mentions/{mentionId}/explain

Wygeneruj lub pobierz uzasadnienie trafności od AI oraz tagi, które wyjaśniają, dlaczego wzmianka pasuje do twoich słów kluczowych.

Token Bearer (token API RedReplier)

Uwierzytelnianie

Wysyłaj token API RedReplier jako token Bearer w każdym żądaniu. Tokeny zaczynają się od redreplier_; RedReplier ustala konto na podstawie tokena. Wyślij X-Workspace-Id, aby działać w obszarze roboczym innym niż domyślny; zobacz Lista obszarów roboczych.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Parametry

  • mentionId (ścieżka, UUID, wymagany): Wzmianka do wyjaśnienia.

Treść żądania

Ten endpoint nie wymaga treści JSON.

Odpowiedź

Zwraca jeden publiczny obiekt Mention z polami relevanceReason, tags i aiReplySuggestion albo null, jeśli wzmianka jest niedostępna.

  • id (string): UUID wzmianki.
  • websiteId (string | null): UUID strony.
  • source (string): REDDIT_POST, REDDIT_COMMENT, TWITTER (X), BLUESKY, HACKERNEWS, FACEBOOK lub FACEBOOK_GROUP.
  • keyword (string | null): Wartość dopasowanego słowa kluczowego.
  • title, contentText, url, author, subreddit (string | null): Kontekst: tytuł, treść i link. subreddit zawiera nazwę subreddita dla źródeł z Reddita oraz identyfikator grupy dla FACEBOOK_GROUP, a dla pozostałych źródeł ma wartość null.
  • status (string): NEW, APPROVED lub REJECTED.
  • relevanceScore (number | null): Ocena trafności od AI w skali od 0 do 100 lub null.
  • relevanceReason (string | null): Wyjaśnienie dopasowania od AI lub null.
  • aiReplySuggestion (string | null): Szkic odpowiedzi od AI do przejrzenia przez człowieka przed publikacją lub null.
  • tags (string[]): Tagi trafności wygenerowane przez AI.
  • publishedAt, ingestedAt, reviewedAt, createdAt, updatedAt (ISO string | null): Znaczniki czasu publikacji, pobrania, przeglądu, utworzenia i aktualizacji w formacie ISO 8601 lub null.

Przykładowe żądanie

curl -X POST https://ai.redreplier.com/ai-app/api/v1/mentions/33333333-3333-4333-8333-333333333333/explain \
  -H 'Authorization: Bearer redreplier_test_1234567890'

Uwagi

Jeśli wyjaśnienie jeszcze nie istnieje, RedReplier generuje je przy pierwszym żądaniu. Strona musi mieć opis; bez niego wzmianka wraca bez zmian.

Błędy

  • 400 Bad Request: Nieprawidłowe dane wejściowe, URL, UUID, wartość enum, parametr zapytania lub treść żądania.
  • 401 Unauthorized: Brak tokena Bearer lub nieprawidłowy token albo code: "token_issuer_lost_access", gdy osoba, która utworzyła klucz API, została dezaktywowana lub opuściła obszar roboczy.
  • 403 Forbidden: code: "subscription_required", gdy plan obszaru roboczego nie obejmuje dostępu do API, code: "workspace_access_denied", gdy X-Workspace-Id wskazuje obszar roboczy niedostępny dla tych poświadczeń, lub code: "permission_denied", gdy twoja rola w obszarze roboczym nie ma uprawnienia redreplier.write (mają je Administrator i Edytor).
  • 404 Not Found: Zasób nie istnieje dla konta powiązanego z tokenem.
  • 429 Too Many Requests: Przekroczono limit żądań. Odczekaj liczbę sekund podaną w Retry-After.
  • 500 Internal Server Error: Nieoczekiwany błąd serwera.
Przykładowe żądanie (curl)
curl --request POST \
  --url https://ai.redreplier.com/ai-app/api/v1/mentions/6a9f0e8b-2c65-44f7-b6e6-7f88a7df8301/explain \
  --header 'Authorization: Bearer redreplier_test_1234567890'
201
{
  "id": "6a9f0e8b-2c65-44f7-b6e6-7f88a7df8301",
  "websiteId": "9b0f2b8d-4a76-4f59-9f0b-6b4b6f6c2a10",
  "source": "REDDIT_POST",
  "keyword": "agency CRM",
  "title": "Best CRM for a small agency?",
  "contentText": "We need a lightweight CRM for client follow-ups and deal tracking.",
  "url": "https://reddit.com/r/sales/comments/example/best_crm_for_a_small_agency",
  "author": "agency_ops",
  "subreddit": "sales",
  "status": "NEW",
  "relevanceScore": 86,
  "relevanceReason": "The thread asks for an agency CRM, which directly matches the monitored product category.",
  "aiReplySuggestion": "We built Acme CRM for small agencies with exactly this problem. Happy to share how teams set up follow-up reminders.",
  "tags": ["recommendation-request", "high-intent"],
  "publishedAt": "2026-05-29T09:20:00.000Z",
  "ingestedAt": "2026-05-29T09:24:12.000Z",
  "reviewedAt": null,
  "createdAt": "2026-05-29T09:24:12.000Z",
  "updatedAt": "2026-05-29T09:24:12.000Z"
}