{
  "brand": "DK Social API",
  "version": "2026-07-03",
  "visibility": "public",
  "platforms": ["XHS", "DY", "SPH", "KS", "DOWNLOAD"],
  "auth": {
    "type": "Bearer API Key",
    "header": "Authorization: Bearer YOUR_API_KEY"
  },
  "endpoints": {
    "rest": "POST https://api.dk-ai.tech/api/tools/{toolName}",
    "mcp": "https://api.dk-ai.tech/mcp"
  },
  "pagination": {
    "firstPage": "Do not send cursor, or send an empty cursor.",
    "nextPage": "Use pagination.nextCursor as the next request cursor.",
    "pageFallback": "For XHS search, use page=2/3/4 when nextCursor is not returned.",
    "stopWhen": "Stop when pagination.hasMore is false or nextCursor is empty.",
    "batching": "For 20 or 50 pages, write every page to CSV/JSONL and checkpoint every 5 pages."
  },
  "standardFields": {
    "account": [
      "avatar",
      "bio",
      "verified",
      "verifyInfo",
      "followersCount",
      "followingCount",
      "likedCount",
      "collectedCount",
      "postCount",
      "location"
    ],
    "post": [
      "coverUrl",
      "title",
      "content",
      "publishTime",
      "likeCount",
      "collectCount",
      "commentCount",
      "shareCount",
      "viewCount",
      "imageUrls",
      "tags",
      "sticky",
      "commercial"
    ],
    "comment": [
      "userName",
      "userAvatar",
      "commentText",
      "likeCount",
      "replyCount",
      "commentTime",
      "ipLocation",
      "isAuthorReply",
      "isSticky"
    ],
    "note": "这些字段只有在源数据返回时才会出现；DK 不会用 0 或空字符串假造缺失字段。普通公开工具不返回敏感账号标识。"
  },
  "tools": [
    {
      "name": "xhs_search_notes",
      "platform": "XHS",
      "use": "根据关键词搜索内容，返回列表、标题、作者、封面、互动数据和可打开链接。",
      "params": ["keyword", "limit", "page"]
    },
    {
      "name": "xhs_get_note_detail",
      "platform": "XHS",
      "use": "根据内容链接或内容 ID 查询详情，返回标题、正文、图片/视频、作者和互动数据。",
      "params": ["note_url", "url"]
    },
    {
      "name": "xhs_extract_note_token",
      "platform": "XHS",
      "use": "根据分享文本或链接做留存预检测，提取内容 ID 和访问 token。",
      "params": ["share_text", "note_url", "url"]
    },
    {
      "name": "xhs_get_author_profile",
      "platform": "XHS",
      "use": "根据作者 ID 查询公开主页资料。若源数据返回，可提供 avatar、bio、followersCount、followingCount、likedCount、collectedCount、postCount、verified、verifyInfo、location。",
      "params": ["author_id"]
    },
    {
      "name": "xhs_get_author_notes",
      "platform": "XHS",
      "use": "根据作者 ID 查询主页公开内容列表，返回作品列表、封面、标题、互动数据和下一页游标；每条作品会尽量补充 coverUrl、content、publishTime、likeCount、collectCount、commentCount、shareCount、imageUrls、tags。",
      "params": ["author_id", "cursor", "limit"]
    },
    {
      "name": "xhs_get_note_comments",
      "platform": "XHS",
      "use": "根据内容 ID 查询公开评论列表，返回评论内容、时间、点赞数和分页信息；会尽量补充 userName、userAvatar、commentText、replyCount、commentTime、ipLocation。",
      "params": ["note_id", "limit", "lastCursor", "pages"]
    },
    {
      "name": "xhs_get_primary_comments",
      "platform": "XHS",
      "use": "根据内容 ID 获取一级公开评论，返回评论内容、时间、点赞数和分页信息。",
      "params": ["note_id", "limit", "lastCursor", "pages"]
    },
    {
      "name": "xhs_get_primary_secondary_comments",
      "platform": "XHS",
      "use": "根据内容 ID 获取一级公开评论和二级公开评论，返回层级关系、评论内容和分页信息。",
      "params": ["note_id", "limit", "lastCursor", "pages", "subCommentPages"]
    },
    {
      "name": "dy_search_videos",
      "platform": "DY",
      "use": "根据关键词搜索内容，返回视频列表、标题/描述、作者、封面、互动数据和下一页游标。",
      "params": ["keyword", "limit", "cursor", "search_id"]
    },
    {
      "name": "dy_get_hot_search_list",
      "platform": "DY",
      "use": "查询热搜榜单，返回榜单词、热度和趋势信息。",
      "params": []
    },
    {
      "name": "dy_get_hot_video_list",
      "platform": "DY",
      "use": "查询热门内容榜单，返回热门内容、作者和互动数据。",
      "params": []
    },
    {
      "name": "dy_get_video_detail",
      "platform": "DY",
      "use": "根据视频 ID 查询内容详情，返回标题/描述、作者、封面、互动数据和可打开链接。",
      "params": ["video_id"]
    },
    {
      "name": "dy_get_video_by_share_url",
      "platform": "DY",
      "use": "根据分享链接解析内容详情，返回标题/描述、作者、封面、互动数据和可打开链接。",
      "params": ["share_url"]
    },
    {
      "name": "dy_get_author_profile",
      "platform": "DY",
      "use": "根据作者 ID 查询公开主页资料，返回昵称、头像、简介和公开统计信息。",
      "params": ["author_id"]
    },
    {
      "name": "dy_get_author_videos",
      "platform": "DY",
      "use": "根据作者 ID 查询主页公开视频列表，返回作品列表、封面、描述、互动数据和下一页游标。",
      "params": ["author_id", "limit", "cursor"]
    },
    {
      "name": "dy_get_video_comments",
      "platform": "DY",
      "use": "根据视频 ID 查询公开评论列表，返回评论内容、时间、点赞数和分页信息。",
      "params": ["video_id", "limit", "cursor"]
    },
    {
      "name": "sph_search_default",
      "platform": "SPH",
      "use": "根据关键词搜索内容，返回默认排序的内容列表、标题、作者、封面和互动数据。",
      "params": ["keyword", "session_buffer"]
    },
    {
      "name": "sph_search_latest",
      "platform": "SPH",
      "use": "根据关键词搜索内容，返回最新排序的内容列表、标题、作者、封面和互动数据。",
      "params": ["keyword", "session_buffer"]
    },
    {
      "name": "sph_search_ordinary",
      "platform": "SPH",
      "use": "根据关键词搜索内容，返回综合排序的内容列表、标题、作者、封面和互动数据。",
      "params": ["keyword", "session_buffer"]
    },
    {
      "name": "sph_get_video_detail",
      "platform": "SPH",
      "use": "根据内容 ID 查询详情，返回标题、作者、封面、互动数据和可打开链接。",
      "params": ["video_id", "export_id"]
    },
    {
      "name": "sph_get_video_by_share_url",
      "platform": "SPH",
      "use": "根据分享链接解析内容详情，返回标题、作者、封面、互动数据和可打开链接。",
      "params": ["share_url"]
    },
    {
      "name": "sph_get_comments",
      "platform": "SPH",
      "use": "根据内容 ID 查询公开评论列表，返回评论内容、时间、点赞数和分页信息。",
      "params": ["video_id", "lastBuffer", "comment_id"]
    },
    {
      "name": "sph_get_author_homepage",
      "platform": "SPH",
      "use": "根据作者 ID 查询主页公开内容，返回主页作品列表、作者资料和下一页游标。",
      "params": ["author_id", "lastBuffer"]
    },
    {
      "name": "ks_search_videos",
      "platform": "KS",
      "use": "根据关键词搜索视频内容，返回列表、标题/描述、作者、封面、互动数据和下一页游标。",
      "params": ["keyword", "pcursor"]
    },
    {
      "name": "ks_search_comprehensive",
      "platform": "KS",
      "use": "根据关键词综合搜索内容，返回列表、标题/描述、作者、封面、互动数据和下一页游标。",
      "params": ["keyword", "pcursor"]
    },
    {
      "name": "ks_get_video_detail",
      "platform": "KS",
      "use": "根据内容 ID 查询详情，返回标题/描述、作者、封面、互动数据和可打开链接。",
      "params": ["photo_id", "video_id"]
    },
    {
      "name": "ks_get_video_by_url",
      "platform": "KS",
      "use": "根据分享链接解析内容详情，返回标题/描述、作者、封面、互动数据和可打开链接。",
      "params": ["share_url"]
    },
    {
      "name": "ks_get_video_comments",
      "platform": "KS",
      "use": "根据内容 ID 查询公开评论列表，返回评论内容、时间、点赞数和分页信息。",
      "params": ["photo_id", "video_id", "pcursor"]
    },
    {
      "name": "ks_get_author_videos",
      "platform": "KS",
      "use": "根据作者 ID 查询主页公开视频列表，返回作品列表、封面、描述、互动数据和下一页游标。",
      "params": ["author_id", "pcursor"]
    },
    {
      "name": "video_download_parse",
      "platform": "DOWNLOAD",
      "use": "根据公开视频链接解析标题、封面和可用媒体地址。",
      "params": ["url"]
    }
  ],
  "notes": [
    "本目录只描述 DK 当前公开并启用的工具。",
    "普通工具不应返回敏感账号标识或内部信息。",
    "开通、充值和额度调整请联系管理员。",
    "每次新增、开放、关闭、改名、改参数、改返回字段、改扣费、改分页逻辑或改错误码后，必须同步更新本目录。"
  ]
}