composio-scavio 0.1.1 → 0.2.0

package/dist/index.js

@@ -63,39 +63,33 @@ function buildScavioToolkit(options = {}) {
       tool(
         "AMAZON_SEARCH",
         "Scavio Amazon Search",
-        "Search Amazon for products matching a query.",
+        "Search Amazon for products matching a query. Results are unsorted and cannot be filtered by category, merchant or price. Costs 1 credit.",
         z.object({
           query: str("The product search query."),
-          domain: ostr("Amazon domain, e.g. 'amazon.com'."),
-          country: ostr("Two-letter country code."),
-          language: ostr("Two-letter language code."),
-          currency: ostr("Currency code, e.g. 'USD'."),
-          device: ostr("Device profile: 'desktop' or 'mobile'."),
-          sort_by: ostr("Sort order for results."),
-          start_page: onum("First page to return."),
-          pages: onum("Number of pages to return."),
-          category_id: ostr("Restrict to an Amazon category id."),
-          merchant_id: ostr("Restrict to a merchant id."),
-          zip_code: ostr("Delivery ZIP/postal code."),
-          autoselect_variant: obool("Auto-select the best product variant when true.")
+          country: ostr("Marketplace country code (ISO 3166-1 alpha-2), not a domain: 'us' (default), 'gb' (the UK is gb, not uk), 'ca', 'de', 'fr', 'es', 'it', 'jp', 'in', 'au', 'br', 'mx', 'nl', 'pl', 'se', 'sg', 'ae', 'sa', 'eg', 'cn', 'be', 'tr'. An unknown code falls back to us."),
+          page: onum("Result page, 1-based. One page per call, 1 credit each.")
         }),
         (i) => client.amazon.search(i)
       ),
       tool(
         "AMAZON_PRODUCT",
         "Scavio Amazon Product",
-        "Fetch full Amazon product details by ASIN.",
+        "Fetch full Amazon product details by ASIN. price is the buy-box price only. Costs 1 credit.",
         z.object({
           asin: str("Amazon Standard Identification Number (ASIN) of the product."),
-          domain: ostr("Amazon domain, e.g. 'amazon.com'."),
-          country: ostr("Two-letter country code."),
-          language: ostr("Two-letter language code."),
-          currency: ostr("Currency code, e.g. 'USD'."),
-          device: ostr("Device profile: 'desktop' or 'mobile'."),
-          zip_code: ostr("Delivery ZIP/postal code."),
-          autoselect_variant: obool("Auto-select the best product variant when true.")
+          country: ostr("Marketplace country code (ISO 3166-1 alpha-2), not a domain: 'us' (default), 'gb' (the UK is gb, not uk), 'ca', 'de', 'fr', 'es', 'it', 'jp', 'in', 'au', 'br', 'mx', 'nl', 'pl', 'se', 'sg', 'ae', 'sa', 'eg', 'cn', 'be', 'tr'. An unknown code falls back to us.")
         }),
         (i) => client.amazon.product(i)
+      ),
+      tool(
+        "AMAZON_OFFERS",
+        "Scavio Amazon Offers",
+        "List every seller offer for one Amazon ASIN: price, seller, condition, shipping, and which offer holds the buy box. Page 1 only. Use this instead of AMAZON_PRODUCT when comparing sellers or checking who owns the buy box. Costs 1 credit.",
+        z.object({
+          asin: str("Amazon Standard Identification Number (ASIN) of the product."),
+          country: ostr("Marketplace country code (ISO 3166-1 alpha-2), not a domain: 'us' (default), 'gb' (the UK is gb, not uk), 'ca', 'de', 'fr', 'es', 'it', 'jp', 'in', 'au', 'br', 'mx', 'nl', 'pl', 'se', 'sg', 'ae', 'sa', 'eg', 'cn', 'be', 'tr'. An unknown code falls back to us.")
+        }),
+        (i) => client.amazon.offers(i)
       )
     );
   }
@@ -104,7 +98,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "WALMART_SEARCH",
         "Scavio Walmart Search",
