AI Web Extraction API

API ID 14423

Turn any public web page into structured JSON with a plain-language instruction. Every numeric answer comes with a validation block that checks it against the page text and its history.

100% uptime 2,435 ms resp. média

Documentação da API

Endpoints

Requisição
Busca a página na URL dada (armazenada em cache por expiration_seconds, padrão 10 minutos) e pede a um modelo de linguagem pelos campos descritos em parse_description. Respostas numéricas são verificadas em relação ao texto da página e ao valor aceito anterior para a mesma URL e instrução; a verificação é retornada no objeto de validação e nunca bloqueia a resposta. Use este endpoint por padrão
Endpoint ID: 36427
GET https://zylalabs.com/api/14423/ai+web+extraction+api/36427/extract+from+page
PARÂMETROS DE ENTRADA

Extraído da página — Recursos do endpoint

Objeto Descrição
url Obrigatório Page to extract from: full URL including http:// or https://.
parse_description Obrigatório What to extract from the page, in plain language. Name the fields you want back.
expiration_seconds Opcional Reuse a previous scrape and answer for the same URL and instruction if it is at most this many seconds old. Default 600 (10 minutes). 0 forces a fresh scrape.
raw_text Opcional true: the model also returns the value exactly as written on the page, in data and in validation.raw_text. Default false.
value_field Opcional Key of the answer that holds the number to check, when the answer has more than one number. Default: the answer's single number.
last_value Opcional Your last known value for this URL and instruction; big jumps against it are flagged in validation. Default: the service's own history.
max_chars Opcional Characters of page text sent to the model after pruning. Default 6000. 0 sends the whole page.

Solicitações gratuitas de teste restantes: 3 de 3.


PARÂMETROS DE ENTRADA

url
parse_description
expiration_seconds
raw_text
value_field
last_value
max_chars
RESPOSTA DE EXEMPLO DA API
JSON
{
    "data": [
        {
            "value": "4010.00",
            "raw_text": "4,010.00"
        }
    ],
    "validation": {
        "status": "ok",
        "reason": "no_reference",
        "value": 4010,
        "model_value": 4010,
        "raw_text": "4,010.00",
        "reference": null,
        "change_pct": null,
        "suspect_pct": 10,
        "reject_pct": 30,
        "on_page": true,
        "votes": [],
        "mode": "shadow",
        "reference_source": null
    }
}
Extraído da página — TRECHOS DE CÓDIGO

curl --location --request GET 'https://zylalabs.com/api/14423/ai+web+extraction+api/36427/extract+from+page?url=https://www.investing.com/commodities/gold&parse_description=Current gold futures price as a plain number, in a field called value&expiration_seconds=600&raw_text=true&value_field=value&last_value=4012.5&max_chars=6000' --header 'Authorization: Bearer YOUR_API_KEY' 


    
Requisição
Renderiza a página em um navegador, tira uma captura de tela de toda a página e pede a um modelo de visão pelos campos descritos nas instruções do llm. Use quando os dados aparecem apenas depois que a página é renderizada: gráficos, widgets, tabelas em canvas ou aplicativos pesados em JavaScript. Mais lento do que Extrair da Página. Respostas numéricas são verificadas em relação ao seu histórico e relatadas no objeto de validação
Endpoint ID: 36428
GET https://zylalabs.com/api/14423/ai+web+extraction+api/36428/extract+from+screenshot
PARÂMETROS DE ENTRADA

Extraído da captura de tela — Recursos do endpoint

Objeto Descrição
url Obrigatório Page to extract from: full URL including http:// or https://.
llm_instructions Obrigatório What to read from a screenshot of the page, in plain language. Name the fields you want back.
expiration_seconds Opcional Reuse a previous screenshot and answer for the same URL and instruction if it is at most this many seconds old. Default 600 (10 minutes). 0 forces a fresh capture.
value_field Opcional Key of the answer that holds the number to check, when the answer has more than one number. Default: the answer's single number.
last_value Opcional Your last known value for this URL and instruction; big jumps against it are flagged in validation. Default: the service's own history.

Solicitações gratuitas de teste restantes: 3 de 3.


