DK Social API Docs
公开 API 文档
本页供智能体和开发者理解 DK 工具的 REST API、MCP 接入、API Key、分页、调用日志和积分扣减方式。
当前公开工具覆盖 XHS、DY、KS、SPH。工具、参数、返回字段、扣费、分页或错误码变化后,必须同步更新本页。
分页规则
自然页
列表工具返回当前数据页的全部有效记录,不承诺固定 20 条。请以 resultCount 为本页实际条数。
下一页
第 1 页不传 pageToken;下一页只传 data.pagination.nextPageToken,不要解析或修改。
停止条件
hasMore=false 或 nextPageToken 为空时停止。短页不等于失败。
响应契约
REST 正式响应外层为 `creditsUsed`、`creditsRemaining`、`traceId`、`durationMs` 和 `data`。 业务列表位于 `data.items`,分页位于 `data.pagination`。MCP 调用的业务结果位于 `result.structuredContent.data`,积分与追踪信息位于 `result.structuredContent.creditsUsed`、 `result.structuredContent.creditsRemaining` 和 `result.structuredContent.traceId`。旧客户端不得继续读取 `photo_id`、`pcursor` 等来源字段,应按客户端迁移 JSON 改为 DK 标准字段。
安全引用与 MCP 错误
加密引用
authorRef 和 pageToken 是 DK 加密引用,只能原样回传,不要解析、修改或写入公开日志。XHS 搜索或详情返回的 authorRef 可直接作为作者工具的 author_id。XHS 搜索返回 desktopUrl 时可作为官方 PC 内容链接直接使用。
MCP 业务错误
MCP 的 error.code 是 JSON-RPC 传输码;DK 业务错误码读取 error.data.code,并按该值处理 NO_RESULTS、RATE_LIMITED 等状态。
当前已开放工具
| 工具名 | 平台 | 用途 | 主要参数 | 积分 |
|---|---|---|---|---|
| xhs_get_primary_comments | XHS | XHS 一级评论,仅用于公开信息调研。 | note_id, pageToken | 20/页 |
| xhs_get_author_notes | XHS | XHS 作者作品列表,仅用于公开信息调研。 | author_id, pageToken | 20/页 |
| xhs_get_author_profile | XHS | XHS 作者资料,仅用于公开信息调研。 | author_id | 10/次 |
| xhs_get_note_comments | XHS | XHS 公开评论,仅用于公开信息调研。 | note_id, pageToken | 20/页 |
| xhs_search_notes | XHS | XHS 内容搜索,仅用于公开信息调研。 | keyword, pageToken | 20/页 |
| xhs_get_note_detail | XHS | XHS 内容详情,仅用于公开信息调研。 | note_id, note_url, url, note_type | 10/次 |
| dy_get_author_profile | DY | DY 作者资料,仅用于公开信息调研。 | author_id | 10/次 |
| dy_get_video_comments | DY | DY 公开评论,仅用于公开信息调研。 | video_id, pageToken | 20/页 |
| dy_search_videos | DY | DY 内容搜索,仅用于公开信息调研。 | keyword, pageToken | 20/页 |
| dy_get_video_detail | DY | DY 内容详情,仅用于公开信息调研。 | video_id | 10/次 |
| dy_get_video_by_share_url | DY | DY 分享链接解析,仅用于公开信息调研。 | share_url | 10/次 |
| dy_get_hot_search_list | DY | DY 热搜榜,仅用于公开信息调研。 | none | 20/页 |
| dy_get_hot_video_list | DY | DY 热门内容榜,仅用于公开信息调研。 | none | 20/页 |
| dy_get_author_videos | DY | DY 作者作品列表,仅用于公开信息调研。 | author_id, pageToken | 20/页 |
| sph_get_author_homepage | SPH | SPH 作者主页内容,仅用于公开信息调研。 | author_id, pageToken | 20/页 |
| sph_get_video_detail | SPH | SPH 内容详情,仅用于公开信息调研。 | video_id, export_id, contentRef | 10/次 |
| sph_get_video_by_share_url | SPH | SPH 分享链接解析,仅用于公开信息调研。 | share_url | 10/次 |
| ks_get_video_comments | KS | KS 公开评论,仅用于公开信息调研。 | photo_id, video_id, pageToken | 20/页 |
| ks_get_video_by_url | KS | KS 分享链接解析,仅用于公开信息调研。 | share_url | 10/次 |
| ks_search_videos | KS | KS 内容搜索,仅用于公开信息调研。 | keyword, pageToken | 20/页 |
| ks_get_video_detail | KS | KS 内容详情,仅用于公开信息调研。 | photo_id, video_id | 10/次 |
| ks_get_author_videos | KS | KS 作者作品列表,仅用于公开信息调研。 | author_id, pageToken | 20/页 |
标准返回字段
DK 会补齐稳定标准字段,方便前端和智能体消费。字段只有在数据页返回时才有值;缺失时返回 null, 不用 0 或空字符串伪造。普通公开工具不返回敏感账号标识、受保护媒体字段或内部信息。