Skip to main content
POST
/
v1
/
squids
/
{squid_hash}
Update Settings
curl --request POST \
  --url https://api.lobstr.io/v1/squids/{squid_hash} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "params": {},
  "params.max_related_videos_per_post": 123
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.lobstr.io/llms.txt

Use this file to discover all available pages before exploring further.

Update the configuration of your TikTok Video Scraper squid. Pass crawler-specific settings inside the params object.

​
Headers

​
Authorization
string
required
Your API authentication token. Value: Token YOUR_API_KEY
​
Content-Type
string
required
Must be application/json. Value: application/json

​
Body

​
params
object
Crawler-specific settings. See fields below.

​
Settings Fields

​
params.max_related_videos_per_post
integer
Number of related videos to also scrape for each task URL. Leave empty or set to 0 to disable. Example: 5
Set max_related_videos_per_post to expand your dataset — for each input URL, the scraper will also collect that many related videos. Results from related videos have is_related: true and include a related_to_video_id field.

​
Code Examples

curl -X POST "https://api.lobstr.io/v1/squids/YOUR_SQUID_HASH" \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "TikTok Video Scraper",
    "params": {
      "max_related_videos_per_post": 5
    }
  }'

​
Response

201
{
  "id": "YOUR_SQUID_HASH",
  "name": "TikTok Video Scraper",
  "crawler": {
    "id": "1e6cba50f2713539a2b0ac784184ed92",
    "name": "TikTok Video Scraper",
    "slug": "tiktok-video-scraper"
  },
  "params": {
    "max_related_videos_per_post": 5
  },
  "concurrency": 5,
  "export_unique_results": true,
  "to_complete": true,
  "no_line_breaks": false,
  "status": "idle",
  "created_at": "2025-01-20T10:15:00.000000",
  "updated_at": "2025-01-27T14:35:00.000000"
}