> ## Documentation Index
> Fetch the complete documentation index at: https://germeytechnology-docs-remove-4o-image-nav.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# WebExtrator Інтеграційний посібник з API рендерингу веб-сторінок

> WebExtrator Web Render & Extract 集成指南 - Ace Data Cloud

`POST https://api.acedata.cloud/webextrator/render`

## Аутентифікація

Додайте в заголовок запиту `Authorization: Bearer &lt;ваш API Key>`.

## Параметри запиту

| Поле                | Тип       | Обов’язкове | За замовчуванням         | Опис                                                                                                                      |
| ------------------- | --------- | :---------: | ------------------------ | ------------------------------------------------------------------------------------------------------------------------- |
| `url`               | string    |      ✅      | -                        | URL сторінки для рендерингу                                                                                               |
| `user_agent`        | string    |      ❌      | За замовчуванням системи | Користувацький User-Agent                                                                                                 |
| `timeout`           | number    |      ❌      | 30000                    | Таймаут одного рендерингу (мс), максимум 120000                                                                           |
| `wait_until`        | string    |      ❌      | `load`                   | Подія завершення завантаження: `load`/`domcontentloaded`/`networkidle`                                                    |
| `delay`             | number    |      ❌      | 0                        | Час очікування після завантаження (мс), максимум 30000                                                                    |
| `wait_for_selector` | string    |      ❌      | -                        | Очікувати появу CSS-селектора                                                                                             |
| `block_resources`   | string\[] |      ❌      | -                        | Блокування типів ресурсів: `image`/`media`/`font`/`stylesheet` тощо                                                       |
| `headers`           | object    |      ❌      | -                        | Додаткові HTTP-заголовки                                                                                                  |
| `cookies`           | array     |      ❌      | -                        | Список cookie, елементи у форматі `{name, value, domain, path}`                                                           |
| `callback_url`      | string    |      ❌      | -                        | URL для асинхронного зворотного виклику; якщо вказано, одразу повертається ID завдання, результат надсилається через POST |

## Синхронна відповідь (без callback\_url)

```json theme={null}
{
  "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"]
  }
}
```

## Асинхронний режим (з callback\_url)

Початкова відповідь:

```json theme={null}
{
  "success": true,
  "task_id": "550e8400-e29b-41d4-a716-446655440000",
  "trace_id": "550e8400-e29b-41d4-a716-446655440001",
  "started_at": "2026-05-02T10:30:00.123Z"
}
```

У заголовках відповіді буде `x-usage-exempt: true`, що означає, що цей синхронний хендшейк не тарифікується. Коли завдання буде фактично завершене, платформа надішле POST на `callback_url`, тіло запиту міститиме поле `data` з синхронної відповіді, а також ті ж поля `task_id` / `trace_id` / `started_at` / `finished_at` / `elapsed`.

## Відповідь з помилкою

```json theme={null}
{
  "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"
  }
}
```

Коди помилок: `bad_request` / `forbidden` / `too_many_requests` / `not_found` / `api_error` / `timeout` / `unknown` / `busy`.

## Приклад

```bash theme={null}
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"]
  }'
```
