Dokumentacja APIPOST

Dodawanie słów kluczowych

Dodaj jedno lub więcej słów kluczowych do monitorowanej witryny, aby RedReplier zaczął oceniać pasujące do nich wątki.

POSThttps://ai.redreplier.com/ai-app/api/v1/websites/{websiteId}/keywords

Dodaj jedno lub więcej słów kluczowych do monitorowanej witryny, aby RedReplier zaczął oceniać pasujące do nich wątki.

Token Bearer (token API RedReplier)

Uwierzytelnianie

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

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Parametry

  • websiteId (ścieżka, UUID, wymagany): Witryna, do której trafią słowa kluczowe.

Treść żądania

  • keywords (string[], wymagany, niepusty): Słowa kluczowe do dodania; każda wartość może mieć do 255 znaków.

Odpowiedź

Zwraca jeden publiczny obiekt Website.

Obiekt Website

  • id (string): UUID witryny.
  • accountGroupId (string): Grupa kont ustalona na podstawie tokena.
  • domain (string): Znormalizowana domena witryny.
  • url (string): URL witryny.
  • name (string | null): Wyświetlana nazwa.
  • description (string | null): Kontekst używany przy ocenie trafności.
  • createdAt, updatedAt (ISO string | null): Znaczniki czasu utworzenia i aktualizacji w formacie ISO 8601 lub null.
  • keywords (Keyword[]): Obiekty słów kluczowych tej witryny.

Obiekt Keyword

  • id (string): UUID słowa kluczowego.
  • websiteId (string): UUID witryny nadrzędnej.
  • value (string): Treść słowa kluczowego, do 255 znaków.
  • status (string): PENDING, ACTIVE, DISABLED lub SUSPENDED.
  • createdAt, updatedAt (ISO string | null): Znaczniki czasu utworzenia i aktualizacji w formacie ISO 8601 lub null.

Przykładowe żądanie

curl -X POST https://ai.redreplier.com/ai-app/api/v1/websites/11111111-1111-4111-8111-111111111111/keywords \
  -H 'Authorization: Bearer redreplier_test_1234567890' \
  -H 'Content-Type: application/json' \
  -d '{"keywords":["agency CRM","client onboarding software"]}'

Uwagi

Dodawanie słów kluczowych to operacja odrębna od edycji. Słowa mieszczące się w limicie planu od razu otrzymują status ACTIVE. Pozostałe mają status PENDING, dopóki w planie nie zwolni się miejsce.

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 token jest nieprawidłowy 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 danych uwierzytelniających, 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 przypisanego do tokena.
  • 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/websites/9b0f2b8d-4a76-4f59-9f0b-6b4b6f6c2a10/keywords \
  --header 'Authorization: Bearer redreplier_test_1234567890' \
  --header 'Content-Type: application/json' \
  --data '{"keywords":["agency CRM","client follow-up software","sales pipeline for agencies"]}'
201
{
  "id": "9b0f2b8d-4a76-4f59-9f0b-6b4b6f6c2a10",
  "accountGroupId": "acct_7dK9pQ2",
  "domain": "acmecrm.io",
  "url": "https://acmecrm.io",
  "name": "Acme CRM",
  "description": "CRM for small agencies that need pipeline tracking and client follow-up reminders.",
  "createdAt": "2026-05-22T10:15:30.000Z",
  "updatedAt": "2026-05-29T14:02:11.000Z",
  "keywords": [
    {
      "id": "73a3c9b6-3e5f-4a53-a2c6-70c5ef7f2f6d",
      "websiteId": "9b0f2b8d-4a76-4f59-9f0b-6b4b6f6c2a10",
      "value": "agency CRM",
      "status": "ACTIVE",
      "createdAt": "2026-05-22T10:16:00.000Z",
      "updatedAt": "2026-05-29T14:02:11.000Z"
    }
  ]
}