Skip to main content
POST
/
smartbrowse
/
recipes
/
{id}
/
run
Dispatch a SmartBrowse run
curl --request POST \
  --url https://api.webscrape.ai/v1/smartbrowse/recipes/{id}/run \
  --header 'X-API-Key: <api-key>'
{
  "status": "queued",
  "request_id": "req_aB3xY9Kp",
  "data": {
    "run_id": "k7Xb9dRmQ2p",
    "recipe_id": "m3Yc2tFvN8q",
    "run_status": "running",
    "poll_url": "/v1/smartbrowse/runs/k7Xb9dRmQ2p",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string
required

Opaque recipe ID (~11 base62 chars).

Example:

"m3Yc2tFvN8q"

Response

Run dispatched.

​
status
enum<string>
required

Discriminator for the envelope variant.

Available options:
queued
​
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