PARÂMETROS DE ENTRADA

url
llm_instructions
expiration_seconds
value_field
last_value
RESPOSTA DE EXEMPLO DA API
JSON
{
    "data": [
        {
            "value": 4066.5
        }
    ],
    "validation": {
        "status": "ok",
        "reason": "no_reference",
        "value": 4066.5,
        "model_value": 4066.5,
        "raw_text": null,
        "suspect_pct": 10,
        "reject_pct": 30,
        "on_page": null,
        "votes": [],
        "mode": "shadow"
    }
}
Extraído da captura de tela — TRECHOS DE CÓDIGO

curl --location --request GET 'https://zylalabs.com/api/14423/ai+web+extraction+api/36428/extract+from+screenshot?url=https://www.investing.com/commodities/gold&llm_instructions=Current gold price in USD as a number, in a field called value&expiration_seconds=600&value_field=value&last_value=4012.5' --header 'Authorization: Bearer YOUR_API_KEY' 


    

Chave de acesso à API e autenticação

Após se cadastrar, cada desenvolvedor recebe uma chave de acesso à API pessoal, uma combinação única de letras e dígitos para acessar nosso endpoint de API. Para autenticar com a AI Web Extraction API basta incluir seu token Bearer no cabeçalho Authorization.

Cabeçalhos
Cabeçalho Descrição
Authorization Obrigatório Deve ser Bearer access_key. Veja "Sua chave de acesso à API" acima quando você estiver inscrito.

Sem compromisso de longo prazo. Faça upgrade, downgrade ou cancele a qualquer momento.

(Economize 2 meses com cobrança anual 🎉)

A partir de
$10.000/Ano


  • Volume personalizado
  • Limite de taxa personalizado
  • Suporte ao cliente especializado
  • Monitoramento de API em tempo real

Visão Geral

AI Web Extraction API turns any public web page into structured JSON. Send a URL and say in plain language what you need, for example current gold futures price as a number, in a field called value. The service fetches the page, prunes it, asks a large language model for exactly those fields and returns them as JSON.

What makes it different: validated numbers

Language models misread pages: they drop a decimal point (27015 instead of 270.15), pick a neighbouring row, or echo a number from the instruction. Every numeric answer is therefore checked before it is returned:

  • On the page. The raw text the model read is searched in the page it was extracted from. If it is not there, the value was invented or misread.
  • Decimal shift. Values that are exactly x10, x100, x0.1 or x0.01 of the previous value are flagged.
  • Outlier. The value is compared with the last accepted value for the same URL and instruction (or with last_value if you send yours).

The result comes in a validation object: status (ok, suspect, rejected or unchecked), reason, raw_text exactly as written on the page, on_page, and the thresholds used. The check is informational: you always receive the answer and decide what to do with it. The same pipeline runs in production on hundreds of thousands of extractions per month for commodity, metal and index prices.

Two endpoints

  • Extract From Page reads the HTML text of the page. Fast and cheap; use it by default.
  • Extract From Screenshot renders the page, takes a full-page screenshot and asks a vision model. For charts, widgets, canvas tables and JavaScript-heavy apps whose data only appears once rendered.

Both accept an optional cache window (expiration_seconds, default 10 minutes), your own reference value (last_value) and the name of the field that holds the number when the answer has several (value_field).

Example

Request: the URL of a gold futures quote page and parse_description=Current gold futures price as a plain number, in a field called value

{
  "data": [{ "value": "4010.00", "raw_text": "4,010.00" }],
  "validation": {
    "status": "ok", "reason": "no_reference",
    "value": 4010.0, "raw_text": "4,010.00", "on_page": true,
    "suspect_pct": 10.0, "reject_pct": 30.0
  }
}

Typical uses

  • Price monitoring from supplier, exchange or retailer pages
  • Competitor tracking: prices, availability, specs
  • Pulling figures from reports, dashboards and statistics pages
  • Feeding AI agents with live numbers they can trust
  • Replacing brittle CSS selectors with one instruction that survives page redesigns

Good instructions

