> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Web web Batch Status API
> Check a batch scrape and read the finished pages. Call the Web web Batch Status API for JSON. 0 credits per call. Every call returns the same flat shape.
Check a batch scrape and read the finished pages.
## Request
`id` is required.
```typescript TypeScript icon="https://mintlify.s3.us-west-1.amazonaws.com/sirathic/images/icons/typescript.svg" theme={null} theme={null}
import { Stophy } from "stophy";
const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.web.batch.status({ id: "job_Ab3dE5gH7jK9mN1pQ3sT5v" });
console.log(result.data.results);
```
```python Python icon="python" theme={null} theme={null}
from stophy import Stophy
stophy = Stophy() # reads STOPHY_API_KEY
result = stophy.web.batch.status(id="job_Ab3dE5gH7jK9mN1pQ3sT5v")
print(result["data"]["results"])
```
```bash cURL icon="terminal" theme={null} theme={null}
curl -X POST https://api.stophy.dev/v1/web/batch/status \
-H "Authorization: Bearer $STOPHY_API_KEY" \
-H "content-type: application/json" \
-d '{"id":"job_Ab3dE5gH7jK9mN1pQ3sT5v"}'
```
```bash CLI icon="square-terminal" theme={null} theme={null}
stophy web batch status job_Ab3dE5gH7jK9mN1pQ3sT5v
```
## Response
If successful, the response body contains the standard envelope. `data` contains the batch's progress and credits used, and `results` lists the pages read so far.
The following example is a real response, truncated: each list shows one item and long strings are cut.
```json theme={null}
{
"success": true,
"data": {
"id": "job_BC0vf8IzmDUA4VeGy9M7tA",
"status": "completed",
"total": 2,
"completed": 2,
"failed": 0,
"creditsUsed": 2,
"results": [
{
"markdown": "[Bun RuntimeA fast JavaScript runtime designed as a drop-in replacement for Node.jsGet started with `bun…",
"isTruncated": false,
"metadata": {
"title": "Welcome to Bun | Bun Docs",
"description": "Bun is an all-in-one toolkit for developing modern JavaScript/TypeScript applications.",
"language": "en",
"ogImage": "https://bun.com/og/docs.png",
"sourceURL": "https://bun.com/docs",
"statusCode": 200,
"contentType": "text/html",
"cacheState": "miss"
},
"url": "https://bun.com/docs"
}
]
},
"creditsUsed": 0,
"requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}
```
| Field | Type | Description |
| - | - | - |
| `total` | integer | The total number of matching results, across all pages. |
For every field, see the response schema on this page.
Send the cursor from the last answer to get only the pages finished since. A batch and its pages are kept for 24 hours.
## Optional parameters
| Parameter | Type | Description |
| - | - | - |
| `cursor` | string | The pagination token from the previous response. |
## Billing
Each successful request consumes 0 credits, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.
## Pagination
Results are paginated. To retrieve the next page, pass the value of `data.cursor` as `cursor` in a subsequent request. A response that omits `cursor` is the last page.
## OpenAPI
````yaml api-reference/openapi.json POST /v1/web/batch/status
openapi: 3.1.0
info:
title: Stophy API
version: '1'
description: >-
Every endpoint is a POST that takes its input as a JSON object body. Unknown
fields are rejected with 400.
Responses leave out empty values: null, empty strings, empty objects and
empty nested lists are not sent.
Text comes back whole. To get shorter responses, add
?maxTextLength= to the URL. Every text value longer than that is
cut and ends with …. A screenshot is never cut, and a page whose text was
cut has isTruncated set to true.
x-credits is what one call costs. Every call costs the same, whatever it
returns, unless an operation's description says it costs per 10 results, or
per second of audio. Then x-credits is the lowest price and x-credits-max
the most one call can cost. Where an operation takes limit, send it to
return fewer results and pay for fewer.
When a response has a cursor, send it back unchanged with the same input to
get the next page. When it has a page, send the next page number.
servers:
- url: https://api.stophy.dev
security:
- apiKey: []
paths:
/v1/web/batch/status:
post:
summary: Check a batch scrape and read the finished pages
description: Costs 0 credits per call. Pages with cursor.
operationId: webBatchStatus
parameters:
- $ref: '#/components/parameters/MaxTextLength'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
id:
type: string
pattern: ^job_[A-Za-z0-9_-]{22}$
description: The id web.batch returned.
cursor:
type: string
minLength: 1
description: The cursor from the previous response. Send it as is.
required:
- id
additionalProperties: false
responses:
'200':
description: The data, and the credits this call used.
headers:
X-Request-ID:
$ref: '#/components/headers/RequestId'
x-credits-used:
$ref: '#/components/headers/CreditsUsed'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
x-cache:
$ref: '#/components/headers/Cache'
x-cache-age:
$ref: '#/components/headers/CacheAge'
content:
application/json:
schema:
type: object
required:
- success
- data
- creditsUsed
- requestId
properties:
success:
const: true
data:
type: object
additionalProperties: false
properties:
id:
type: string
status:
type: string
enum:
- queued
- running
- completed
- cancelled
- failed
total:
type: integer
minimum: 0
maximum: 9007199254740991
completed:
type: integer
minimum: 0
maximum: 9007199254740991
failed:
type: integer
minimum: 0
maximum: 9007199254740991
creditsUsed:
type: integer
minimum: 0
maximum: 9007199254740991
message:
type: string
errors:
type: array
items:
type: object
additionalProperties: false
properties:
url:
type: string
code:
type: string
message:
type: string
required: []
results:
type: array
items:
type: object
additionalProperties: false
properties:
markdown:
type: string
html:
type: string
rawHtml:
type: string
links:
type: array
items:
type: string
screenshot:
type: string
isTruncated:
type: boolean
metadata:
type: object
additionalProperties: false
properties:
title:
type: string
description:
type: string
language:
type: string
ogImage:
type: string
sourceURL:
type: string
statusCode:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
contentType:
type: string
cacheState:
type: string
enum:
- hit
- miss
cachedAt:
type: string
format: date-time
pattern: >-
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
numPages:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
required:
- statusCode
- cacheState
url:
type: string
required:
- isTruncated
- metadata
cursor:
type: string
required:
- status
- total
- completed
- failed
- creditsUsed
- results
- errors
creditsUsed:
type: integer
requestId:
type: string
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
components:
parameters:
MaxTextLength:
name: maxTextLength
in: query
required: false
description: >-
Cut every text value in the response to this many characters. A value
that was cut ends with …, and a page whose text was cut has isTruncated
set to true. A screenshot is never cut. Leave it out to get the full
text.
schema:
type: integer
minimum: 1
headers:
RequestId:
description: The request id. Quote it when you report a problem.
schema:
type: string
CreditsUsed:
description: Credits this call used.
schema:
type: integer
RateLimitLimit:
description: Requests allowed in the current window.
schema:
type: integer
RateLimitRemaining:
description: Requests left in the current window.
schema:
type: integer
RateLimitReset:
description: Unix time in seconds when the current window resets.
schema:
type: integer
Cache:
description: hit if this result came from the cache, miss if it was fetched live.
schema:
type: string
CacheAge:
description: Seconds since the returned result was written to the cache.
schema:
type: integer
RetryAfter:
description: Seconds to wait before retrying.
schema:
type: integer
responses:
Error:
description: The request failed. retryable says whether trying again can help.
headers:
X-Request-ID:
$ref: '#/components/headers/RequestId'
Retry-After:
$ref: '#/components/headers/RetryAfter'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Error:
type: object
required:
- success
- error
properties:
success:
const: false
error:
type: object
required:
- code
- message
- retryable
- requestId
properties:
code:
type: string
enum:
- cliSessionCompleted
- cliSessionExists
- cliSessionNotFound
- forbidden
- insufficientCredits
- internalError
- inviteClaimed
- inviteDisabled
- inviteExpired
- inviteUsedUp
- invalidCliSession
- invalidCliVerifier
- invalidRequest
- notFound
- rateLimited
- sourceChanged
- sourceRefused
- sourceTimeout
- sourceUnavailable
- tooManyInFlight
- unauthorized
- unsupportedMediaType
message:
type: string
retryable:
type: boolean
retryAfterSeconds:
type: integer
requestId:
type: string
requiredCredits:
type: number
availableCredits:
type: number
billingUrl:
type: string
const: https://stophy.dev/billing
securitySchemes:
apiKey:
type: http
scheme: bearer
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.