Skip to main content
POST
Start Run
This endpoint initiates a new run for a specified squid, starting the scraping process for all active tasks within that squid.

Headers

string
required
Your API authentication token. Value: Token YOUR_API_KEY
string
required
Must be application/json. Value: application/json

Request Body

string
required
The hash ID of the squid to run. Example: "b6c56d18cb0046949461ba9ca278e8ad"

Response Field Explanations

string
Unique identifier of the new run. Example: "dd3473abe4cb41b683551e851edded94"
string
Always “run”. Example: "run"
string
The squid being executed. Example: "b6c56d18cb0046949461ba9ca278e8ad"
string
Initial run status (typically “pending”). Example: "pending"
boolean
Whether the run has completed (false for new runs). Example: false
string
Run start timestamp. Example: "2025-02-10T14:27:45Z"
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.

Code Examples

Response

200
400