Get classification results

Retrieve batch progress and all per-URL decisions.

01 / Request

Make a request

GET/api/v1/scraping/classifications/{id}

Use the batch ID and a key belonging to the same account. Poll at least 10 seconds apart. Returns 202 while queued or running, and 200 when completed or review.

Read every item.status before using its label. Stop polling a terminal batch, including review; do not automatically resubmit uncertain work. Results expire per item 24 hours after starting-page collection.

Required headers

AuthorizationstringRequired: Bearer followed by your ScrapingBuddy customer API key.

Path parameters

idUUID v4Required: The batch ID, originally supplied as Idempotency-Key. Unknown, invalid or another account's batch returns 404.

GET /scraping/classifications/{id}

curl --fail-with-body -X GET "https://www.scrapingbuddy.com/api/v1/scraping/classifications/$SCRAPINGBUDDY_BATCH_ID" \
  -H "Authorization: Bearer $SCRAPINGBUDDY_API_KEY"

GET /scraping/classifications/{id}

const apiKey = process.env.SCRAPINGBUDDY_API_KEY;
const batchId = process.env.SCRAPINGBUDDY_BATCH_ID;
if (!apiKey || !batchId) {
  throw new Error("Set the required environment variables before running.");
}

const response = await fetch(`https://www.scrapingbuddy.com/api/v1/scraping/classifications/${encodeURIComponent(batchId)}`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${apiKey}`
  }
});
const data = await response.json();
if (!response.ok) {
  throw new Error(`${response.status}: ${data.error}`);
}
console.log(data);

GET /scraping/classifications/{id}

import os
import requests
from urllib.parse import quote

api_key = os.environ["SCRAPINGBUDDY_API_KEY"]
batch_id = quote(os.environ["SCRAPINGBUDDY_BATCH_ID"], safe="")
response = requests.get(
    f"https://www.scrapingbuddy.com/api/v1/scraping/classifications/{batch_id}",
    headers={
        "Authorization": f"Bearer {api_key}"
    },
    timeout=30,
)
data = response.json()
if not response.ok:
    raise RuntimeError(f"{response.status_code}: {data.get('error')}")
print(data)

Base URL https://www.scrapingbuddy.com/api/v1

Set SCRAPINGBUDDY_API_KEY and SCRAPINGBUDDY_BATCH_ID in your server environment. JavaScript uses Node.js 20+; Python requires requests. These examples call the live, billed API.

02 / Response

Understand the response

Success returns HTTP 202 while work is active, otherwise 200 with JSON. Inspect item outcomes even when the batch is completed.

batchobject: The batch object described below. Inspect each item.status before using its answer.
pollAfterSecondsinteger: 10. Wait at least this long before checking progress.

Batch object

idUUID v4: The Idempotency-Key supplied when creating the batch. Item task IDs are different from the batch ID.
statusstring: queued or running while work remains; completed or review when terminal. completed does not guarantee every item was classified.
requestobject: Normalized urls, question, choices and any optional companyContext, depth, maxPages or webSearch. Keep private context out of shared logs.
createdAtISO timestamp: When the batch was created.
totalinteger: Number of unique normalized URLs in the batch.
completedinteger: Number of terminal items, including failed, refused, review, cancelled and expired items. Not a success count.
classifiedinteger: Number of items with a usable classified answer. Expired results are no longer included.
itemsarray: All result items in original URL order, after deduplication. Omitted from batch history summaries.

Result item

idUUID v4: Generated task ID for this URL; not the batch ID. Get /scraping/tasks/{id} for collected content, analysis usage, research details and contentExpiresAt.
positioninteger: One-based position after URL normalization and deduplication.
urlstring: Normalized starting page URL.
statusstring: queued, processing, classified, insufficient_evidence, refused, failed, review, expired or cancelled.
labelstring | null: Exactly one supplied choice when status is classified; null otherwise. Never interpret null as No.
confidencenumber | null: Model confidence in its selected outcome, including an insufficient-evidence outcome. Null for refusal or when no decision is available. Not a guarantee of correctness; check status and label first.
probabilitiesarray: Entries {label, probability} for your choices when a choice response is available; otherwise []. Probabilities are model estimates.
insufficientEvidenceProbabilitynumber | null: Estimated probability for the system insufficient-evidence option. Separate from a user-provided Maybe label.
modelstring | null: Server-managed model used for the decision, when available.
sourceUrlsstring[]: Collected source URLs used by the analysis. Not independently verified citations for the decision. Empty when unavailable or expired.
warningstring | null: Partial collection, source-readiness or input-truncation warnings.
errorobject | null: code and message for a collection or analysis failure. Cancelled entries use BATCH_CANCELLED.
billingobject: customerChargeUsd and heldUsd are decimal USD strings for this item. Holds are not extra charges; completed paid steps remain charged after cancellation or expiry.

Example response / illustrative values

{
  "batch": {
    "id": "f824e030-0e09-4d70-a372-fdfd22e84721",
    "status": "completed",
    "createdAt": "2026-10-09T10:00:00.000Z",
    "request": {
      "urls": [
        "https://example.com/about"
      ],
      "question": "Does this company offer managed web scraping services?",
      "choices": [
        "Yes",
        "No",
        "Maybe"
      ]
    },
    "total": 1,
    "completed": 1,
    "classified": 1,
    "items": [
      {
        "id": "8da18a77-6fe2-4e31-a4de-b77f7a7b62d0",
        "position": 1,
        "url": "https://example.com/about",
        "status": "classified",
        "label": "Yes",
        "confidence": 0.9,
        "probabilities": [
          {
            "label": "Yes",
            "probability": 0.9
          },
          {
            "label": "No",
            "probability": 0.04
          },
          {
            "label": "Maybe",
            "probability": 0.04
          }
        ],
        "insufficientEvidenceProbability": 0.02,
        "model": "gpt-6-luna",
        "sourceUrls": [
          "https://example.com/about"
        ],
        "warning": null,
        "error": null,
        "billing": {
          "customerChargeUsd": "0.000600000",
          "heldUsd": "0.000000000"
        }
      }
    ]
  },
  "pollAfterSeconds": 10
}

URLs, IDs, costs, content and timestamps are illustrative. Use your own public hostname.

Errors & next steps

Request errors return an HTTP error status and a top-level error string. Processing failures appear in batch.items[].error even when fetching the result succeeds.

New tasks and batches require $1 available balance; insufficient starting credit returns 402. All customer keys share 60 requests per minute per account. For 429, honor Retry-After; active-task and daily limits may require a longer wait.

Errors & limits Safe retries Task lifecycle