Skip to main content
POST
/
inspo
/
{inspoId}
/
scrape
curl --request POST \
  --url https://rawugc.com/api/v1/inspo/{inspoId}/scrape \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mode": "keyword",
  "keyword": "fitness motivation",
  "limit": 20
}
'
{
  "success": true,
  "created": 123,
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Use your API key from the RawUGC dashboard. Include as: Authorization: Bearer YOUR_API_KEY

Path Parameters

​
inspoId
string
required

Inspo project ID

Body

application/json
​
mode
enum<string>
required

Scraping mode. Determines which parameter is required: keyword mode requires 'keyword', hashtag requires 'hashtag', channel requires 'username', search requires 'query'.

Available options:
keyword,
hashtag,
channel,
search
​
keyword
string

Keyword to search (required when mode is 'keyword')

​
hashtag
string

Hashtag to search (required when mode is 'hashtag')

​
username
string

TikTok username (required when mode is 'channel')

​
query
string

Search query (required when mode is 'search')

​
limit
integer

Maximum number of videos to scrape

Required range: 1 <= x <= 30

Response

Videos scraped successfully

​
success
boolean
​
created
number

Number of videos scraped and stored

​
message
string