Pular para o conteúdo principal
POST
Extraia dados estruturados de páginas com LLMs
Observação: Uma nova versão v2 desta API agora está disponível, com recursos e desempenho aprimorados.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corpo

application/json
urls
string<uri>[]
obrigatório

As URLs das quais os dados serão extraídos. As URLs devem estar no formato glob.

Quando definido como true, a extração utilizará pesquisa na web para encontrar dados adicionais

ignoreInvalidURLs
boolean
padrão:false

Se URLs inválidas forem especificadas no array urls, elas serão ignoradas. Em vez de fazer com que a requisição inteira falhe, será realizada uma extração usando apenas as URLs válidas restantes, e as URLs inválidas serão retornadas no campo invalidURLs da resposta.

ignoreSitemap
boolean
padrão:false

Quando definido como true, os arquivos sitemap.xml serão ignorados durante a varredura do site

includeSubdomains
boolean
padrão:true

Quando definido como verdadeiro, os subdomínios das URLs fornecidas também serão rastreados

prompt
string

Prompt para guiar o processo de extração

schema
object

Esquema que define a estrutura dos dados extraídos. Deve estar em conformidade com o JSON Schema.

scrapeOptions
object
showSources
boolean
padrão:false

Quando definido como true, as fontes usadas para extrair os dados serão incluídas na resposta como a chave sources

threatProtection
Threat Protection Override · object

Substituição por solicitação da Proteção contra ameaças. Os campos fornecidos substituem os campos correspondentes da política da sua organização somente para esta solicitação; os campos omitidos mantêm os valores definidos no nível da organização. Exige que a Proteção contra ameaças esteja ativada para sua equipe (recurso enterprise) — caso contrário, a solicitação será rejeitada com 403. Se sua organização tiver desativado as substituições por solicitação, qualquer solicitação que inclua este objeto será rejeitada com 403. Se a Proteção contra ameaças for obrigatória para sua equipe, mode não poderá ser definido como off.

Resposta

Extração concluída com sucesso

id
string
invalidURLs
string[] | null

Se ignoreInvalidURLs for true, este será um array contendo as URLs inválidas especificadas na requisição. Se não houver URLs inválidas, será um array vazio. Se ignoreInvalidURLs for false, este campo ficará undefined.

success
boolean