POST/v1/tasks

Add Tasks

Create new tasks within a specified squid

This endpoint creates new tasks within a specified squid. Tasks define the specific scraping jobs to be executed, such as URLs to scrape or search parameters.

Note: The accepted task input keys (e.g., url, city, activity) depend on the crawler used in your squid. Use the Get Crawler Parameters endpoint to discover valid keys for your crawler.

Headers

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

Request Body

squidstring

Required

The hash ID of the squid to add tasks to

Example: a1b2c3d4e5f6g7h8i9j0

tasksarray

Required

Array of task objects. Each task contains parameters specific to the crawler

Example: [{url: https://example.com}]

Response Field Explanations

duplicated_count

integer

Number of tasks that were duplicates and not added

Example: 0

tasks

array

Array of created task objects

Example: [...]

tasks[].id

string

Unique task identifier

Example: c5e29d2aba8b77cdc56391e7405302de

tasks[].created_at

string

Task creation timestamp (ISO 8601)

Example: 2025-02-10T14:19:32.916901

tasks[].is_active

boolean

Whether the task is active and ready to run

Example: true

tasks[].params

object

Task parameters (URL, search terms, etc.)

Example: {url: ...}

tasks[].object

string

Always "task"

Example: task

Pro Tip

Use the Get Crawler Parameters endpoint to discover which task keys are valid for your specific crawler.

Note

Duplicate tasks (same parameters) are automatically detected and not added. Check duplicated_count in the response.

Warning

Task parameters vary by crawler. Using invalid keys will result in task creation failure.

Pro Tip

For bulk task creation, consider using the Upload Tasks endpoint with a CSV file instead.