POST/v1/runs

Start Run

Initiate a new run for a specified squid

This endpoint initiates a new run for a specified squid, starting the scraping process for all active tasks within that squid.

Headers

Key	Value	Required
Authorization	Token YOUR_API_KEY	Yes
Content-Type	application/json	Yes

squidstring

Required

The hash ID of the squid to run

Example: b6c56d18cb0046949461ba9ca278e8ad

string

Unique identifier of the new run

Example: dd3473abe4cb41b683551e851edded94

object

string

Always "run"

Example: run

squid

string

The squid being executed

Example: b6c56d18cb0046949461ba9ca278e8ad

status

string

Initial run status (typically "pending")

Example: pending

is_done

boolean

Whether the run has completed (false for new runs)

Example: false

started_at

string

Run start timestamp

Example: 2025-02-10T14:27:45Z

origin

string

Origin of the run ("user" for API-initiated runs)

Example: user

Save the returned run ID to track progress using Get Run or Get Run Stats endpoints.

Ensure your squid has active tasks before starting a run, or the run will complete immediately with no results.

Only one run can be active per squid at a time. Starting a new run while one is active will return an error.

For crawlers requiring accounts (e.g., LinkedIn, Facebook), ensure you have synced accounts before starting a run.