-        "Search Walmart for products matching a query.",
+        "Search Walmart for products matching a query. Costs 1 credit.",
         z.object({
           query: str("The product search query."),
           domain: ostr("Walmart domain."),
@@ -123,7 +117,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "WALMART_PRODUCT",
         "Scavio Walmart Product",
-        "Fetch full Walmart product details by product id.",
+        "Fetch full Walmart product details by product id. Costs 1 credit.",
         z.object({
           product_id: str("Walmart product id."),
           domain: ostr("Walmart domain."),
@@ -140,13 +134,15 @@ function buildScavioToolkit(options = {}) {
       tool(
         "YOUTUBE_SEARCH",
         "Scavio YouTube Search",
-        "Search YouTube for videos, channels, or playlists.",
+        "Search YouTube for videos, channels, or playlists. Costs 2 credits.",
         z.object({
           query: str("The video search query."),
-          upload_date: ostr("Upload date filter, e.g. 'today', 'week', 'month'."),
-          type: ostr("Result type, e.g. 'video', 'channel', 'playlist'."),
-          duration: ostr("Duration filter, e.g. 'short', 'long'."),
-          sort_by: ostr("Sort order for results."),
+          upload_date: ostr("Upload date filter: 'last_hour', 'today', 'this_week', 'this_month', 'this_year'."),
+          type: ostr("Result type: 'video', 'channel', 'playlist', or 'movie'."),
+          duration: ostr("Duration filter: 'short', 'medium', or 'long'."),
+          sort_by: ostr("Sort order: 'relevance', 'date', 'view_count', or 'rating'."),
+          features: z.array(z.string()).optional().describe("Feature filters, e.g. ['hd', '4k', 'subtitles', 'creative_commons', 'live', '360', '3d', 'hdr', 'vr180']."),
+          cursor: ostr("Pagination cursor from a prior response."),
           hd: obool("Restrict to HD videos when true."),
           subtitles: obool("Restrict to videos with subtitles when true."),
           creative_commons: obool("Restrict to Creative Commons videos when true."),
@@ -154,12 +150,144 @@ function buildScavioToolkit(options = {}) {
         }),
         (i) => client.youtube.search(i)
       ),
+      tool(
+        "YOUTUBE_SHORTS",
+        "Scavio YouTube Shorts",
+        "Search YouTube Shorts. Costs 2 credits.",
+        z.object({
+          query: str("The Shorts search query."),
+          sort_by: ostr("Sort order: 'relevance', 'date', 'view_count', or 'rating'."),
+          cursor: ostr("Pagination cursor from a prior response.")
+        }),
+        (i) => client.youtube.shorts(i)
+      ),
+      tool(
+        "YOUTUBE_SUGGESTIONS",
+        "Scavio YouTube Suggestions",
+        "Get YouTube search autocomplete suggestions for a partial query. Costs 1 credit.",
+        z.object({
+          query: str("The partial query to autocomplete."),
+          language: ostr("Suggestion language (ISO 639-1, default 'en')."),
+          region: ostr("Region code (ISO 3166-1 alpha-2, default 'US').")
+        }),
+        (i) => client.youtube.suggestions(i)
+      ),
+      tool(
+        "YOUTUBE_VIDEO",
+        "Scavio YouTube Video",
+        "Fetch full metadata for a YouTube video by id or watch URL. Costs 1 credit.",
+        z.object({ video_id: str("YouTube video id or a full watch URL.") }),
+        (i) => client.youtube.video(i)
+      ),
       tool(
         "YOUTUBE_METADATA",
         "Scavio YouTube Metadata",
-        "Fetch metadata for a YouTube video by id.",
-        z.object({ video_id: str("YouTube video id.") }),
+        "Fetch metadata for a YouTube video by id. Deprecated alias of YOUTUBE_VIDEO.",
+        z.object({ video_id: str("YouTube video id or a full watch URL.") }),
         (i) => client.youtube.metadata(i)
+      ),
+      tool(
+        "YOUTUBE_COMMENTS",
+        "Scavio YouTube Comments",
+        "List top-level comments on a YouTube video. Costs 1 credit.",
+        z.object({
+          video_id: str("YouTube video id or a full watch URL."),
+          cursor: ostr("Pagination cursor from a prior response.")
+        }),
+        (i) => client.youtube.comments(i)
+      ),
+      tool(
+        "YOUTUBE_COMMENT_REPLIES",
+        "Scavio YouTube Comment Replies",
+        "List replies to a YouTube comment using its reply cursor. Costs 1 credit.",
+        z.object({
+          video_id: str("YouTube video id or a full watch URL."),
+          reply_cursor: str("Reply cursor from a parent comment's 'reply_cursor' field."),
+          cursor: ostr("Pagination cursor from a prior response.")
+        }),
+        (i) => client.youtube.commentReplies(i)
+      ),
+      tool(
+        "YOUTUBE_TRANSCRIPT",
+        "Scavio YouTube Transcript",
+        "Fetch the transcript or timed captions for a YouTube video. Costs 8 credits.",
+        z.object({
+          video_id: str("YouTube video id or a full watch URL."),
+          language: ostr("Caption language code (default 'en')."),
+          format: ostr("'text' for a plain transcript or 'srt' for timed subtitles (default 'text').")
+        }),
+        (i) => client.youtube.transcript(i)
+      ),
+      tool(
+        "YOUTUBE_RELATED",
+        "Scavio YouTube Related",
+        "List videos related to a YouTube video. Costs 1 credit.",
+        z.object({
+          video_id: str("YouTube video id or a full watch URL."),
+          cursor: ostr("Pagination cursor from a prior response.")
+        }),
+        (i) => client.youtube.related(i)
+      ),
+      tool(
+        "YOUTUBE_CHANNEL_SEARCH",
+        "Scavio YouTube Channel Search",
+        "Search YouTube channels by keyword. Costs 1 credit.",
+        z.object({
+          query: str("The channel search query."),
+          cursor: ostr("Pagination cursor from a prior response.")
+        }),
+        (i) => client.youtube.channelSearch(i)
+      ),
+      tool(
+        "YOUTUBE_CHANNEL",
+        "Scavio YouTube Channel",
+        "Fetch YouTube channel details by id, @handle, or URL. Costs 1 credit.",
+        z.object({ channel_id: str("YouTube channel id, @handle, or channel URL.") }),
+        (i) => client.youtube.channel(i)
+      ),
+      tool(
+        "YOUTUBE_CHANNEL_VIDEOS",
+        "Scavio YouTube Channel Videos",
+        "List videos uploaded by a YouTube channel. Costs 1 credit.",
+        z.object({
+          channel_id: str("YouTube channel id."),
+          cursor: ostr("Pagination cursor from a prior response.")
+        }),
+        (i) => client.youtube.channelVideos(i)
+      ),
+      tool(
+        "YOUTUBE_CHANNEL_SHORTS",
+        "Scavio YouTube Channel Shorts",
+        "List Shorts posted by a YouTube channel. Costs 1 credit.",
+        z.object({
+          channel_id: str("YouTube channel id."),
+          cursor: ostr("Pagination cursor from a prior response.")
+        }),
+        (i) => client.youtube.channelShorts(i)
+      ),
+      tool(
+        "YOUTUBE_CHANNEL_COMMUNITY",
+        "Scavio YouTube Channel Community",
+        "List community posts from a YouTube channel. Costs 1 credit.",
+        z.object({
+          channel_id: str("YouTube channel id."),
+          cursor: ostr("Pagination cursor from a prior response.")
+        }),
+        (i) => client.youtube.channelCommunity(i)
+      ),
+      tool(
+        "YOUTUBE_CHANNEL_RESOLVE",
+        "Scavio YouTube Channel Resolve",
+        "Resolve a YouTube @handle or channel URL to a channel id. Costs 1 credit.",
+        z.object({ channel: str("A channel @handle or channel URL to resolve to a channel id.") }),
+        (i) => client.youtube.channelResolve(i)
+      ),
+      tool(
+        "YOUTUBE_STREAMS",
+        "Scavio YouTube Streams",
+        "Fetch playable or downloadable stream formats for a YouTube video. Costs 3 credits.",
+        z.object({ video_id: str("YouTube video id or a full watch URL.") }),
+        (i) => client.youtube.streams(i)
       )
     );
   }
@@ -168,20 +296,18 @@ function buildScavioToolkit(options = {}) {
       tool(
         "REDDIT_SEARCH",
         "Scavio Reddit Search",
-        "Search Reddit posts, subreddits, or users.",
+        "Search Reddit posts. Returns data.results with next_cursor and has_more; page with cursor. Results cannot be filtered or sorted. Costs 1 credit.",
         z.object({
           query: str("The Reddit search query."),
-          type: ostr("Search type, e.g. 'posts', 'subreddits', 'users'."),
-          sort: ostr("Sort order, e.g. 'relevance', 'new', 'top'."),
-          cursor: ostr("Pagination cursor.")
+          cursor: ostr("Pagination cursor: pass 'next_cursor' from a prior response.")
         }),
         (i) => client.reddit.search(i)
       ),
       tool(
         "REDDIT_POST",
         "Scavio Reddit Post",
-        "Fetch a Reddit post and its comment thread by URL.",
-        z.object({ url: str("Full URL of the Reddit post to fetch with its comments.") }),
+        "Fetch one Reddit post by URL. Returns a flat post object under data (post_id, title, text, url, subreddit, author, score, upvote_ratio, num_comments, created_at, is_nsfw, is_video, thumbnail, media); comments are NOT included. Costs 1 credit.",
+        z.object({ url: str("Full URL of the Reddit post.") }),
         (i) => client.reddit.post(i)
       )
     );
@@ -191,7 +317,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "TIKTOK_PROFILE",
         "Scavio TikTok Profile",
-        "Fetch a TikTok user profile by username or secUid.",
+        "Fetch a TikTok user profile by username or secUid. Costs 1 credit.",
         z.object({
           username: ostr("TikTok username (without @). Provide this or sec_user_id."),
           sec_user_id: ostr("TikTok secUid. Provide this or username.")
@@ -201,7 +327,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "TIKTOK_USER_POSTS",
         "Scavio TikTok User Posts",
-        "List a TikTok user's posts by secUid.",
+        "List a TikTok user's posts by secUid. Costs 1 credit.",
         z.object({
           sec_user_id: str("TikTok secUid of the user."),
           cursor: ostr("Pagination cursor."),
@@ -213,14 +339,14 @@ function buildScavioToolkit(options = {}) {
       tool(
         "TIKTOK_VIDEO",
         "Scavio TikTok Video",
-        "Fetch a TikTok video by id.",
+        "Fetch a TikTok video by id. Costs 1 credit.",
         z.object({ video_id: str("TikTok video id.") }),
         (i) => client.tiktok.video(i)
       ),
       tool(
         "TIKTOK_VIDEO_COMMENTS",
         "Scavio TikTok Video Comments",
-        "List comments on a TikTok video.",
+        "List comments on a TikTok video. Costs 1 credit.",
         z.object({
           video_id: str("TikTok video id."),
           cursor: ostr("Pagination cursor."),
@@ -231,7 +357,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "TIKTOK_COMMENT_REPLIES",
         "Scavio TikTok Comment Replies",
-        "List replies to a TikTok video comment.",
+        "List replies to a TikTok video comment. Costs 1 credit.",
         z.object({
           video_id: str("TikTok video id."),
           comment_id: str("Parent comment id."),
@@ -243,7 +369,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "TIKTOK_SEARCH_VIDEOS",
         "Scavio TikTok Search Videos",
-        "Search TikTok videos by keyword.",
+        "Search TikTok videos by keyword. Costs 1 credit.",
         z.object({
           keyword: str("Search keyword."),
           cursor: ostr("Pagination cursor."),
@@ -256,7 +382,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "TIKTOK_SEARCH_USERS",
         "Scavio TikTok Search Users",
-        "Search TikTok users by keyword.",
+        "Search TikTok users by keyword. Costs 1 credit.",
         z.object({
           keyword: str("Search keyword."),
           cursor: ostr("Pagination cursor."),
@@ -267,7 +393,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "TIKTOK_HASHTAG",
         "Scavio TikTok Hashtag",
-        "Fetch a TikTok hashtag by name or id.",
+        "Fetch a TikTok hashtag by name or id. Costs 1 credit.",
         z.object({
           hashtag_name: ostr("Hashtag name (without #). Provide this or hashtag_id."),
           hashtag_id: ostr("Hashtag id. Provide this or hashtag_name.")
@@ -277,7 +403,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "TIKTOK_HASHTAG_VIDEOS",
         "Scavio TikTok Hashtag Videos",
-        "List videos for a TikTok hashtag by id.",
+        "List videos for a TikTok hashtag by id. Costs 1 credit.",
         z.object({
           hashtag_id: str("Hashtag id."),
           cursor: ostr("Pagination cursor."),
@@ -288,7 +414,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "TIKTOK_USER_FOLLOWERS",
         "Scavio TikTok User Followers",
-        "List a TikTok user's followers by secUid.",
+        "List a TikTok user's followers by secUid. Costs 1 credit.",
         z.object({
           sec_user_id: str("TikTok secUid of the user."),
           count: onum("Number of followers to return."),
@@ -300,7 +426,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "TIKTOK_USER_FOLLOWINGS",
         "Scavio TikTok User Followings",
-        "List the accounts a TikTok user follows, by secUid.",
+        "List the accounts a TikTok user follows, by secUid. Costs 1 credit.",
         z.object({
           sec_user_id: str("TikTok secUid of the user."),
           count: onum("Number of followings to return."),
@@ -316,7 +442,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "INSTAGRAM_PROFILE",
         "Scavio Instagram Profile",
-        "Fetch an Instagram profile by username or user id.",
+        "Fetch an Instagram profile by username or user id. Costs 10 credits.",
         z.object({
           username: ostr("Instagram username. Provide this or user_id."),
           user_id: ostr("Instagram user id. Provide this or username.")
@@ -326,7 +452,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "INSTAGRAM_USER_POSTS",
         "Scavio Instagram User Posts",
-        "List an Instagram user's posts.",
+        "List an Instagram user's posts. Costs 2 credits, the cheapest Instagram endpoint.",
         z.object({
           username: ostr("Instagram username. Provide this or user_id."),
           user_id: ostr("Instagram user id. Provide this or username."),
@@ -338,7 +464,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "INSTAGRAM_USER_REELS",
         "Scavio Instagram User Reels",
-        "List an Instagram user's reels.",
+        "List an Instagram user's reels. Costs 10 credits.",
         z.object({
           username: ostr("Instagram username. Provide this or user_id."),
           user_id: ostr("Instagram user id. Provide this or username."),
@@ -350,7 +476,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "INSTAGRAM_USER_TAGGED",
         "Scavio Instagram User Tagged",
-        "List posts an Instagram user is tagged in.",
+        "List posts an Instagram user is tagged in. Costs 10 credits.",
         z.object({
           username: ostr("Instagram username. Provide this or user_id."),
           user_id: ostr("Instagram user id. Provide this or username."),
@@ -362,7 +488,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "INSTAGRAM_USER_STORIES",
         "Scavio Instagram User Stories",
-        "Fetch an Instagram user's current stories.",
+        "Fetch an Instagram user's current stories. Costs 10 credits.",
         z.object({
           username: ostr("Instagram username. Provide this or user_id."),
           user_id: ostr("Instagram user id. Provide this or username.")
@@ -372,7 +498,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "INSTAGRAM_POST",
         "Scavio Instagram Post",
-        "Fetch an Instagram post by URL, media id, or shortcode.",
+        "Fetch an Instagram post by URL, media id, or shortcode. Costs 8 credits.",
         z.object({
           url: ostr("Post URL. Provide one of url, media_id, or shortcode."),
           media_id: ostr("Post media id. Provide one of url, media_id, or shortcode."),
@@ -383,7 +509,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "INSTAGRAM_POST_COMMENTS",
         "Scavio Instagram Post Comments",
-        "List comments on an Instagram post by shortcode or URL.",
+        "List comments on an Instagram post by shortcode or URL. Costs 10 credits.",
         z.object({
           shortcode: ostr("Post shortcode. Provide this or url."),
           url: ostr("Post URL. Provide this or shortcode."),
@@ -395,7 +521,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "INSTAGRAM_COMMENT_REPLIES",
         "Scavio Instagram Comment Replies",
-        "List replies to an Instagram post comment.",
+        "List replies to an Instagram post comment. Costs 8 credits.",
         z.object({
           media_id: str("Post media id."),
           comment_id: str("Parent comment id."),
@@ -406,7 +532,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "INSTAGRAM_SEARCH_USERS",
         "Scavio Instagram Search Users",
-        "Search Instagram users by keyword.",
+        "Search Instagram users by keyword. Costs 10 credits.",
         z.object({
           keyword: str("Search keyword."),
           cursor: ostr("Pagination cursor.")
@@ -416,7 +542,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "INSTAGRAM_SEARCH_HASHTAGS",
         "Scavio Instagram Search Hashtags",
-        "Search Instagram hashtags by keyword.",
+        "Search Instagram hashtags by keyword. Costs 10 credits.",
         z.object({
           keyword: str("Search keyword."),
           cursor: ostr("Pagination cursor.")
@@ -426,7 +552,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "INSTAGRAM_USER_FOLLOWERS",
         "Scavio Instagram User Followers",
-        "List an Instagram user's followers.",
+        "List an Instagram user's followers. Costs 10 credits.",
         z.object({
           username: ostr("Instagram username. Provide this or user_id."),
           user_id: ostr("Instagram user id. Provide this or username."),
@@ -438,7 +564,7 @@ function buildScavioToolkit(options = {}) {
       tool(
         "INSTAGRAM_USER_FOLLOWINGS",
         "Scavio Instagram User Followings",
-        "List the accounts an Instagram user follows.",
+        "List the accounts an Instagram user follows. Costs 10 credits.",
         z.object({
           username: ostr("Instagram username. Provide this or user_id."),
           user_id: ostr("Instagram user id. Provide this or username."),
@@ -451,7 +577,7 @@ function buildScavioToolkit(options = {}) {
   }
   return experimental_createToolkit("SCAVIO", {
     name: "Scavio",
-    description: "Real-time structured search over Google, YouTube, Amazon, Walmart, Reddit, TikTok, and Instagram.",
+    description: "Real-time structured search over Google, YouTube, Amazon, Walmart, Reddit, TikTok, and Instagram (part of the Scavio API, which also covers TikTok Shop, X and LinkedIn).",
     tools
   });
 }