--- title: "Call a platform-specific interface of the catalog by its op. find finds one by what it does; capabilities lists them with their parameters." method: POST path: "/call/{op}" --- # Call a platform-specific interface of the catalog by its op. find finds one by what it does; capabilities lists them with their parameters. `POST /call/{op}` ## Request - Base URL: `https://api.socialtoai.com/v1` - URL: `https://api.socialtoai.com/v1/call/{op}` - Auth: one of: - HTTP bearer - API key in header `X-API-Key` ## Path parameters - `op` 'douyin.account_audience' | 'douyin.account_history' | 'douyin.account_metrics' | 'douyin.account_top_videos' | 'douyin.brand_history' | 'douyin.brand_radar' | 'douyin.hashtag_videos' | 'douyin.index_topics' | 'douyin.keyword_audience' | 'douyin.keyword_history' | 'douyin.keyword_related' | 'douyin.keyword_videos' | 'douyin.kol_audience' | 'douyin.kol_content_mix' | 'douyin.kol_keywords' | 'douyin.kol_performance' | 'douyin.kol_profile' | 'douyin.kol_rates' | 'douyin.kol_scores' | 'douyin.kol_search' | 'douyin.kol_videos' | 'douyin.marketing_calendar' | 'douyin.related_videos' | 'douyin.video_stats' | 'google.ad_detail' | 'google.advertiser_ads' | 'google.advertiser_search' | 'instagram.hashtag_posts' | 'linkedin.ad_detail' | 'linkedin.ad_search' | 'meta.ad_detail' | 'meta.ad_search' | 'meta.advertiser_ads' | 'meta.advertiser_search' | 'reddit.subreddit' | 'reddit.subreddit_posts' | 'reddit.user_subreddits' | 'tiktok.ad_detail' | 'tiktok.ad_search' | 'tiktok.followers' | 'tiktok.hashtag_videos' | 'tiktok.product_detail' | 'tiktok.product_reviews' | 'tiktok.product_search' | 'tiktok.seller_products' | 'tiktok.top_ad_detail' | 'tiktok.top_ad_search' | 'wechat.article_stats' | 'wechat_channels.collection_videos' | 'wechat_channels.collections' | 'weibo.followers' | 'weibo.likers' | 'x.article' | 'x.community' | 'x.community_members' | 'x.community_posts' | 'x.followers' | 'x.following' | 'x.list_followers' | 'x.list_members' | 'x.list_posts' | 'x.mentions' | 'x.quotes' | 'x.thread' | 'xiaohongshu.product_detail' | 'xiaohongshu.product_reviews' | 'xiaohongshu.product_search' | 'xiaohongshu.topic' | 'xiaohongshu.topic_notes' | 'youtube.community_post' | 'youtube.community_posts' | 'zhihu.column_articles' | 'zhihu.followers' | 'zhihu.question_answers', required ## Headers - `Idempotency-Key` string - `Accept-Language` string ## Request body - object - `id` union - string - integer - `window` union - string - integer - `since` union - string - integer - `until` union - string - integer - `brand` union - string - integer - `board` union - string - integer - `keyword` union - string - integer - `query` union - string - integer - `url` union - string - integer - `region` union - string - integer - `type` union - string - integer - `sort` union - string - integer - `username` union - string - integer - `cursor` string: page.cursor of the answer before, with the same request otherwise: the next page, charged as a call of its own. - `max_cost_credits` integer: The most this call may cost. Over it, the call is refused for free and the answer carries the quote. ## Response `200` The Envelope: flat for a request that falls on one cell, `cells` for one that falls on several. A cell that failed is still answered under 200, with its status and error, and costs 0. - union - Envelope - `request_id` string, required - `schema_version` 'v1', required - `fetched_at` string, date-time, required - `action` 'search' | 'trending' | 'detail' | 'comments' | 'user_profile' | 'user_posts' | 'call', required - `op` string - `billing` Billing, required - `cost_credits` integer, required - `balance_credits` integer, required - `today_spend_credits` integer, required - `daily_limit_credits` integer, nullable, required - `daily_remaining_credits` integer, nullable, required - `display` string, required - `replayed` boolean, required - `replayed_cost_credits` integer - `platform` string, required - `target` string - `status` 'ok' | 'empty' | 'error' | 'not_supported' | 'timeout' | 'skipped', required - `reason` string - `items` Object[], required - union - Content - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - `field` string, required - `kind` 'approximate' | 'lower_bound', required - `type` 'content', required - `url` string, nullable, required - `format` 'video' | 'image' | 'text' | 'article', nullable, required - `title` string, nullable, required - `text` string, nullable, required - `published_at` string, date-time, nullable, required - `author` object, nullable, required - `id` string, nullable, required - `username` string, nullable, required - `name` string, nullable, required - `verified` boolean, nullable, required - `followers` integer, nullable, required - `metrics` object, required - `likes` integer, nullable, required - `comments` integer, nullable, required - `shares` integer, nullable, required - `collects` integer, nullable, required - `views` integer, nullable, required - `reposts` integer, nullable, required - `images` string[], nullable, required - `hashtags` string[], nullable, required - `is_pinned` boolean, nullable, required - Account - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - `field` string, required - `kind` 'approximate' | 'lower_bound', required - `type` 'account', required - `username` string, nullable, required - `name` string, nullable, required - `url` string, nullable, required - `bio` string, nullable, required - `verified` boolean, nullable, required - `followers` integer, nullable, required - `following` integer, nullable, required - `posts_count` integer, nullable, required - Comment - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - `field` string, required - `kind` 'approximate' | 'lower_bound', required - `type` 'comment', required - `url` string, nullable, required - `text` string, nullable, required - `published_at` string, date-time, nullable, required - `author` object, required - `label` string, required - `metrics` object, required - `likes` integer, nullable, required - `reply_count` integer, nullable, required - `content_id` string, nullable, required - `parent_id` string, nullable, required - `root_id` string, nullable, required - union - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'trend', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'transcript', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'creator_rates', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'community', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'product', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'review', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'keyword_history', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'keyword_related', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'keyword_audience', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'brand_history', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'brand_metrics', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'account_history', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'index_creator_metrics', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'creator', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'audience', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'xingtu_creator_metrics', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'xingtu_creator_post', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'pgy_creator_metrics', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'pgy_creator_post', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'xingtu_creator_keywords', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'xingtu_creator_scores', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'xingtu_creator_content_mix', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'xingtu_creator_conversion', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'xingtu_campaign', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'ad', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'advertiser', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'channels_collection', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - object - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'entry', required - `entry_type` 'topic', required - `title` string, nullable, required - `url` string, nullable, required - `rank` integer, nullable, required - `heat` integer, nullable, required - `fields` object, required - … - `unavailable` string[], required - `page` object - `has_more` boolean, required - `cursor` string - `cursor_expires_at` string, date-time - `empty_reason` 'no_match' | 'filtered' - `warnings` object[], required - `code` string, required - `count` integer - `message` string, required - `applied_params` object, required - `includes` object - `cost_credits` integer, required - `error` Error - `code` string, required - `message` string, required - `retryable` boolean, required - `reason` string - `quote_credits` integer - `resets_at` string, date-time - `retry_at` string, date-time - `fix` object, required - `param` string - `allowed` unknown[] - unknown - `example_call` object - `action_url` string - `note` string - CellsEnvelope - `request_id` string, required - `schema_version` 'v1', required - `fetched_at` string, date-time, required - `action` 'search' | 'trending' | 'detail' | 'comments' | 'user_profile' | 'user_posts' | 'call', required - `op` string - `billing` Billing, required - `cost_credits` integer, required - `balance_credits` integer, required - `today_spend_credits` integer, required - `daily_limit_credits` integer, nullable, required - `daily_remaining_credits` integer, nullable, required - `display` string, required - `replayed` boolean, required - `replayed_cost_credits` integer - `status` 'ok' | 'empty' | 'error' | 'not_supported' | 'timeout' | 'skipped', required - `cells` Cell[], required - `platform` string, required - `target` string - `status` 'ok' | 'empty' | 'error' | 'not_supported' | 'timeout' | 'skipped', required - `reason` string - `items` Object[], required - union - Content - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'content', required - `url` string, nullable, required - `format` 'video' | 'image' | 'text' | 'article', nullable, required - `title` string, nullable, required - `text` string, nullable, required - `published_at` string, date-time, nullable, required - `author` object, nullable, required - … - `metrics` object, required - … - `images` string[], nullable, required - `hashtags` string[], nullable, required - `is_pinned` boolean, nullable, required - Account - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'account', required - `username` string, nullable, required - `name` string, nullable, required - `url` string, nullable, required - `bio` string, nullable, required - `verified` boolean, nullable, required - `followers` integer, nullable, required - `following` integer, nullable, required - `posts_count` integer, nullable, required - Comment - `platform` string, required - `id` string, nullable, required - `ref` string, nullable, required - `approx` object[], required - … - `type` 'comment', required - `url` string, nullable, required - `text` string, nullable, required - `published_at` string, date-time, nullable, required - `author` object, required - … - `metrics` object, required - … - `reply_count` integer, nullable, required - `content_id` string, nullable, required - `parent_id` string, nullable, required - `root_id` string, nullable, required - union - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `unavailable` string[], required - `page` object - `has_more` boolean, required - `cursor` string - `cursor_expires_at` string, date-time - `empty_reason` 'no_match' | 'filtered' - `warnings` object[], required - `code` string, required - `count` integer - `message` string, required - `applied_params` object, required - `includes` object - `cost_credits` integer, required - `error` Error - `code` string, required - `message` string, required - `retryable` boolean, required - `reason` string - `quote_credits` integer - `resets_at` string, date-time - `retry_at` string, date-time - `fix` object, required - `param` string - `allowed` unknown[] - unknown - `example_call` object - `action_url` string - `note` string ## Other responses - `400`: invalid_params, not_supported - `401`: unauthorized - `402`: insufficient_balance, max_cost_exceeded - `403`: plan_limit, key_scope_denied - `409`: idempotency_in_progress - `422`: idempotency_conflict - `429`: daily_limit_reached, free_failure_limit, rate_limited - `500`: internal_error - `503`: temporarily_unavailable --- [API](https://skmtc.dev/socialtoai/apis/socialtoai-api.md) · [All operations](https://skmtc.dev/socialtoai/apis/socialtoai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/socialtoai/apis/socialtoai-api/revisions/f46bb0989cc8?raw)