获取批量提取任务状态

Extract

获取批量提取任务状态

GET

/batch/extract/{id}

获取批量提取任务状态

检查批量提取任务的状态并获取提取的数据。

响应状态：

processing：正在提取中
completed：所有提取已完成
failed：任务失败（查看错误详情）

结果格式： 结果数组中的每个 URL 包含：

匹配 Schema 的提取数据
成功/失败状态
适用时的单独错误消息
提取质量的置信度分数

授权

YOUR_API_KEY

授权Bearer <token>

在 Thunderbit Dashboard 获取 API key。请求头格式：Authorization: Bearer YOUR_API_KEY

位置: header

路径参数

id*string必填

批量任务 ID

查询参数

pageinteger默认值：0

Page number (0-based), default 0

取值范围：0 <= x

pageSizeinteger默认值：20

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

取值范围：1 <= x <= 100

响应

application/json

Success response

successboolean

dataobject

展开子属性

idstring

statusstring

totalinteger

completedinteger

creditsUsedinteger

resultsobject[]

展开子属性

urlstring

successboolean

dataobject[]

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

errorobject

展开子属性

codestring

示例：EXTRACT_FAILED

messagestring

createdAtstring

Timestamp when the job was created

completedAtstring

Timestamp when the job completed (null if still processing)

认证失败，无效的 API Key

successboolean

示例：

false

errorobject

展开子属性

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

示例：

false

errorobject

展开子属性

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

分页

pageSize 默认 20，单次请求上限 100。需要一次拿到最多结果时设为 pageSize=100。
当总量超过 100 时，递增 page（从 0 开始）直到 results 为空：page=0、page=1、依此类推。
响应里的 total 表示该批次的结果总数。

授权

路径参数

查询参数

响应

分页

目录