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

Start Batched Fetch

POST
/v1/fetch/batched

Start a Batched Fetch over multiple URLs using shared Fetch input and Include Options. Search is not supported for Batched Fetch requests.

Authorization

x-expand-api-key<token>

In: header

Header Parameters

x-idempotency-key?maxLength(255)
Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

Optional caller-supplied key that prevents duplicate Batched Fetch runs across separate calls. When omitted, the API generates a unique key. Replaying an identical request with the same key returns the same run ID; reusing the key with a different payload returns a 409 response.

urls*array<string>
Items1 <= items
include?
browserConfig?
documentConfig?

application/json

application/json

application/json

application/json

application/json

application/json

application/json

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


{
  "reason": "InvalidApiKey",
  "description": "string",
  "_tag": "AuthFailed"
}
{
  "organizationId": "string",
  "blockedUntil": "string",
  "_tag": "AccessBlocked"
}
{
  "existingRunId": "string",
  "reason": "payload_mismatch",
  "_tag": "BatchedIdempotencyConflict"
}
{
  "_tag": "PayloadTooLarge"
}
{
  "retryable": true,
  "retryAfterSeconds": 0,
  "_tag": "TooManyRequests"
}
{
  "retryable": true,
  "_tag": "InternalError"
}
{
  "message": "string",
  "requestId": "string",
  "dispatchOutcome": "cancelled_before_start",
  "retryable": true,
  "_tag":

List of URLs to fetch using shared options.

Specifies which content formats to include in the response

Configuration options for browser behavior during the fetch

Limits and conversion options applied to any URL in the batch that serves a non-HTML document

message
"
:
"string"
,
"_tag": "HttpApiDecodeError"
}
"ServiceUnavailable"
}