Name the fields you want back and be specific about which number: "the Last Price in the quote header, keeping its decimal point, in a field called value" works better than "the price". Do not put example numbers or ranges in the instruction: if the data is missing, a model tends to return the example.

AI Web Extraction API FAQs

Um objeto JSON com duas partes: dados, os campos que você pediu na sua instrução, e validação, uma verificação do valor numérico principal (status ok, suspeito, rejeitado ou não verificado, o motivo, o texto bruto conforme escrito na página e os limites usados)

Em linguagem simples, através de parse_description (ponto de extremidade de texto) ou llm_instructions (ponto de extremidade de captura de tela). Nomeie os campos que deseja de volta, por exemplo "nome do produto, preço em USD como um número e disponibilidade, em campos chamados nome, preço e em_estoque"

Use Extrair da Página por padrão é mais rápido e funciona no texto da página Mude para Extrair de Captura de Tela quando os dados só aparecem uma vez que a página é renderizada como gráficos widgets tabelas em canvas ou aplicativos pesados em JavaScript

Se o número está realmente escrito na página (on_page), se parece uma mudança decimal (x10, x100) e quão longe ele se moveu do último valor aceito para a mesma URL e instrução Você sempre recebe a resposta o status informa quanto confiar nela

Sim envie last_value com o último número que você armazenou para esse URL e instrução e a validação compara com ele em vez do histórico de serviços Use value_field quando sua resposta tiver vários números

Não A página e a resposta são reutilizadas para a mesma URL e instrução enquanto forem mais jovens que expiration_seconds (padrão 600 segundos) Envie 0 para forçar uma nova obtenção

Extrair da Página lê o texto renderizado pelo servidor Para conteúdo que só aparece depois que a página executa seus scripts use Extrair da Captura de Tela que renderiza a página em um navegador antes de lê-la

A resposta vem com erro verdadeiro e uma mensagem descrevendo o problema (página bloqueada, tempo limite, erro a montante) A chamada não é contada como bem-sucedida

Nomeie os campos que você deseja de volta e diga qual número você quer dizer "o Último Preço no cabeçalho da citação, mantendo seu ponto decimal, em um campo chamado valor" Evite números ou faixas de exemplo na instrução quando os dados estiverem ausentes, um modelo tende a retornar o exemplo

Não O bloco de validação é informativo você sempre recebe o valor extraído mais o status a razão e se o texto bruto foi encontrado na página Rejeite ou tente novamente do seu lado com base no status quando o número é importante

Perguntas Frequentes Gerais

O Zyla API Hub é como uma grande loja de APIs, onde você pode encontrar milhares delas em um só lugar. Também oferecemos suporte dedicado e monitoramento em tempo real de todas as APIs. Após se cadastrar, você pode escolher quais APIs deseja usar. Lembre-se apenas de que cada API precisa de sua própria assinatura. Mas se você se inscrever em várias, usará a mesma chave para todas elas, facilitando as coisas para você.
Os preços são listados em USD (Dólar Americano), EUR (Euro), CAD (Dólar Canadense), AUD (Dólar Australiano) e GBP (Libra Esterlina). Aceitamos todos os principais cartões de débito e crédito. Nosso sistema de pagamento usa a mais recente tecnologia de segurança e é operado pela Stripe, uma das empresas de pagamento mais confiáveis do mundo. Se tiver problemas para pagar com cartão, entre em contato conosco em [email protected]

