Stapel-Destillationsauftragsstatus abrufen

Distill

Stapel-Destillationsauftragsstatus abrufen

GET

/batch/distill/{id}

Status prüfen und Ergebnisse eines Stapel-Destillationsauftrags abrufen.

Antwortstatus:

processing: Auftrag wird derzeit ausgeführt
completed: Alle URLs wurden verarbeitet
failed: Auftrag ist auf einen schwerwiegenden Fehler gestoßen

Best Practices für Abfragen:

Alle 5-10 Sekunden abfragen für Aufträge mit <10 URLs
Alle 30-60 Sekunden abfragen für größere Aufträge
Webhooks für bessere Effizienz verwenden

Teilergebnisse: Sie können abgeschlossene Ergebnisse abrufen, während der Auftrag noch läuft. Das results-Array enthält alle bisher verarbeiteten URLs.

Autorisierung

YOUR_API_KEY

AutorisierungBearer <token>

Hol deinen API-Key aus dem Thunderbit Dashboard. Header-Format: Authorization: Bearer YOUR_API_KEY

In: header

Pfadparameter

id*stringerforderlich

Stapelauftrags-ID

Abfrageparameter

pageintegerStandard:0

Page number (0-based), default 0

Erforderlicher Bereich:0 <= x

pageSizeintegerStandard:20

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

Erforderlicher Bereich:1 <= x <= 100

Antwort

application/json

Success response

successboolean

Beispiel:

true

dataobject

Untergeordnete Attribute anzeigen

idstring

Beispiel:batch_abc123

statusstring

Beispiel:COMPLETED

totalinteger

Beispiel:

completedinteger

Beispiel:

failedinteger

Number of failed URLs

Beispiel:

creditsUsedinteger

Beispiel:

createdAtstring

Timestamp when the job was created

completedAtstring

Timestamp when the job completed (null if still processing)

resultsobject[]

Untergeordnete Attribute anzeigen

indexinteger

Zero-based index of this URL in the original batch

Beispiel:

urlstring

The processed URL

statusstring

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

Wert aus"PENDING" | "PROCESSING" | "SUCCEEDED" | "FAILED"

Beispiel:SUCCEEDED

markdownstring

Extracted markdown content (present when status is SUCCEEDED)

errorobject

Error detail (present when status is FAILED)

Untergeordnete Attribute anzeigen

codestring

Beispiel:DISTILL_FAILED

messagestring

Beispiel:Failed to fetch the page: Connection timeout

Authentifizierung fehlgeschlagen, ungültiger API-Schlüssel

successboolean

Beispiel:

false

errorobject

Untergeordnete Attribute anzeigen

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

Beispiel:

false

errorobject

Untergeordnete Attribute anzeigen

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

Paginierung

pageSize ist standardmäßig 20 und maximal 100 pro Anfrage. Setze pageSize=100, um pro Aufruf das Maximum zu erhalten.
Bei Batches mit mehr als 100 Ergebnissen erhöhe page (0-basiert), bis results leer ist: page=0, page=1, usw.
total in der Antwort gibt die Gesamtzahl der Ergebnisse im Batch an.

Autorisierung

Pfadparameter

Abfrageparameter

Antwort

Paginierung

On this page