Dokumentacja APIPOST

Analiza opisu witryny

Wygeneruj opis AI na podstawie adresu URL przed utworzeniem lub aktualizacją witryny.

POSThttps://ai.redreplier.com/ai-app/api/v1/websites/analyze-description

Wygeneruj opis AI na podstawie adresu URL przed utworzeniem lub aktualizacją witryny.

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

Ten endpoint nie przyjmuje parametrów ścieżki ani zapytania.

Treść żądania

  • url (string, URL, wymagany): URL witryny do analizy.

Odpowiedź

Zwraca wygenerowany opis.

  • description (string): Wygenerowane przez AI podsumowanie witryny lub produktu.

Przykładowe żądanie

curl -X POST https://ai.redreplier.com/ai-app/api/v1/websites/analyze-description \
  -H 'Authorization: Bearer redreplier_test_1234567890' \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://acmecrm.io"}'

Uwagi

Użyj tego endpointu przed utworzeniem lub aktualizacją witryny, jeśli chcesz najpierw przejrzeć opis wygenerowany przez AI.

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/analyze-description \
  --header 'Authorization: Bearer redreplier_test_1234567890' \
  --header 'Content-Type: application/json' \
  --data '{"url": "https://acmecrm.io"}'
201
{
  "description": "Acme CRM helps small agencies manage sales pipelines, client relationships, and follow-up workflows."
}