Além disso, se você já tiver uma assinatura ativa em qualquer uma dessas moedas (USD, EUR, CAD, AUD, GBP), essa moeda será mantida para assinaturas subsequentes. Você pode alterar a moeda a qualquer momento, desde que não tenha assinaturas ativas.
A moeda local exibida na página de preços é baseada no país do seu endereço IP e é fornecida apenas como referência. Os preços reais são em USD (Dólar Americano). Ao efetuar o pagamento, a cobrança aparecerá no extrato do seu cartão em USD, mesmo que você veja o valor equivalente em sua moeda local em nosso site. Isso significa que você não pode pagar diretamente com sua moeda local.
Ocasionalmente, o banco pode recusar a cobrança devido às configurações de proteção contra fraude. Sugerimos contatar seu banco inicialmente para verificar se estão bloqueando nossas cobranças. Você também pode acessar o Portal de Cobrança e alterar o cartão associado para realizar o pagamento. Se isso não funcionar e precisar de mais ajuda, entre em contato com nossa equipe em [email protected]
Os preços são determinados por uma assinatura recorrente mensal ou anual, dependendo do plano escolhido.
As chamadas de API são descontadas do seu plano com base nas requisições bem-sucedidas. Cada plano possui um número específico de chamadas por mês. Apenas chamadas bem-sucedidas, indicadas por uma resposta com Status 200, serão contabilizadas, garantindo que falhas não afetem sua cota mensal.
O Zyla API Hub funciona com um sistema de assinatura mensal recorrente. Seu ciclo de cobrança começa no dia em que você compra um dos planos pagos e será renovado no mesmo dia do mês seguinte. Portanto, cancele sua assinatura com antecedência se quiser evitar cobranças futuras.
Para fazer upgrade do seu plano atual, acesse a página de preços da API e selecione o novo plano desejado. O upgrade é instantâneo, permitindo aproveitar imediatamente os recursos do novo plano. Observe que as chamadas restantes do plano anterior não serão transferidas; você será cobrado pelo valor integral do novo plano.
Para verificar quantas chamadas de API restam para o mês atual, consulte o campo 'X-Zyla-API-Calls-Monthly-Remaining' no cabeçalho da resposta. Por exemplo, se seu plano permite 1.000 requisições por mês e você usou 100, este campo no cabeçalho da resposta indicará 900 chamadas restantes.
Para ver o número máximo de requisições de API que seu plano permite, verifique o cabeçalho de resposta 'X-Zyla-RateLimit-Limit'. Por exemplo, se seu plano inclui 1.000 requisições por mês, este cabeçalho exibirá 1.000.
O cabeçalho 'X-Zyla-RateLimit-Reset' mostra o número de segundos até seu limite de taxa ser redefinido. Isso informa quando sua contagem de requisições começará do zero. Por exemplo, se exibir 3.600, significa que restam 3.600 segundos até o limite ser redefinido.
Sim, você pode cancelar seu plano a qualquer momento acessando sua conta e selecionando a opção de cancelamento na página de Cobrança. Observe que upgrades, downgrades e cancelamentos têm efeito imediato. Além disso, após o cancelamento, você não terá mais acesso ao serviço, mesmo que ainda tenha chamadas restantes na sua cota.
Para oferecer a oportunidade de experimentar nossas APIs sem compromisso, oferecemos um teste gratuito de 7 dias que permite realizar até 50 chamadas de API sem custo. Esse teste pode ser usado apenas uma vez; recomendamos aplicá-lo à API que mais interessa. Embora a maioria das APIs ofereça teste gratuito, algumas podem não oferecer. O teste termina após 7 dias ou quando você atingir 50 requisições, o que ocorrer primeiro. Se atingir o limite, será necessário "Iniciar seu plano pago" para continuar. Você encontra esse botão no perfil em Assinatura -> Escolha a API -> aba Preços. Se não cancelar até o 7º dia, sua assinatura será cobrada automaticamente, liberando todas as chamadas do plano.
Após 7 dias, será cobrado o valor total do plano ao qual você estava inscrito durante o teste. Portanto, é importante cancelar antes do término do período. Solicitações de reembolso por esquecimento de cancelamento não são aceitas.
Ao assinar um teste gratuito de API, você pode fazer até 50 chamadas. Se desejar fazer chamadas adicionais além desse limite, a API solicitará que você "Inicie seu plano pago". Você encontra o botão no perfil em Assinatura -> Escolha a API -> aba Preços.
As Ordens de Pagamento são processadas entre os dias 20 e 30 de cada mês. Se você enviar sua solicitação antes do dia 20, seu pagamento será processado dentro desse período.
Você pode nos contatar via chat para receber assistência imediata. Estamos online de 8h às 17h (EST). Se nos contatar após esse horário, retornaremos o mais rápido possível. Além disso, você pode enviar um e-mail para [email protected]

APIs relacionadas