Obter Status da Tarefa de Extração em Lote

Extract

Obter Status da Tarefa de Extração em Lote

GET

/batch/extract/{id}

Verifique o status e recupere os dados extraídos de uma tarefa de extração em lote.

Estados da Resposta:

processing: Extração em progresso
completed: Todas as extrações concluídas
failed: Tarefa falhou (verifique detalhes do erro)

Formato dos Resultados: Cada URL no array de resultados contém:

Dados extraídos correspondentes ao seu esquema
Status de sucesso/falha
Mensagens de erro individuais, se aplicável
Pontuações de confiança para qualidade da extração

Autorização

YOUR_API_KEY

AutorizaçãoBearer <token>

Pegue sua API key no Thunderbit Dashboard. Formato do cabeçalho: Authorization: Bearer YOUR_API_KEY

Em: header

Parâmetros de caminho

id*stringobrigatório

ID da tarefa em lote

Parâmetros de consulta

pageintegerpredefinido:0

Page number (0-based), default 0

Intervalo necessário:0 <= x

pageSizeintegerpredefinido:20

Number of results per page (1-100), default 20

Intervalo necessário:1 <= x <= 100

Resposta

application/json

Success response

successboolean

dataobject

Mostrar atributos filhos

idstring

statusstring

totalinteger

completedinteger

creditsUsedinteger

resultsobject[]

Mostrar atributos filhos

urlstring

successboolean

dataobject[]

Extracted structured data for this URL (present when success is true)

errorobject

Mostrar atributos filhos

codestring

Exemplo:EXTRACT_FAILED

messagestring

createdAtstring

Timestamp when the job was created

completedAtstring

Timestamp when the job completed (null if still processing)

Autenticação falhou, Chave de API inválida

successboolean

Exemplo:

false

errorobject

Mostrar atributos filhos

codeany

Canonical error codes returned in the error.code field (LEGACY) or error.status field (GOOGLE_RPC). Codes are grouped by HTTP status:

400 Bad Request

INVALID_URL — URL format is invalid
INVALID_SCHEMA — JSON Schema is invalid
INVALID_PARAMETER — One or more request parameters failed validation
SCHEMA_OR_PROMPT_REQUIRED — schema (or prompt) is required for extraction
SCHEMA_AND_PROMPT_EXCLUSIVE — schema and prompt cannot both be provided
BATCH_SIZE_EXCEEDED — Batch request exceeds the 100-URL limit
MALFORMED_REQUEST_BODY — Request body is not valid JSON

401 Unauthorized

API_KEY_MISSING — Authorization header missing
API_KEY_INVALID_FORMAT — API key format is invalid
API_KEY_NOT_FOUND — API key not found in the system
API_KEY_REVOKED — API key has been revoked
API_KEY_DISABLED — API key has been disabled
API_KEY_EXPIRED — API key has expired
INVALID_API_KEY — (deprecated, use the specific API_KEY_ codes above)*

402 Payment Required

INSUFFICIENT_CREDITS — Not enough credits on the account

404 Not Found

JOB_NOT_FOUND — Batch job not found
RESOURCE_NOT_FOUND — Generic resource not found

408 Request Timeout

REQUEST_TIMEOUT — The API request timed out
SCRAPE_TIMEOUT — The target page took too long to respond

422 Unprocessable Entity

SCRAPE_SSL_ERROR — Target site has SSL/TLS problems
SCRAPE_DNS_RESOLUTION_ERROR — Cannot resolve target hostname
SCRAPE_SITE_ERROR — Target site returned an error
SCRAPE_EMPTY_CONTENT — Target page returned empty content
SCRAPE_CONTENT_TOO_LARGE — Target page exceeds size limits
SCRAPE_TARGET_FORBIDDEN — Target site refused access (403)
SCRAPE_TARGET_NOT_FOUND — Target URL returned 404
SCRAPE_UNSUPPORTED_FILE — Target file type is not supported

429 Too Many Requests

RATE_LIMIT_EXCEEDED — Account rate limit triggered
SCRAPE_TARGET_RATE_LIMITED — Target site rate-limited our request

500 Internal Server Error

INTERNAL_ERROR — Generic internal error
DISTILL_FAILED — Distillation pipeline failed
EXTRACT_FAILED — Extraction pipeline failed
PIPELINE_ERROR — Pipeline step reported a failure
AI_EXTRACTION_FAILED — AI extraction step failed
MARKDOWN_CONVERSION_FAILED — HTML-to-Markdown conversion failed

502 Bad Gateway

SCRAPE_ALL_PROVIDERS_FAILED — All scraping providers failed
UPSTREAM_BAD_GATEWAY — Upstream returned an invalid response

503 Service Unavailable

