> ## 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.

# Guia de Integração da API de Renderização Web do WebExtrator

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

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

## Autenticação

Adicione no cabeçalho da requisição `Authorization: Bearer <sua API Key>`.

## Parâmetros da Requisição

| Campo               | Tipo      | Obrigatório | Padrão            | Descrição                                                                                                                 |
| ------------------- | --------- | :---------: | ----------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `url`               | string    |      ✅      | -                 | URL da página a ser renderizada                                                                                           |
| `user_agent`        | string    |      ❌      | Padrão do sistema | User-Agent personalizado                                                                                                  |
| `timeout`           | number    |      ❌      | 30000             | Timeout para renderização única (milissegundos), máximo 120000                                                            |
| `wait_until`        | string    |      ❌      | `load`            | Evento de carregamento completo: `load`/`domcontentloaded`/`networkidle`                                                  |
| `delay`             | number    |      ❌      | 0                 | Tempo de espera após o carregamento (milissegundos), máximo 30000                                                         |
| `wait_for_selector` | string    |      ❌      | -                 | Espera pelo aparecimento do seletor CSS                                                                                   |
| `block_resources`   | string\[] |      ❌      | -                 | Tipos de recursos a bloquear: `image`/`media`/`font`/`stylesheet` etc.                                                    |
| `headers`           | object    |      ❌      | -                 | Cabeçalhos HTTP adicionais                                                                                                |
| `cookies`           | array     |      ❌      | -                 | Lista de cookies, elementos no formato `{name, value, domain, path}`                                                      |
| `callback_url`      | string    |      ❌      | -                 | URL de callback para modo assíncrono; se fornecido, retorna imediatamente o ID da tarefa e o resultado é enviado via POST |

## Resposta Síncrona (sem 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"]
  }
}
```

## Modo Assíncrono (com callback\_url)

Resposta inicial:

```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"
}
```

O cabeçalho da resposta incluirá `x-usage-exempt: true`, indicando que esta negociação síncrona não será cobrada. Quando a tarefa for realmente concluída, a plataforma enviará um POST para o `callback_url`, cujo corpo da requisição conterá o campo `data` da resposta síncrona, junto com os campos `task_id` / `trace_id` / `started_at` / `finished_at` / `elapsed`.

## Resposta de Erro

```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"
  }
}
```

Códigos de erro: `bad_request` / `forbidden` / `too_many_requests` / `not_found` / `api_error` / `timeout` / `unknown` / `busy`.

## Exemplo

```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"]
  }'
```
