取得批次蒸餾任務狀態

Distill

取得批次蒸餾任務狀態

GET

/batch/distill/{id}

取得批次蒸餾任務狀態

檢查批次蒸餾任務的狀態並取得結果。

回應狀態：

processing：任務正在執行
completed：所有 URL 已處理完成
failed：任務遇到致命錯誤

輪詢最佳實踐：

少於 10 個 URL 的任務，每 5-10 秒輪詢一次
較大任務，每 30-60 秒輪詢一次
使用 Webhook 以獲得更好的效率

部分結果： 您可以在任務仍在處理時取得已完成的結果。results 陣列將包含到目前為止已處理的所有 URL。

授權

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

範例：

true

dataobject

展開子屬性

idstring

範例：batch_abc123

statusstring

範例：COMPLETED

totalinteger

範例：

completedinteger

範例：

failedinteger

Number of failed URLs

範例：

creditsUsedinteger

範例：

createdAtstring

Timestamp when the job was created

completedAtstring

Timestamp when the job completed (null if still processing)

resultsobject[]

展開子屬性

indexinteger

Zero-based index of this URL in the original batch

範例：

urlstring

The processed URL

statusstring

Per-URL processing status: PENDING, PROCESSING, SUCCEEDED, or FAILED

取值範圍"PENDING" | "PROCESSING" | "SUCCEEDED" | "FAILED"

範例：SUCCEEDED

markdownstring

Extracted markdown content (present when status is SUCCEEDED)

errorobject

Error detail (present when status is FAILED)

展開子屬性

codestring

範例：DISTILL_FAILED

messagestring

範例：Failed to fetch the page: Connection timeout

認證失敗，無效的 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 表示該批次的結果總數。

授權

路徑參數

查詢參數

回應

分頁

目錄