Skip to main content
GET
/
v1
/
jobs
/
{id}
Get job status and results
curl --request GET \
  --url https://api.reader.dev/v1/jobs/{id} \
  --header 'x-api-key: <api-key>'
{
  "data": {
    "id": "<string>",
    "completed": 123,
    "total": 123,
    "creditsUsed": 123,
    "error": "<string>",
    "results": [
      {
        "url": "<string>",
        "markdown": "<string>",
        "html": "<string>",
        "statusCode": 123,
        "proxyEscalated": true,
        "credits": 123,
        "metadata": {},
        "error": "<string>"
      }
    ],
    "startedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "pagination": {
    "total": 1234,
    "skip": 0,
    "limit": 20,
    "hasMore": true,
    "next": "https://api.reader.dev/v1/jobs/abc?skip=20&limit=20"
  }
}
Returns the current state of a job and a page of its results. Results are paginated with skip and limit query parameters (default limit 20, max 100). Use the pagination.next URL from the response to fetch subsequent pages. The SDK clients do this automatically via waitForJob() and getAllJobResults(). See Async jobs for the full lifecycle and result shape.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Query Parameters

​
skip
integer
Required range: x >= 0
​
limit
integer
Required range: 1 <= x <= 100

Response

Job details with paginated results

​
success
enum<boolean>
required
Available options:
true
​
data
object
required
​
pagination
object
required