API Screenshot

Visão geralLink to Visão geral

A Screenshot API da CaptureKit renderiza uma página da web como um navegador real e retorna uma captura de tela (PNG/JPEG/WebP) ou um PDF.
Ela foi projetada para fluxos de trabalho em que você precisa de uma saída visual confiável para pré-visualizações, relatórios, QA, monitoramento e arquivamento, sem construir sua própria infraestrutura de navegador headless.

Casos de uso típicosLink to Casos de uso típicos

• Pré-visualizações e miniaturas de sites: gere pré-visualizações consistentes para links em dashboards, diretórios ou ferramentas de SEO.
• QA e regressão visual: capture páginas entre versões (desktop/mobile) para detectar mudanças de UI.
• Relatórios e entregáveis para clientes: exporte capturas de página inteira ou PDFs para auditorias e documentação.
• Monitoramento e compliance: armazene evidências visuais do estado de uma página em um determinado momento (páginas de preços, páginas legais, anúncios).
• Captura de produto / página: tire screenshots limpos de produtos removendo banners de cookies/anúncios/popups.
• Captura de componentes: capture a tela de um elemento específico (card, widget, gráfico) em vez da página inteira.

QuickstartLink to Quickstart

Envie uma requisição com url e seu x-api-key. O corpo da resposta é o arquivo gerado (binário).

Exemplo de requisição:

curl -L "https://api.capturekit.dev/v1/capture?x-api-key=YOUR_KEY&url=https://example.com" --output capture.png

Variações comuns:

Página inteira

curl -L "https://api.capturekit.dev/v1/capture?x-api-key=YOUR_KEY&url=https://example.com&full_page=true" --output full.png

Pré-visualização mobile

curl -L "https://api.capturekit.dev/v1/capture?x-api-key=YOUR_KEY&url=https://example.com&device=iphone_14_pro" --output mobile.png

Exportar PDF

curl -L "https://api.capturekit.dev/v1/capture?x-api-key=YOUR_KEY&url=https://example.com&format=pdf&full_page=true" --output page.pdf

ParâmetrosLink to Parâmetros

ObrigatóriosLink to Obrigatórios

• url (string): URL da página web para renderizar e capturar.

• x-api-key (string): Chave da API (pode ser enviada como query param, no header x-api-key ou no corpo da requisição).

SaídaLink to Saída

• format (opcional): Tipo de arquivo de saída (png por padrão; também suporta webp, jpeg/jpg, pdf).
• viewport_width / viewport_height (opcional): Controla o tamanho do viewport desktop.
• scale_factor (opcional): Aumenta a densidade de pixels para uma saída mais nítida.
• image_quality (opcional): Qualidade de compressão para webp / jpeg.

Testes mobile / responsivosLink to Testes mobile / responsivos

• device (opcional): Emula um perfil predefinido de dispositivo mobile/tablet.

Captura de página inteiraLink to Captura de página inteira

• full_page (opcional): Captura toda a altura da página.
• full_page_scroll / full_page_scroll_duration (opcional): Faz scroll para disparar conteúdo lazy-loaded durante a captura de página inteira.

Timing (páginas com muito JS)Link to Timing (páginas com muito JS)

• wait_for_selector (opcional): Aguarda até que um seletor CSS exista antes de capturar (ideal para SPAs).
• wait_until (opcional): Escolhe o evento de prontidão da página.
• delay (opcional): Tempo de espera fixo antes da captura.

Limpeza (remover overlays)Link to Limpeza (remover overlays)

• remove_cookie_banners (opcional): Tenta remover banners de cookies.
• remove_ads (opcional): Tenta remover anúncios.
• remove_selectors (opcional): Remove elementos específicos via seletores CSS.
• selector (opcional): Captura apenas um elemento específico.

Performance / roteamentoLink to Performance / roteamento

• block_urls (opcional): Bloqueia padrões de URL correspondentes (trackers, analytics).
• block_resources (opcional): Bloqueia tipos de recursos (imagens, fontes etc.).
• proxy (opcional): Roteia através de um proxy (casos geo / restrito / anti-bot).

CacheLink to Cache

• cache (opcional): Faz cache dos resultados para requisições repetidas.
• cache_ttl (opcional): TTL do cache em segundos.

Armazenamento (opcional)Link to Armazenamento (opcional)

• Upload para S3: s3_url + campos de bucket/credenciais para enviar diretamente para S3 ou storage compatível com S3.

Notas / limitesLink to Notas / limites

• Variabilidade da página: páginas dinâmicas podem mudar entre capturas; salve timestamps junto com seus outputs.
• SPAs precisam de esperas determinísticas: prefira wait_for_selector para resultados consistentes em sites pesados em JS.
• Página inteira + scroll infinito: páginas com conteúdo sem fim podem gerar renders de página inteira imprevisíveis.
• Limpeza não é universal: banners de cookies/anúncios variam por site; remove_selectors é o fallback mais confiável.
• Trade-offs de performance: scale_factor alto e capturas de página inteira aumentam o tamanho da saída e o tempo de renderização.
• Tratamento de resposta binária: trate as respostas como binárias (Blob/ArrayBuffer) no seu playground/cliente.