Szybki start API¶

API przyjmuje i zwraca JSON przez HTTPS. Pełna dokumentacja jest generowana z opisu OpenAPI: Dokumentacja API (plik openapi.json w dokumentacji technicznej).

1. Zdobądź klucz¶

Utwórz klucz projektu (Klucze API) i trzymaj go w zmiennej środowiskowej. Adres bazowy to adres aplikacji, do której dostałeś zaproszenie.

export ASKANIELA_URL=https://<adres-aplikacji>
export ASKANIELA_API_KEY=gsj_...

2. Sprawdź jedną stronę¶

curl -s "$ASKANIELA_URL/v1/judge" \
  -H "Authorization: Bearer $ASKANIELA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/"}'

Wyślij dokładnie jedno z: url, html lub text. Pola opcjonalne: rules (identyfikatory reguł, zob. GET /v1/rules), render_js, explain (dowody dla trafień), query i market (intencja wyszukiwania), project_id. Odpowiedź zawiera violations (spam), quality_signals (jakość), labels, positives i not_assessed, każdy element z rule_id i wynikiem ryzyka.

3. Search Intent dla frazy¶

curl -s "$ASKANIELA_URL/v1/intent" \
  -H "Authorization: Bearer $ASKANIELA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "kalkulator raty kredytu", "market": "pl-PL"}'

Dla wielu fraz użyj POST /v1/intent/batch lub POST /v1/intent/batch/csv.

4. Większe zadania¶

POST /v1/judge/batch - do 10 stron w jednym wywołaniu.
POST /v1/jobs - zadania asynchroniczne, opcjonalnie z webhookami (Webhooki i zadania).
POST /v1/audits/site/estimate, potem POST /v1/audits/site - audyty witryny (Audyty).

5. Raporty i zużycie¶

GET /v1/reports, GET /v1/reports/{id}, GET /v1/reports/{id}/export.pdf.
GET /v1/usage - limit miesięczny i saldo w USD.

Po wyczerpaniu limitu API zwraca 429 quota_exceeded. Wszystkie kody błędów: Błędy.