api-config.json 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263
  1. {
  2. "name": "instagram-search",
  3. "displayName": "Instagram 搜索",
  4. "description": "按关键词搜索 Instagram 用户账号或话颒标签,返回匹配的用户列表或标签列表。适用于竞品品牌 Instagram 账号定位、KOL 初筛、品类 话颒标签发现。",
  5. "category": "social-media",
  6. "version": "1.3.0",
  7. "endpoint": {
  8. "method": "GET",
  9. "url": "https://server.fmode.cn/api/voc-social/instagram/v1/fetch_search",
  10. "headers": {
  11. "Authorization": "Bearer ${vocToken}",
  12. "Accept": "application/json"
  13. }
  14. },
  15. "parameters": {
  16. "type": "object",
  17. "required": [
  18. "query"
  19. ],
  20. "properties": {
  21. "query": {
  22. "type": "string",
  23. "description": "搜索关键词,如品牌名 'NEST New York'、'Paddywax'、'SpaRoom'"
  24. },
  25. "select": {
  26. "type": "string",
  27. "description": "搜索类型: 'users'=搜索用户, 'hashtags'=搜索标签",
  28. "default": "users",
  29. "enum": [
  30. "users",
  31. "hashtags"
  32. ]
  33. }
  34. }
  35. },
  36. "requestTransform": {
  37. "queryParams": {
  38. "query": "{{query}}",
  39. "select": "{{select}}"
  40. }
  41. },
  42. "response": {
  43. "type": "object",
  44. "description": "搜索结果",
  45. "properties": {
  46. "users": {
  47. "type": "array",
  48. "description": "匹配的用户列表",
  49. "items": {
  50. "type": "object",
  51. "properties": {
  52. "user": {
  53. "type": "object",
  54. "properties": {
  55. "pk": {
  56. "type": "string",
  57. "description": "用户数字 ID(用于获取帖子)"
  58. },
  59. "username": {
  60. "type": "string",
  61. "description": "用户名"
  62. },
  63. "full_name": {
  64. "type": "string",
  65. "description": "显示名称"
  66. },
  67. "is_verified": {
  68. "type": "boolean",
  69. "description": "是否认证"
  70. },
  71. "profile_pic_url": {
  72. "type": "string",
  73. "description": "头像 URL"
  74. },
  75. "follower_count": {
  76. "type": "integer",
  77. "description": "粉丝数"
  78. },
  79. "is_private": {
  80. "type": "boolean",
  81. "description": "是否私密账号"
  82. }
  83. }
  84. }
  85. }
  86. }
  87. }
  88. }
  89. },
  90. "notes": "搜索结果中的 user.pk 可用于 instagram_user_posts 接口获取帖子列表。username 可用于 instagram_user_info 获取详细资料。",
  91. "usageExamples": [
  92. {
  93. "name": "竞品品牌 IG 账号定位",
  94. "input": {
  95. "query": "NEST New York",
  96. "select": "users"
  97. },
  98. "description": "搜索 NEST New York 的 Instagram 品牌账号,获取 username 和 pk 用于后续分析"
  99. },
  100. {
  101. "name": "品类 KOL 搜索",
  102. "input": {
  103. "query": "candle maker",
  104. "select": "users"
  105. },
  106. "description": "搜索 candle maker 相关 Instagram KOL,初筛候选达人列表"
  107. },
  108. {
  109. "name": "品类话颒标签搜索",
  110. "input": {
  111. "query": "aromatherapy",
  112. "select": "hashtags"
  113. },
  114. "description": "搜索 aromatherapy 相关 IG 标签,发现品类相关话颒"
  115. }
  116. ],
  117. "workflow": {
  118. "description": "推荐调用链",
  119. "steps": [
  120. "本步: instagram-search(query, select='users') → 搜索用户 → 得到 username、pk、follower_count",
  121. "下游: instagram-user-info(username) → 获取账号完整数据(帖子数/简介等)",
  122. "下游: instagram-user-posts(user_id=pk) → 获取用户帖子列表"
  123. ]
  124. },
  125. "reportMapping": {
  126. "slides": [
  127. "竞品对标(Slide4)",
  128. "知识中心(Slide11)"
  129. ],
  130. "dataPoints": [
  131. "竞品品牌 IG 账号发现",
  132. "品类 KOL 候选列表",
  133. "品类话颒标签热度分布"
  134. ]
  135. },
  136. "timeout": 60000,
  137. "retry": {
  138. "maxAttempts": 3,
  139. "delay": 1500,
  140. "backoffMultiplier": 2
  141. },
  142. "tokenConfig": {
  143. "type": "bearer",
  144. "configFile": "~/.openclaw/voc-credentials.json",
  145. "tokenField": "vocToken",
  146. "resolutionOrder": [
  147. "configFile"
  148. ],
  149. "apigId": "Vo3ROWEvDy",
  150. "paymentUrlResolution": {
  151. "description": "动态构建充值URL:在已存在 session token 时查出用户 objectId,拼接到专属充值页面",
  152. "steps": [
  153. "1. 从 voc-credentials.json 获取当前 session token",
  154. "2. 调用 GET https://server.fmode.cn/parse/users/me (Header: X-Parse-Application-Id: ncloudmaster, X-Parse-Session-Token: {token})获取用户 objectId",
  155. "3. 拼接充值URL: https://app.fmode.cn/dev/apig-pay/?user={objectId}&apigid=Vo3ROWEvDy&fun_id=HOkkX72PMF",
  156. "4. 将该URL展示给用户,引导扫码支付"
  157. ],
  158. "userResolveEndpoint": "https://server.fmode.cn/parse/users/me",
  159. "userResolveHeaders": {
  160. "X-Parse-Application-Id": "ncloudmaster",
  161. "X-Parse-Session-Token": "{vocToken}"
  162. },
  163. "paymentBaseUrl": "https://app.fmode.cn/dev/apig-pay/",
  164. "paymentParams": {
  165. "user": "{resolvedUserId}",
  166. "apigid": "Vo3ROWEvDy",
  167. "fun_id": "HOkkX72PMF"
  168. },
  169. "balanceCheckEndpoint": "https://server.fmode.cn/api/apig/getApig"
  170. },
  171. "onMissing": {
  172. "action": "showPaymentQR",
  173. "qrCodeUrl": "https://app.fmode.cn/dev/apig-pay/?apigid=Vo3ROWEvDy&fun_id=HOkkX72PMF",
  174. "title": "扫码开通 VOC-AI 数据服务",
  175. "message": "此 Skill 需要有效的 API Token。请先打开充值页面完成登录和充值;当用户提供 session token 后,请由 OpenClaw 运行 node scripts/tools/set-voc-token.js <session-token> 写入 ~/.openclaw/voc-credentials.json 的 vocToken 字段,再重试当前 Skill。",
  176. "tokenSetupCommandTemplate": "node scripts/tools/set-voc-token.js {sessionToken}",
  177. "tokenSetupInstructions": "当用户完成登录和充值后,如果用户把 session token 发给你,请直接运行 node scripts/tools/set-voc-token.js <session-token> 写入 ~/.openclaw/voc-credentials.json,然后重试当前 Skill。"
  178. },
  179. "onBalanceInsufficient": {
  180. "action": "resolveUserThenShowPayment",
  181. "title": "VOC-AI Token 余额不足,请扫码充值",
  182. "message": "当前 Token 余额不足,我将为你生成专属充值链接,扫码支付后即可继续使用。"
  183. }
  184. },
  185. "errorHandling": {
  186. "balanceInsufficient": {
  187. "conditions": [
  188. {
  189. "responseField": "code",
  190. "operator": "in",
  191. "value": [
  192. -2,
  193. -3,
  194. -10,
  195. 402,
  196. 429
  197. ]
  198. },
  199. {
  200. "responseField": "msg",
  201. "operator": "contains",
  202. "value": [
  203. "余额不足",
  204. "insufficient",
  205. "balance",
  206. "quota",
  207. "没有开通",
  208. "权限或余额"
  209. ]
  210. },
  211. {
  212. "responseField": "mess",
  213. "operator": "contains",
  214. "value": [
  215. "余额不足",
  216. "insufficient",
  217. "balance",
  218. "quota",
  219. "没有开通",
  220. "权限或余额"
  221. ]
  222. },
  223. {
  224. "responseField": "message",
  225. "operator": "contains",
  226. "value": [
  227. "余额不足",
  228. "insufficient",
  229. "balance",
  230. "没有开通",
  231. "权限或余额"
  232. ]
  233. }
  234. ],
  235. "matchMode": "any",
  236. "trigger": "tokenConfig.onBalanceInsufficient"
  237. },
  238. "unauthorized": {
  239. "conditions": [
  240. {
  241. "responseField": "code",
  242. "operator": "in",
  243. "value": [
  244. 401,
  245. 403
  246. ]
  247. },
  248. {
  249. "responseField": "msg",
  250. "operator": "contains",
  251. "value": [
  252. "unauthorized",
  253. "token",
  254. "invalid",
  255. "auth"
  256. ]
  257. }
  258. ],
  259. "matchMode": "any",
  260. "trigger": "tokenConfig.onMissing"
  261. }
  262. }
  263. }