/install veedcrawl
Veedcrawl API
Use Veedcrawl for public social video discovery and analysis across supported video platforms.
Runtime
- Require
VEEDCRAWL_API_KEYbefore making protected requests. - Use
VEEDCRAWL_BASE_URLwhen set. Otherwise usehttps://api.veedcrawl.com. - Use
curlfor direct API calls. - Consult
https://docs.veedcrawl.comorhttps://veedcrawl.com/openapi.jsonwhen an endpoint shape is unclear.
Prepare shell examples with:
API_BASE="${VEEDCRAWL_BASE_URL:-https://api.veedcrawl.com}"
AUTH_HEADER="x-api-key: ${VEEDCRAWL_API_KEY}"
Choose The Workflow
- Start with
POST /v1/searchwhen the user gives a topic, keyword, creator idea, competitor, product, or trend instead of video URLs. - Start with
GET /v1/tiktok/profileorGET /v1/instagram/profilewhen the user gives a creator username or public profile URL. - Call
GET /v1/metadata?url=...for normalized per-video metadata, stats, author, tags, media details, and timestamps. - Call
POST /v1/transcriptwhen spoken content matters. - Call
POST /v1/extractwhen the task needs structured conclusions such as hooks, claims, products, CTAs, format analysis, sponsorship signals, or summaries. - Shortlist before running bulk transcript or extraction jobs. Search and profile data can narrow the video set first.
Async Jobs
search, transcript, and extract return a jobId.
- Save the returned
jobId. - Poll
GET /v1/search/{jobId},GET /v1/transcript/{jobId}, orGET /v1/extract/{jobId}untilstatusiscompletedorfailed. - Use
resultonly after completion. - Surface a failed job clearly instead of guessing at missing output.
- Preserve timestamps and source URLs when producing research notes, citations, evidence tables, or creator briefs.
Request Examples
Search videos:
curl -X POST "$API_BASE/v1/search" \
-H "$AUTH_HEADER" \
-H "Content-Type: application/json" \
-d '{
"query": "skincare morning routine",
"platforms": ["tiktok", "instagram", "youtube"],
"limit": 25,
"sort": "relevant",
"timePeriod": "past_month",
"filters": { "language": "en", "duration": "short", "minLikes": 1000 }
}'
Poll a search job:
curl "$API_BASE/v1/search/JOB_ID" \
-H "$AUTH_HEADER"
Inspect one video:
curl "$API_BASE/v1/metadata?url=VIDEO_URL" \
-H "$AUTH_HEADER"
Get a creator profile:
curl "$API_BASE/v1/tiktok/profile?username=CREATOR_USERNAME&limit=12" \
-H "$AUTH_HEADER"
Queue a transcript:
curl -X POST "$API_BASE/v1/transcript" \
-H "$AUTH_HEADER" \
-H "Content-Type: application/json" \
-d '{"url":"VIDEO_URL","mode":"auto"}'
Extract structured findings:
curl -X POST "$API_BASE/v1/extract" \
-H "$AUTH_HEADER" \
-H "Content-Type: application/json" \
-d '{"url":"VIDEO_URL","prompt":"Extract the hook, main claim, and call to action"}'
Output Defaults
- Prefer structured tables or JSON when comparing videos or creators.
- Keep video URL, platform, creator identity, and timestamps with extracted findings.
- Do not infer engagement stats, transcript text, or extraction output that the API did not return.
- State when a result is based on metadata only versus transcript or extraction evidence.
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install veedcrawl - After installation, invoke the skill by name or use
/veedcrawl - Provide required inputs per the skill's parameter spec and get structured output
What is Veed Crawl?
Give OpenClaw the ability to access social media content. It can search across TikTok, Instagram, and YouTube for videos, watch TikTok/Reels/YouTube, retriev... It is an AI Agent Skill for Claude Code / OpenClaw, with 54 downloads so far.
How do I install Veed Crawl?
Run "/install veedcrawl" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Veed Crawl free?
Yes, Veed Crawl is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Veed Crawl support?
Veed Crawl is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Veed Crawl?
It is built and maintained by VeedCrawl (@veedcrawl); the current version is v1.0.0.