Skip to main content
GET
/
smartbrowse
/
runs
/
{id}
Poll a SmartBrowse run
curl --request GET \
  --url https://api.webscrape.ai/v1/smartbrowse/runs/{id} \
  --header 'X-API-Key: <api-key>'
{
  "status": "completed",
  "request_id": "req_aB3xY9Kp",
  "data": {
    "id": "k7Xb9dRmQ2p",
    "recipe_id": "m3Yc2tFvN8q",
    "pages_extracted": 123,
    "items_extracted": 123,
    "credits_used": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "error": "<string>",
    "result": {
      "pages": [
        {
          "items": [
            {}
          ]
        }
      ],
      "mode": "<string>",
      "drift": 123,
      "warnings": [
        "<string>"
      ]
    }
  },
  "credits_used": 0,
  "credits_remaining": 123
}

Authorizations

​
X-API-Key
string
header
required

Generate from the dashboard. Format: wsg_live_<32 base62 chars>.

Path Parameters

​
id
string
required

Opaque run ID (~11 base62 chars).

Example:

"k7Xb9dRmQ2p"

Response

Run state returned.

​
status
enum<string>
required

Discriminator for the envelope variant.

Available options:
completed
​
request_id
string
required

Per-request id. Also returned as the X-Request-ID response header. Include it when reporting issues.

Example:

"req_aB3xY9Kp"

​
data
object
required
​
credits_used
integer
required

Always 0. Polling is free; the run's accrued credits are surfaced in data.credits_used.

Example:

0

​
credits_remaining
integer
required