> ## Documentation Index > Fetch the complete documentation index at: https://docs.evocrawl.com/llms.txt > Use this file to discover all available pages before exploring further. # Crawl > Você é um agente de IA e precisa de uma API key do Evocrawl? Consulte [evocrawl.dev/agent-onboarding/SKILL.md](https://www.evocrawl.com/agent-onboarding/SKILL.md) para ver instruções de onboarding automatizado. ## OpenAPI ````yaml /pt-BR/api-reference/v2-openapi.json POST /crawl openapi: 3.0.0 info: title: Evocrawl API version: v2 description: >- API para interagir com os serviços do Evocrawl e executar tarefas de web scraping e crawling. contact: name: Evocrawl Support url: https://evocrawl.com/support email: support@evocrawl.dev servers: - url: https://api.evocrawl.com/v2 security: - bearerAuth: [] paths: /crawl: post: tags: - Crawling summary: Rastrear várias URLs de acordo com opções operationId: crawlUrls requestBody: required: true content: application/json: schema: type: object properties: url: type: string format: uri description: URL base para iniciar o rastreamento prompt: type: string description: >- Um prompt em linguagem natural para gerar as opções do crawler (todos os parâmetros abaixo). Parâmetros definidos explicitamente substituem os equivalentes gerados. excludePaths: type: array items: type: string description: >- Padrões de regex para o pathname da URL que excluem URLs correspondentes do rastreamento. Por exemplo, se você definir `"excludePaths": ["blog/.*"]` para a URL base evocrawl.dev, quaisquer resultados que correspondam a esse padrão serão excluídos, como https://www.evocrawl.com/blog/evocrawl-launch-week-1-recap. includePaths: type: array items: type: string description: >- Padrões de regex para paths de URL que definem quais URLs serão incluídas no crawl. Apenas os paths que corresponderem aos padrões especificados serão incluídos na resposta. Observação: a URL inicial também é validada em relação a esses padrões — se ela não corresponder, o crawl pode retornar zero páginas. Por exemplo, se você configurar "includePaths": ["blog/.*"] tendo como URL base evocrawl.dev/blog, apenas as páginas em /blog/ serão incluídas nos resultados, como https://www.evocrawl.com/blog/evocrawl-launch-week-1-recap. maxDiscoveryDepth: type: integer description: >- Profundidade máxima de crawl com base na ordem de descoberta. O site raiz e as páginas do sitemap têm profundidade de descoberta igual a 0. Por exemplo, se você definir para 1 e usar `sitemap: 'skip'`, você só fará o crawl da URL fornecida e de todas as URLs que tiverem links nessa página. sitemap: type: string enum: - skip - include - only description: >- Modo de uso do sitemap durante o rastreamento. Se você definir como "skip", o crawler vai ignorar o sitemap do site e rastrear apenas a URL inicial, descobrindo novas páginas a partir dela. Se você definir como "only", o crawler vai rastrear somente as URLs presentes no sitemap (mais a URL inicial) e não vai seguir links encontrados no HTML. default: include ignoreQueryParameters: type: boolean description: >- Não faça scraping novamente do mesmo caminho com parâmetros de consulta diferentes (ou sem parâmetros) default: false regexOnFullURL: type: boolean description: >- Quando definido como true, os padrões de regex de includePaths e excludePaths serão comparados com a URL completa (incluindo parâmetros de consulta/query strings), em vez de apenas com o pathname da URL. Útil quando você precisa filtrar URLs com base em query strings. default: false limit: type: integer description: >- Número máximo de páginas a rastrear. O limite padrão é 10.000. default: 10000 crawlEntireDomain: type: boolean description: >- Permite que o crawler siga links internos para URLs no mesmo nível (irmãs) ou em níveis superiores (pai), não apenas subcaminhos (filhos). false: Só rastreia URLs em níveis inferiores (filhas). → ex.: /features/feature-1 → /features/feature-1/tips ✅ → Não seguirá /pricing ou / ❌ true: Rastreia quaisquer links internos, incluindo URLs irmãs e pai. → ex.: /features/feature-1 → /pricing, /, etc. ✅ Use true para uma cobertura interna mais ampla, além dos caminhos aninhados. default: false allowExternalLinks: type: boolean description: Permite que o rastreador siga links para sites externos. default: false allowSubdomains: type: boolean description: >- Permite que o rastreador siga links para subdomínios do domínio principal. default: false ignoreRobotsTxt: type: boolean description: >- Ignora as regras do robots.txt do site. Disponível apenas no Enterprise — entre em contato com support@evocrawl.com para habilitar. default: false robotsUserAgent: type: string description: >- String de User-Agent personalizada para a avaliação do robots.txt. Quando definida, o robots.txt é buscado com esse User-Agent, e as regras de permissão/bloqueio são verificadas com base nele em vez do padrão. Disponível apenas no Enterprise — entre em contato com support@evocrawl.com para habilitar. delay: type: number description: >- Intervalo, em segundos, entre operações de scraping. Isso ajuda a respeitar o limite de taxa do site. Definir esse valor força a concorrência para 1. maxConcurrency: type: integer description: >- Número máximo de raspagens concorrentes. Este parâmetro permite definir um limite de concorrência para este rastreamento. Se não for especificado, o rastreamento seguirá o limite de concorrência da sua equipe. webhook: type: object description: Objeto de especificação de webhook. properties: url: type: string description: >- A URL para a qual o webhook será enviado. Ele será disparado quando o rastreamento for iniciado (crawl.started), para cada página rastreada (crawl.page) e quando o rastreamento for concluído (crawl.completed ou crawl.failed). A resposta será a mesma do endpoint `/scrape`. headers: type: object description: Cabeçalhos que devem ser enviados para a URL do webhook. additionalProperties: type: string metadata: type: object description: >- Metadados personalizados que serão incluídos em todos os payloads de webhook deste rastreamento additionalProperties: true events: type: array description: >- Tipos de eventos a serem enviados para a URL do webhook. (padrão: todos) items: type: string enum: - completed - page - failed - started required: - url scrapeOptions: $ref: '#/components/schemas/ScrapeOptions' zeroDataRetention: type: boolean default: false description: >- Se definido como true, isso garantirá que nenhum dado seja retido para este crawl. Para ativar esse recurso, entre em contato com help@evocrawl.dev required: - url responses: '200': description: Resposta bem-sucedida content: application/json: schema: $ref: '#/components/schemas/CrawlResponse' '402': description: Pagamento obrigatório content: application/json: schema: type: object properties: error: type: string example: Payment required to access this resource. '429': description: Muitas solicitações content: application/json: schema: type: object properties: error: type: string example: >- Request rate limit exceeded. Please wait and try again later. '500': description: Erro no servidor content: application/json: schema: type: object properties: error: type: string example: An unexpected error occurred on the server. security: - bearerAuth: [] components: schemas: ScrapeOptions: type: object properties: formats: $ref: '#/components/schemas/Formats' onlyMainContent: type: boolean description: >- Retorne somente o conteúdo principal da página, excluindo cabeçalhos, elementos de navegação, rodapés etc. default: true includeTags: type: array items: type: string description: Tags a serem incluídas no resultado. excludeTags: type: array items: type: string description: Tags a serem excluídas da saída. maxAge: type: integer description: >- Retorna uma versão em cache da página se ela for mais recente do que essa idade em milissegundos. Se a versão em cache da página for mais antiga do que esse valor, a página será novamente coletada. Se você não precisa de dados extremamente atualizados, ativar isso pode acelerar suas coletas em até 500%. O padrão é 2 dias. default: 172800000 minAge: type: integer description: >- Quando definido, a requisição verifica apenas o cache e nunca aciona uma nova extração. O valor está em milissegundos e especifica a idade mínima que os dados em cache devem ter. Se houver dados em cache correspondentes, eles serão retornados instantaneamente. Se nenhum dado em cache for encontrado, será retornado um 404 com o código de erro SCRAPE_NO_CACHED_DATA. Defina como 1 para aceitar qualquer dado em cache, independentemente da idade. headers: type: object description: >- Cabeçalhos a serem enviados na requisição. Podem ser usados para enviar cookies, user-agent etc. waitFor: type: integer description: >- Defina um atraso, em milissegundos, antes de buscar o conteúdo, permitindo que a página tenha tempo suficiente para carregar. Esse tempo de espera é somado ao recurso de espera inteligente do Evocrawl. default: 0 mobile: type: boolean description: >- Defina como true se quiser emular a extração a partir de um dispositivo móvel. Útil para testar páginas responsivas e capturar screenshots da versão mobile. default: false skipTlsVerification: type: boolean description: Ignorar a verificação de certificado TLS ao realizar requisições. default: true timeout: type: integer description: >- Tempo limite, em milissegundos, para a solicitação. O mínimo é 1000 (1 segundo). O padrão é 60000 (60 segundos). O máximo é 300000 (300 segundos). default: 60000 minimum: 1000 maximum: 300000 parsers: type: array description: >- Controla como os arquivos são processados durante o scraping. Quando "pdf" é incluído (padrão), o conteúdo do PDF é extraído e convertido em markdown, com cobrança baseada no número de páginas (1 crédito por página). Quando um array vazio é fornecido, o arquivo PDF é retornado em codificação base64 com uma taxa fixa de 1 crédito para todo o PDF. items: oneOf: - type: object properties: type: type: string enum: - pdf mode: type: string enum: - fast - auto - ocr default: auto description: >- Modo de processamento de PDFs. "fast": extração apenas baseada em texto (usa o texto embutido, mais rápido). "auto" (padrão): tenta primeiro a extração rápida e, se necessário, recorre ao OCR. "ocr": força o processamento via OCR em todas as páginas. maxPages: type: integer minimum: 1 maximum: 10000 description: >- Número máximo de páginas do PDF a serem processadas. Deve ser um inteiro positivo de até 10.000. required: - type additionalProperties: false default: - pdf actions: type: array description: Ações a serem executadas na página antes de extrair o conteúdo items: oneOf: - title: Wait oneOf: - type: object title: Wait by Duration properties: type: type: string enum: - wait description: Esperar um número específico de milissegundos milliseconds: type: integer minimum: 1 description: Número de milissegundos a esperar required: - type - milliseconds additionalProperties: false - type: object title: Wait for Element properties: type: type: string enum: - wait description: Esperar até que um elemento específico apareça selector: type: string description: Seletor CSS do elemento a esperar example: '#my-element' required: - type - selector additionalProperties: false - type: object title: Screenshot properties: type: type: string enum: - screenshot description: >- Faça uma captura de tela. Os links estarão no array `actions.screenshots` da resposta. fullPage: type: boolean description: >- Define se a captura de tela deve abranger a página inteira (ignorando viewport.height) ou se deve ser limitada à viewport atual. default: false quality: type: integer description: >- A qualidade da captura de tela, de 1 a 100, onde 100 é a mais alta qualidade. viewport: type: object properties: width: type: integer description: Largura da viewport em pixels height: type: integer description: A altura da viewport, em pixels required: - width - height required: - type - type: object title: Click properties: type: type: string enum: - click description: Clique em um elemento selector: type: string description: Seletor para encontrar o elemento por example: '#load-more-button' all: type: boolean description: >- Clica em todos os elementos que correspondem ao seletor, não apenas no primeiro. Não lança um erro se nenhum elemento corresponder ao seletor. default: false required: - type - selector - type: object title: Write text properties: type: type: string enum: - write description: >- Digite o texto em um campo de entrada, área de texto ou elemento com conteúdo editável. Observação: primeiro é preciso colocar o foco no elemento usando uma ação de “clique” antes de escrever. O texto será digitado caractere por caractere para simular a entrada pelo teclado. text: type: string description: Texto a ser digitado example: Hello, world! required: - type - text - type: object title: Press a key description: >- Pressione qualquer tecla na página. Consulte https://asawicki.info/nosense/doc/devices/keyboard/key_codes.html para ver os códigos de tecla. properties: type: type: string enum: - press description: Pressione qualquer tecla na página key: type: string description: Tecla para pressionar example: Enter required: - type - key - type: object title: Scroll properties: type: type: string enum: - scroll description: Rolar a página ou um elemento específico direction: type: string enum: - up - down description: Sentido da rolagem default: down selector: type: string description: Seletor (query selector) do elemento a ser rolado example: '#my-element' required: - type - type: object title: Scrape properties: type: type: string enum: - scrape description: Raspa o conteúdo da página atual e retorna a URL e o HTML. required: - type - type: object title: Execute JavaScript properties: type: type: string enum: - executeJavascript description: Executar código JavaScript na página script: type: string description: Código JavaScript para executar example: document.querySelector('.button').click(); required: - type - script - type: object title: Generate PDF properties: type: type: string enum: - pdf description: >- Gerar um PDF da página atual. O PDF será retornado no array `actions.pdfs` da resposta. format: type: string enum: - A0 - A1 - A2 - A3 - A4 - A5 - A6 - Letter - Legal - Tabloid - Ledger description: O tamanho da página do PDF gerado default: Letter landscape: type: boolean description: Se o PDF deve ser gerado em orientação horizontal default: false scale: type: number description: O fator de escala do PDF gerado default: 1 required: - type location: type: object description: >- Configurações de localização da requisição. Quando definidas, será usado um proxy apropriado, se disponível, e serão emuladas as configurações correspondentes de idioma e fuso horário. O padrão é "US" se não for especificado. properties: country: type: string description: >- Código de país ISO 3166-1 alpha-2 (por exemplo, "US", "AU", "DE", "JP") pattern: ^[A-Z]{2}$ default: US languages: type: array description: >- Idiomas e localidades preferidos para a requisição, em ordem de prioridade. Por padrão, usa o idioma da localização especificada. Consulte https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language items: type: string example: en-US removeBase64Images: type: boolean description: >- Remove todas as imagens em base64 do resultado em markdown, que pode se tornar excessivamente longo. Isso não afeta os formatos html nem rawHtml. O texto alternativo da imagem permanece no resultado, mas a URL é substituída por um placeholder. default: true blockAds: type: boolean description: Habilita o bloqueio de anúncios e de pop-ups de cookies. default: true proxy: type: string enum: - basic - enhanced - auto description: |- Especifica o tipo de proxy a ser utilizado. - **basic**: Proxies para scraping de sites sem soluções anti‑bot ou apenas com soluções anti‑bot básicas. Rápido e geralmente funciona. - **enhanced**: Proxies avançados para scraping de sites com soluções anti‑bot avançadas. Mais lento, porém mais confiável em alguns sites. Pode custar até 5 créditos por requisição. - **auto**: O Evocrawl tentará automaticamente refazer o scraping com proxies enhanced se o proxy basic falhar. Se a nova tentativa com enhanced for bem-sucedida, 5 créditos serão cobrados pelo scraping. Se a primeira tentativa com basic for bem-sucedida, apenas o custo regular será cobrado. default: auto storeInCache: type: boolean description: >- Se definido como true, a página será armazenada no índice e no cache do Evocrawl. Definir isso como false é útil se sua atividade de scraping puder levantar preocupações relacionadas à proteção de dados. O uso de alguns parâmetros associados a scraping sensível (por exemplo, ações, headers) fará com que esse parâmetro seja definido automaticamente como false. default: true profile: type: object description: >- Ative o armazenamento persistente do navegador em sessões de scraping e interação. Informe um perfil ao fazer scraping para preservar cookies, localStorage e dados de sessão. Sessões com o mesmo nome de perfil compartilham o estado do navegador. properties: name: type: string minLength: 1 maxLength: 128 description: >- Um nome para o perfil. Scrapings com o mesmo nome compartilham o estado do navegador (cookies, localStorage, sessões). saveChanges: type: boolean default: true description: >- Quando verdadeiro, o estado do navegador é salvo de volta no perfil quando a sessão de interação é encerrada. Defina como falso para carregar dados existentes sem gravar. Apenas uma sessão de salvamento é permitida por vez. required: - name CrawlResponse: type: object properties: success: type: boolean id: type: string url: type: string format: uri Formats: type: array items: oneOf: - type: object title: Markdown properties: type: type: string enum: - markdown required: - type - type: object title: Summary properties: type: type: string enum: - summary required: - type - type: object title: HTML properties: type: type: string enum: - html required: - type - type: object title: Raw HTML properties: type: type: string enum: - rawHtml required: - type - type: object title: Links properties: type: type: string enum: - links required: - type - type: object title: Images properties: type: type: string enum: - images required: - type - type: object title: Screenshot properties: type: type: string enum: - screenshot fullPage: type: boolean description: >- Define se a captura de tela deve abranger a página inteira (ignorando viewport.height) ou se deve ser limitada à viewport atual. default: false quality: type: integer description: >- Qualidade da captura de tela, de 1 a 100. 100 é a qualidade máxima. viewport: type: object properties: width: type: integer description: Largura da viewport em pixels height: type: integer description: Altura da viewport em pixels required: - width - height required: - type - type: object title: JSON properties: type: type: string enum: - json schema: type: object description: >- O esquema a ser usado para a saída em JSON. Deve estar em conformidade com o [JSON Schema](https://json-schema.org/). prompt: type: string description: O prompt a ser usado para gerar a saída em JSON required: - type - type: object title: Change Tracking properties: type: type: string enum: - changeTracking modes: type: array items: type: string enum: - git-diff - json description: >- O modo a ser usado para rastrear alterações. 'git-diff' fornece um diff detalhado e 'json' compara os dados JSON extraídos. schema: type: object description: >- Esquema para extração de JSON ao usar o modo `json`. Define a estrutura dos dados a serem extraídos e comparados. Deve estar em conformidade com o [JSON Schema](https://json-schema.org/). prompt: type: string description: >- Prompt a ser usado para rastreamento de alterações ao usar o modo "json". Caso não seja fornecido, será usado o prompt padrão. tag: type: string nullable: true default: null description: >- Tag a ser usada para rastreamento de alterações. Tags podem separar o histórico de rastreamento de alterações em “branches” (ramificações) distintas, em que o rastreamento com uma tag específica só vai comparar com coletas feitas na mesma tag. Se não for fornecida, será usada a tag padrão (null). required: - type - type: object title: Branding properties: type: type: string enum: - branding required: - type - type: object title: Audio description: >- Extrai áudio (MP3) de URLs de vídeo compatíveis, como YouTube. Retorna uma URL assinada do GCS. properties: type: type: string enum: - audio required: - type description: >- Formatos de saída que devem ser incluídos na resposta. Você pode especificar um ou mais formatos, como strings (por exemplo, `'markdown'`) ou como objetos com opções adicionais (por exemplo, `{ type: 'json', schema: {...} }`). Alguns formatos exigem que opções específicas sejam configuradas. Exemplo: `['markdown', { type: 'json', schema: {...} }]`. default: - markdown securitySchemes: bearerAuth: type: http scheme: bearer ````