Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vidjutsu.ai/llms.txt

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

VidJutsu ships 24 primitive /v1/scrape/* endpoints that wrap the public-data surfaces of the major creator + ad platforms. You don’t manage a separate scraper account — we hold the upstream master credentials and meter the calls through your existing API key.
One key, one bill, one ToS. No ScrapeCreators / Apify / RapidAPI signup, no duplicate billing, no second rate-limit page to babysit.

When to use it

  • Creator research — pull a profile + recent posts, then pipe each into watchMedia for hook + format analysis
  • Ad research — sweep Meta / Google / LinkedIn / Reddit ad libraries for a competitor or keyword and score the creative
  • Content repurposing — fetch a long-form YouTube video and run it through transcribe + watch to find clip-worthy moments
  • Social listening — keyword-search across TikTok / IG / X, classify sentiment, rank by reach
  • Influencer scouting — filter profiles by engagement rate, then watch their last 5 posts for fit

What you get

CategoryEndpoints
TikTokprofile, profile videos, video, video transcript, video comments, user search, trending
Instagramprofile, user posts, post, post comments, user reels
X (Twitter)profile, user tweets, tweet, tweet transcript
YouTubechannel, channel videos, video, video comments
Ad librariesMeta, Google, LinkedIn, Reddit
All 24 endpoints, methods, and CLI subcommands are documented separately:

download_media — the one flag that matters

Most endpoints accept an optional download_media: boolean (default false).
  • Off (default) — Response contains raw source CDN URLs. Cheapest, but those URLs (e.g. tiktokcdn-us.com, cdninstagram.com) are typically gatekept — you usually can’t fetch them from another tool without auth.
  • On — VidJutsu fetches every media URL in the response, stages it to our CDN, and replaces source URLs with VidJutsu URLs in the response. Now you can pipe directly into watchMedia, transcribeMedia, or any external LLM video tool.
# Stage all media so the result is downstream-ready
vidjutsu scrape instagram-user-posts --handle natgeo --download-media

Cost

  • 1 credit per call (always)
  • +1 credit per staged media file (only when download_media: true)
Shared scrape rate group: 500 calls / day across all 24 endpoints.

Recipe — research a creator end-to-end

import { createClient } from "vidjutsu";
const vj = createClient();

// 1) Recent posts (staged so we can watch them)
const { data: posts } = await vj.scrapeInstagramUserPosts({
  handle: "natgeo",
  download_media: true,
});

// 2) Score the top post
const top = posts.items[0];
const { data: review } = await vj.watchMedia({
  mediaUrl: top.media_url,
  prompt: "Rate the hook 1-10 and explain in one sentence.",
});

console.log(review.response);

Recipe — competitive ad teardown

const { data: ads } = await vj.scrapeMetaAds({
  query: "AG1",
  country: "US",
  download_media: true,
});

for (const ad of ads.items.slice(0, 5)) {
  const { data } = await vj.watchMedia({
    mediaUrl: ad.media_url,
    prompt: "What's the offer, the hook, and the CTA?",
  });
  console.log(ad.advertiser, data.response);
}

Limits and caveats

  • No private-content access. Scrape only resolves public posts, profiles, and ad-library entries. Anything behind a follower lock, age gate, or login wall is out of scope.
  • Best-effort upstream. Platforms occasionally throttle or restructure their public surfaces; expect occasional upstream_unavailable errors and retry with a small delay.
  • Not legal advice. You’re responsible for how you use scraped public data — respect the source platform’s ToS for downstream uses, and never republish private personal data.
  • No background polling. Don’t tight-loop the same endpoint; if you need fresh data, hit it at a sane interval (5+ minutes for the same key/handle).