Prospect demo — Supadata (unofficial)
GET/youtube/batch/{jobId}

Get YouTube batch job status and results

Retrieves the status and results of a YouTube batch job identified by jobId. Use limit and offset to page through completed results in submission order, or omit both to receive all results in one streamed response.

3 parameters
jobIdstringrequired
The unique identifier of the batch job to retrieve.
limitintegeroptional
Maximum number of results to return. Must be between 1 and 500. Omit with `offset` to receive all results in one streamed response.
offsetintegeroptional
Number of results to skip in submission order. Must be zero or greater; use with `limit` to page through results.

4 status codes
200Returns the job status, results for each video, progress statistics, and completion timestamp when available. A result's `errorCode` can indicate that the job expired before finishing and its results are no longer available.
statusstringrequired
Current status of the batch job
Allowed:queuedactivecompletedfailed
errorCodestringoptional
Set to `job-expired` when the batch aged out before finishing; its results are no longer available.
Allowed:job-expired
resultsarray<object>required
Array of results for each video in the batch
statsobjectrequired
Statistics about the batch job progress
completedAtstringoptional
Timestamp when the job completed, if status is completed
400Returned when the request is invalid, including when `limit` or `offset` is outside its allowed range; the response includes an error code, message, and details.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
404Returned when the requested batch job cannot be found; the response includes an error code, message, and details.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
500Returned when an internal error occurs; the response includes an error code, message, and details.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation

Error handling

A 400 is returned when the request is invalid; limit must be between 1 and 500, and offset must be zero or greater. A 404 is returned when the batch job identified by the jobId path parameter cannot be found. A 500 is returned when an internal error occurs.