SCRAPE_PROVIDER_UNAVAILABLE — Scraping provider is unavailable
AI_SERVICE_UNAVAILABLE — AI service is unavailable
DOWNSTREAM_SERVICE_UNAVAILABLE — A downstream service is temporarily unavailable

504 Gateway Timeout

UPSTREAM_TIMEOUT — Upstream gateway timed out
AI_TIMEOUT — AI service call timed out

statusany

HTTP status code (LEGACY format) or canonical error code (GOOGLE_RPC format). See the API_ERROR_FORMAT note in the Error schema description

messagestring

Human-readable error message

detailsobject

Optional structured details — for example, field-level validation errors as { field: message } pairs

Resource not found

successboolean

Exemplo:

false

errorobject

Mostrar atributos filhos

codeany

Canonical error codes returned in the error.code field (LEGACY) or error.status field (GOOGLE_RPC). Codes are grouped by HTTP status:

400 Bad Request

INVALID_URL — URL format is invalid
INVALID_SCHEMA — JSON Schema is invalid
INVALID_PARAMETER — One or more request parameters failed validation
SCHEMA_OR_PROMPT_REQUIRED — schema (or prompt) is required for extraction
SCHEMA_AND_PROMPT_EXCLUSIVE — schema and prompt cannot both be provided
BATCH_SIZE_EXCEEDED — Batch request exceeds the 100-URL limit
MALFORMED_REQUEST_BODY — Request body is not valid JSON

401 Unauthorized

API_KEY_MISSING — Authorization header missing
API_KEY_INVALID_FORMAT — API key format is invalid
API_KEY_NOT_FOUND — API key not found in the system
API_KEY_REVOKED — API key has been revoked
API_KEY_DISABLED — API key has been disabled
API_KEY_EXPIRED — API key has expired
INVALID_API_KEY — (deprecated, use the specific API_KEY_ codes above)*

402 Payment Required

INSUFFICIENT_CREDITS — Not enough credits on the account

404 Not Found

JOB_NOT_FOUND — Batch job not found
RESOURCE_NOT_FOUND — Generic resource not found

408 Request Timeout

REQUEST_TIMEOUT — The API request timed out
SCRAPE_TIMEOUT — The target page took too long to respond

422 Unprocessable Entity

SCRAPE_SSL_ERROR — Target site has SSL/TLS problems
SCRAPE_DNS_RESOLUTION_ERROR — Cannot resolve target hostname
SCRAPE_SITE_ERROR — Target site returned an error
SCRAPE_EMPTY_CONTENT — Target page returned empty content
SCRAPE_CONTENT_TOO_LARGE — Target page exceeds size limits
SCRAPE_TARGET_FORBIDDEN — Target site refused access (403)
SCRAPE_TARGET_NOT_FOUND — Target URL returned 404
SCRAPE_UNSUPPORTED_FILE — Target file type is not supported

429 Too Many Requests

RATE_LIMIT_EXCEEDED — Account rate limit triggered
SCRAPE_TARGET_RATE_LIMITED — Target site rate-limited our request

500 Internal Server Error

INTERNAL_ERROR — Generic internal error
DISTILL_FAILED — Distillation pipeline failed
EXTRACT_FAILED — Extraction pipeline failed
PIPELINE_ERROR — Pipeline step reported a failure
AI_EXTRACTION_FAILED — AI extraction step failed
MARKDOWN_CONVERSION_FAILED — HTML-to-Markdown conversion failed

502 Bad Gateway

SCRAPE_ALL_PROVIDERS_FAILED — All scraping providers failed
UPSTREAM_BAD_GATEWAY — Upstream returned an invalid response

503 Service Unavailable

SCRAPE_PROVIDER_UNAVAILABLE — Scraping provider is unavailable
AI_SERVICE_UNAVAILABLE — AI service is unavailable
DOWNSTREAM_SERVICE_UNAVAILABLE — A downstream service is temporarily unavailable

504 Gateway Timeout

UPSTREAM_TIMEOUT — Upstream gateway timed out
AI_TIMEOUT — AI service call timed out

statusany

HTTP status code (LEGACY format) or canonical error code (GOOGLE_RPC format). See the API_ERROR_FORMAT note in the Error schema description

messagestring

Human-readable error message

detailsobject

Optional structured details — for example, field-level validation errors as { field: message } pairs

Paginação

pageSize tem valor padrão 20 e máximo de 100 por requisição. Defina pageSize=100 para obter o máximo em cada chamada.
Para lotes com mais de 100 resultados, incremente page (começando em 0) até que results esteja vazio: page=0, page=1, etc.
O campo total na resposta indica o número total de resultados do lote.

Autorização

Parâmetros de caminho

Parâmetros de consulta

Resposta

Paginação

On this page