Expand AI logo
DocsAPI ReferenceAPI Reference
Glow Active
Login

API Reference

Getting Started

API ReferenceRate LimitingError Handling

Endpoints

Start Batched FetchCancel Batched FetchFetchFetch JSON ModeHighlightsGet Batched Status
Browse docs

Getting Started

API ReferenceRate LimitingError Handling

Endpoints

Start Batched FetchCancel Batched FetchFetchFetch JSON ModeHighlightsGet Batched Status

Get Batched Status

GET
/v1/fetch/batched/{id}

Get persisted Batched Fetch status and paginated results with each URL's lifecycle state. CANCELLING means accepted cancellation is still draining.

Authorization

x-expand-api-key<token>

In: header

Path Parameters

id*nonEmptyString
Length1 <= length

Query Parameters

limit?string
offset?string
include?string

Response Body

application/json

Empty

a non empty string

Maximum number of results per page (default 10, max 100)

Offset from start (default 0)

JSON-encoded Include Options selecting captured content. When omitted, the original POST include is used. A provided include must be a subset of content captured by the POST.

application/json

application/json

application/json

application/json

application/json

application/json

{
  "id": "string",
  "status": "QUEUED",
  "batchedStatus": "QUEUED",
  "totalUrls": 0,
  "results": [
    {









































































































































{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "


{
  "reason": "InvalidApiKey",
  "description": "string",
  "_tag": "AuthFailed"
}
{
  "_tag": "PayloadTooLarge"
}
{
  "_tag": "TooManyRequests"
}
{
  "_tag": "InternalError"
}
{
  "message": "string",
  "requestId": "string",
  "_tag": "ServiceUnavailable"
}
"status": "QUEUED",
"data": {
"response": {
"url": "https://stripe.com/docs/api",
"requestedUrl": "https://www.stripe.com/docs/api",
"originStatusCode": 200,
"redirectStatusCode": 301,
"headers": {
"content-type": "text/html; charset=utf-8"
}
},
"meta": {
"title": "Stripe API Reference",
"description": "Complete reference for the Stripe API.",
"canonicalUrl": "https://stripe.com/docs/api",
"language": "en",
"charset": "utf-8",
"favicon": "/favicon.ico",
"icons": [
{
"href": "/favicon.ico",
"rel": "icon",
"type": "image/png",
"sizes": "32x32"
}
],
"openGraph": {
"title": "Stripe | Payment Processing Platform",
"description": "Online payment processing for internet businesses.",
"type": "website",
"url": "https://stripe.com",
"siteName": "Stripe",
"locale": "en_US",
"images": [
{
"url": "https://example.com/og-image.png",
"width": 1200,
"height": 630,
"alt": "Product screenshot showing dashboard"
}
]
},
"twitter": {
"card": "summary",
"site": "@stripe",
"creator": "@johndoe",
"title": "Stripe API Reference",
"description": "Complete reference documentation for the Stripe API.",
"image": "https://stripe.com/twitter-card.png"
}
},
"json": [
{
"property1": null,
"property2": null
}
],
"snapshotId": "string",
"html": "<html><body><h1>Welcome to our API</h1></body></html>",
"markdown": "# API Documentation\n\nWelcome to our API. This guide will help you get started...",
"screenshot": {
"url": "https://s3.amazonaws.com/bucket/snapshots/abcd/screenshot.jpeg?X-Amz-Signature=...",
"fullPage": true
},
"search": {
"query": "string",
"snippets": [
{
"type": "text",
"source": "markdown",
"text": "string",
"json": null,
"score": 0,
"location": {
"evidenceId": 1,
"markdownBlockId": "string",
"nodeIds": [
0
],
"stateJsonSourceId": 0,
"jsonPath": "string"
}
}
],
"meta": {
"durationMs": 0,
"sources": [
{
"source": "markdown",
"chunkCount": 0,
"batchCount": 0,
"ranker": "zeroentropy",
"fallback": true,
"fallbackReason": "timeout",
"durationMs": 0
}
]
}
},
"links": [
{
"url": "https://example.com/page",
"text": "Click here"
}
],
"appendix": "string",
"renderEngines": {
"capture": "rust",
"markdown": "rust",
"tree": "rust"
},
"assets": [
{
"id": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"kind": "data-url",
"placeholder": "expand-asset:data-url:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"archiveKey": "data-url:sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"mimeType": "image/svg+xml",
"sha256": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"bytes": 312
}
]
},
"error": {
"url": "string",
"blockedType": "botProtection",
"_tag": "FetchBlocked"
}
}
],
"pagination": {
"total": 0,
"limit": 0,
"offset": 0,
"hasMore": true
}
}
message
"
:
"string"
,
"_tag": "HttpApiDecodeError"
}