GET/v2/batch/scrape/{id}
Requires an API key.
Parameters
idpath, stringrequiredThe batch scrape ID.
Responses
OK
Type BatchScrapeStatusResponse
completedinteger (int64)requiredNumber of URLs done so far.
completedAtstring (date-time)When the last URL got its result.
createdAtstring (date-time)requiredexpiresAtstring (date-time)requiredWhen the results expire.
packageBatchScrapePackagerequiredThe batch scrape's results package.
3 fields inside package
bytesinteger (int64)The package's size in bytes, gzipped, set once status is ready.
statusstringrequiredpending until the batch scrape ends and its results are packaged; failed when packaging gave up, which refunded the batch scrape's credits.
One of
pending,ready,failedurlstringThe download URL, set once status is ready. It answers 302 to the gzipped NDJSON file, one document per line in URL order.
statusstringrequiredcompleted once every URL is done; cancelled after a cancel, whose unfetched URLs end with errorCode cancelled.
One of
scraping,completed,cancelledsuccessbooleanrequiredAlways true.
One of
truetotalinteger (int64)requiredNumber of URLs.
webhookErrorWebhookEventErrorsWhy a webhook event failed.
2 fields inside webhookError
finishstringWhy the finish event failed.
startstringWhy the start event failed.
webhookStatusWebhookEventStatusesDelivery status of each webhook event.
2 fields inside webhookStatus
finishstringDelivery status of the finish event.
One of
pending,delivered,failedstartstringDelivery status of the start event.
One of
pending,delivered,failed
UNAUTHORIZED: The API key is invalid or revoked; API_KEY_REQUIRED: This endpoint needs an API key; INVALID_ACCESS_TOKEN: The OAuth access token is unknown, expired or revoked, or was sent to an endpoint other than /mcp, the only one it works on.
Type UnauthorizedResponse
codestringrequiredA machine-readable error code.
One of
UNAUTHORIZED,API_KEY_REQUIRED,INVALID_ACCESS_TOKENdetailsarray of ValidationErrorDetail or nullThe invalid fields.
3 fields inside details
locationstringWhere the error occurred, e.g. body.urls[3].
messagestringWhat went wrong.
valueanyThe rejected value.
errorstringrequiredA human-readable message.
successbooleanrequiredAlways false.
One of
false
SCRAPE_NOT_FOUND: The scrape does not exist, has expired or is another caller's; BATCH_SCRAPE_NOT_FOUND: The batch scrape does not exist, has expired or is another caller's, or the download token does not match.
Type NotFoundResponse
codestringrequiredA machine-readable error code.
One of
SCRAPE_NOT_FOUND,BATCH_SCRAPE_NOT_FOUNDdetailsarray of ValidationErrorDetail or nullThe invalid fields.
3 fields inside details
locationstringWhere the error occurred, e.g. body.urls[3].
messagestringWhat went wrong.
valueanyThe rejected value.
errorstringrequiredA human-readable message.
successbooleanrequiredAlways false.
One of
false
VALIDATION_FAILED: One or more fields are invalid; TOO_MANY_URLS: The request has more URLs than your rate limit allows; IDEMPOTENCY_CONFLICT: The Idempotency-Key was already used with a different request.
Type ValidationFailedResponse
codestringrequiredA machine-readable error code.
One of
VALIDATION_FAILED,TOO_MANY_URLS,IDEMPOTENCY_CONFLICTdetailsarray of ValidationErrorDetail or nullThe invalid fields.
3 fields inside details
locationstringWhere the error occurred, e.g. body.urls[3].
messagestringWhat went wrong.
valueanyThe rejected value.
errorstringrequiredA human-readable message.
successbooleanrequiredAlways false.
One of
false
RATE_LIMITED: Rate limit exceeded, retry after Retry-After seconds.
Headers
Retry-AfterintegerSeconds to wait before retrying.
minimum 1
Type TooManyRequestsResponse
codestringrequiredA machine-readable error code.
One of
RATE_LIMITEDdetailsarray of ValidationErrorDetail or nullThe invalid fields.
3 fields inside details
locationstringWhere the error occurred, e.g. body.urls[3].
messagestringWhat went wrong.
valueanyThe rejected value.
errorstringrequiredA human-readable message.
successbooleanrequiredAlways false.
One of
false
INTERNAL_ERROR: Something went wrong on our side, try again.
Type InternalErrorResponse
codestringrequiredA machine-readable error code.
One of
INTERNAL_ERRORdetailsarray of ValidationErrorDetail or nullThe invalid fields.
3 fields inside details
locationstringWhere the error occurred, e.g. body.urls[3].
messagestringWhat went wrong.
valueanyThe rejected value.
errorstringrequiredA human-readable message.
successbooleanrequiredAlways false.
One of
false