Create Squid
Squid
Create Squid
Create a new squid container for a specific crawler to organize and run scraping tasks
POST
Create Squid
This endpoint creates a new squid for a specified crawler by providing the crawler’s hash ID. A squid is a container that groups together related tasks and configurations for a specific scraping operation.
What is a Squid?
A squid acts as a project workspace for your scraping tasks:- Groups tasks: All URLs or items you want to scrape with the same crawler
- Stores configuration: Crawler parameters, concurrency settings, delivery options
- Manages runs: Tracks execution history and results
- Enables scheduling: Set up automated recurring scrapes
Headers
string
required
Your API authentication token. Value:
Token YOUR_API_KEYstring
required
Must be application/json. Value:
application/jsonRequest Body
string
required
The unique ID (hash) of the crawler to use for this squid. Example:
"4734d096159ef05210e0e1677e8be823"string
Custom name for the squid. If not provided, an auto-generated name will be used. Example:
"My Google Maps Scraper"Response Field Explanations
string
Unique squid identifier. Example:
"c106a44a98044ef18acc59986ae10967"string
Squid name (auto-generated as “Crawler Name (N)” if not provided). Example:
"Google Maps (1)"string
ID of the associated crawler. Example:
"4734d096159ef05210e0e1677e8be823"boolean
Whether the squid is active and can run. Example:
trueinteger
Number of concurrent tasks (default: 1). Example:
1object
Squid-level parameters with default values from crawler. Example:
{}object | null
Cron schedule configuration (null if not scheduled). Example:
nullboolean
Whether to stop after all tasks complete (false = run continuously). Example:
falseThe squid automatically inherits default parameters from the crawler. Check the response ‘params’ field to see what defaults were applied.
Code Examples
Response
200