Przejdź do głównej treści
POST https://api.acedata.cloud/webextrator/render

Uwierzytelnianie

Dodaj do nagłówka żądania Authorization: Bearer <Twój klucz API>.

Parametry żądania

PoleTypWymaganeDomyślneOpis
urlstring-URL strony do wyrenderowania
user_agentstringDomyślny systemowyNiestandardowy User-Agent
timeoutnumber30000Limit czasu renderowania (ms), maks. 120000
wait_untilstringloadZdarzenie zakończenia ładowania: load/domcontentloaded/networkidle
delaynumber0Czas oczekiwania po zakończeniu ładowania (ms), maks. 30000
wait_for_selectorstring-Czekaj na pojawienie się selektora CSS
block_resourcesstring[]-Blokowane typy zasobów: image/media/font/stylesheet itd.
headersobject-Dodatkowe nagłówki HTTP
cookiesarray-Lista ciasteczek, elementy w formacie {name, value, domain, path}
callback_urlstring-Adres zwrotny w trybie asynchronicznym; jeśli podany, zwraca natychmiast ID zadania, wynik przesyłany jest przez POST

Odpowiedź synchroniczna (bez callback_url)

{
  "success": true,
  "task_id": "550e8400-e29b-41d4-a716-446655440000",
  "trace_id": "550e8400-e29b-41d4-a716-446655440001",
  "started_at": "2026-05-02T10:30:00.123Z",
  "finished_at": "2026-05-02T10:30:05.456Z",
  "elapsed": 5.333,
  "data": {
    "kind": "render",
    "url": "https://example.com",
    "title": "Example Domain",
    "html": "<!doctype html>...",
    "text": "Example Domain ...",
    "markdown": "# Example Domain\n...",
    "screenshot": "data:image/png;base64,iVBORw0K...",
    "links": ["https://www.iana.org/domains/example"]
  }
}

Tryb asynchroniczny (z callback_url)

Początkowa odpowiedź:
{
  "success": true,
  "task_id": "550e8400-e29b-41d4-a716-446655440000",
  "trace_id": "550e8400-e29b-41d4-a716-446655440001",
  "started_at": "2026-05-02T10:30:00.123Z"
}
Nagłówek odpowiedzi będzie zawierał x-usage-exempt: true, co oznacza, że to synchroniczne nawiązanie połączenia nie jest naliczane. Po faktycznym zakończeniu zadania platforma wyśle POST na callback_url, a ciało żądania będzie zawierać pole data z odpowiedzi synchronicznej wraz z tymi samymi polami task_id / trace_id / started_at / finished_at / elapsed.

Odpowiedź błędu

{
  "success": false,
  "task_id": "550e8400-e29b-41d4-a716-446655440000",
  "trace_id": "550e8400-e29b-41d4-a716-446655440001",
  "started_at": "2026-05-02T10:30:00.123Z",
  "error": {
    "code": "timeout",
    "message": "page load timed out after 30000ms"
  }
}
Kody błędów: bad_request / forbidden / too_many_requests / not_found / api_error / timeout / unknown / busy.

Przykład

curl -X POST https://api.acedata.cloud/webextrator/render \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "wait_until": "networkidle",
    "block_resources": ["image", "media", "font"]
  }'