diff --git a/surfsense_web/content/docs/connectors/native/index.mdx b/surfsense_web/content/docs/connectors/native/index.mdx index 5c5d24444..f915b5533 100644 --- a/surfsense_web/content/docs/connectors/native/index.mdx +++ b/surfsense_web/content/docs/connectors/native/index.mdx @@ -1,6 +1,6 @@ --- title: Native Connectors -description: SurfSense's built-in scraper APIs for Reddit, YouTube, Google Maps, Google Search, and the web +description: SurfSense's built-in scraper APIs for Reddit, YouTube, TikTok, Google Maps, Google Search, and the web --- import { Card, Cards } from 'fumadocs-ui/components/card'; @@ -18,6 +18,11 @@ Native connectors are SurfSense's own scraper APIs — built into the platform, description="Videos, channels, playlists, subtitles, and comments" href="/docs/connectors/native/youtube" /> + `), a hashtag (`/tag/`), or a search URL (max 20 sources per call) | +| `profiles` | — | Profile usernames, with or without a leading `@` | +| `hashtags` | — | Hashtag names, without the `#` | +| `search_queries` | — | Search terms to run on TikTok | +| `results_per_page` | `10` | Max videos per profile/hashtag/search target | +| `max_items` | `10` | Max total videos returned across all sources (hard cap 100) | + +## Example + +```bash +curl -X POST "$BASE_URL/api/v1/workspaces/1/scrapers/tiktok/scrape" \ + -H "Authorization: Bearer $SURFSENSE_API_KEY" \ + -H "Content-Type: application/json" \ + -d '{ + "hashtags": ["food"], + "max_items": 25 + }' +``` + +The response is `{ "items": [...] }` — one item per video. Billing is per returned item. + + +Video, hashtag, and search targets are the reliable paths. TikTok restricts the profile video endpoint for automated clients, so a `profiles` target can return no items even when the account is public — prefer hashtags, search, or a direct video URL. + + +For the full input and output JSON schemas and generated code snippets in your language, open **API Playground → TikTok → Scrape** in your workspace.