bili_quickstart
返回哔哩哔哩开放平台的核心约定:主机、OAuth2 换 token/刷新、2.0 签名算法、通用返回结构、错误码分段、视频投稿技术限制。第一次使用或需要写对接代码前先调它。
无参数
下面是服务实际注册的工具 —— 入参直接取自运行中的 src/server.mjs(tools/list),不是手抄的。带 * 的是必填。
返回哔哩哔哩开放平台的核心约定:主机、OAuth2 换 token/刷新、2.0 签名算法、通用返回结构、错误码分段、视频投稿技术限制。第一次使用或需要写对接代码前先调它。
无参数
按目录或类型列出开放平台文档。folder 支持包含匹配(如 "视频稿件"、"直播"、"消息推送");type 可选 api / guide / event / protocol / multi-api。返回每条含 ref(#num)、标题、METHOD 路径、所在目录。
| 参数 | 类型 | 说明 |
|---|---|---|
| folder | string | 目录名包含匹配,例如 视频稿件管理 / 交易电商 / 消息推送 |
| type | enum | |
| limit | integer | 默认 60 |
在 170 篇开放平台文档里搜索接口名、字段名、错误信息、协议细节。先按标题/目录/摘要命中,再回退全文。返回 ref(#num) 可用于 bili_api_spec / bili_docs_get。
| 参数 | 类型 | 说明 |
|---|---|---|
| query * | string | 关键词,支持中文,如 投稿 / upload_token / 弹幕 / refresh_token |
| limit | integer | 默认 8 |
按 ref(#num / id / 标题 / 文件名 / 接口URL)返回文档完整 Markdown。协议、长连、Webhook 等非接口文档用它。maxChars 默认 40000。
| 参数 | 类型 | 说明 |
|---|---|---|
| ref * | string | #12 / uuid / 标题含字 / 012_视频稿件提交.md |
| maxChars | integer |
返回某个接口的方法、完整 URL、scope、url/body 参数(类型+是否必填+说明)、响应字段、请求与响应样例。这是写调用代码前该看的工具。
| 参数 | 类型 | 说明 |
|---|---|---|
| ref | string | #12 / 标题 / URL |
| url | string | 直接按接口 URL 定位 |
按开放平台规则生成 Authorization 与 x-bili-* 头,并输出可直接粘贴的 curl。凭据可用参数传入,否则读环境变量 BILI_CLIENT_ID / BILI_APP_SECRET / BILI_ACCESS_TOKEN。body 传对象会自动 JSON 序列化(GET 请忽略)。
| 参数 | 类型 | 说明 |
|---|---|---|
| method | string | 默认 GET |
| url * | string | 完整接口 URL |
| query | object | url 参数 |
| body | any | body 参数对象(GET 不需要) |
| clientId | string | |
| appSecret | string | |
| accessToken | string |
给 ref(#num/标题/URL)或直接 url,自动签名并发起真实请求。query/body 传对象。dryRun=true 时只返回将要发出的请求与 curl,不发送。凭据读 BILI_CLIENT_ID / BILI_APP_SECRET / BILI_ACCESS_TOKEN。
| 参数 | 类型 | 说明 |
|---|---|---|
| ref | string | #12 / 标题 / 接口URL |
| method | string | |
| url | string | |
| query | object | |
| body | any | |
| dryRun | boolean | true=只签名不发送,默认 false |
查开放平台错误码含义。支持 4002 / 127007 这种完整码,也支持 4 位前缀模糊(如 1230 列出所有视频稿件码)。
| 参数 | 类型 | 说明 |
|---|---|---|
| code * | string | 错误码,如 4002 |
| fuzzy | boolean | true=按前缀列出,默认 false |
按 method / scope / host / 路径关键词过滤端点,返回 #ref、METHOD、PATH、scope。适合「所有需要 SHOP_ORDER_INFO 的 POST 接口」这类问题,比全文搜索更准。默认最多 40 条。source:"web" 时改列开放平台文档里没有的「隐藏能力」(主站 Web,如举报 / 拉黑 / 动态 / 评论 / 直播),source:"all" 两边一起列。默认最多 40 条。
| 参数 | 类型 | 说明 |
|---|---|---|
| method | enum | |
| scope | string | 权限点,如 ARC_BASE |
| host | string | member.bilibili.com / openupos.bilivideo.com / api.bilibili.com |
| pathContains | string | 路径或标题关键词 |
| source | enum | open=开放平台(默认),web=主站隐藏能力,all=两边都列 |
| limit | integer |
不带参数:列出全部 scope 及覆盖的端点数。带 scope:列出该 scope 下所有端点。带 ref:返回该接口需要的 scope 及每个 scope 下的其它接口。用于确认应用该申请哪些权限。
| 参数 | 类型 | 说明 |
|---|---|---|
| scope | string | |
| ref | string |
把 query/body 按文档类型做转换(int→数字、bool→布尔、[]x→数组),检查必填是否缺失、是否多传了文档没有的字段,并给出最终 URL/body 与签发 curl 的下一步。写代码前用它避免类型错误。
| 参数 | 类型 | 说明 |
|---|---|---|
| ref * | string | |
| query | object | |
| body | object |
按接口规格生成可运行代码骨架,含完整 2.0 签名实现、该接口的全部参数(必填直接写入、可选注释掉)、返回码处理。lang 支持 python / node / curl / java / php / go。比手写签名可靠。
| 参数 | 类型 | 说明 |
|---|---|---|
| ref * | string | |
| lang | enum | 默认 python |
给文件大小,算出该用单文件还是分片、分几片、每片范围、part_number 起止,并输出完整调用顺序(init → upload → complete → 提交)与可直接粘的 curl。
| 参数 | 类型 | 说明 |
|---|---|---|
| fileSizeBytes | number | |
| fileSizeMB | number | 与 fileSizeBytes 二选一 |
| chunkMB | number | 默认 10MB |
| filename | string |
action=help 讲清整条链路;authorize-url 拼出授权页链接;status 看 clientId/secret/token 各自有没有、从哪来;exchange 用 code 换 access_token;refresh 续期(refresh_token 只能用一次)。换到的 token 会自动写入 secrets/open-platform.json。凭据取自参数、BILI_CLIENT_ID/BILI_APP_SECRET 或该文件。
| 参数 | 类型 | 说明 |
|---|---|---|
| action | enum | 默认 help |
| code | string | |
| refreshToken | string | |
| clientId | string | |
| clientSecret | string | |
| gourl | string | authorize-url 用:授权回调地址,须与应用「授权回调域」一致 |
| state | string | authorize-url 用:随机串,默认自动生成 |
action=list 列出 41 个推送事件(按模块分组);action=detail 看某个事件的内容字段;action=verify-code 生成验签 + verify_webhooks 应答代码(python/node)。验签用 SHA1(secret + 原始 body),必须用原始字节。
| 参数 | 类型 | 说明 |
|---|---|---|
| action | enum | 默认 list |
| ref | string | detail 用,#num 或事件名 |
| lang | enum | verify-code 用,默认 python |
返回直播间 WebSocket 长连协议(建连流程、16 字节包头、Operation 表、zlib 多包解析),可选生成内联 Python 客户端。对应文档 #43–#46。
| 参数 | 类型 | 说明 |
|---|---|---|
| code | enum | 默认 none |
action=list 列出 43 个 mock 接口(按模块);action=map 把正式接口换算成 mock 地址(两者路径不总一致);action=call 真实调用 mock(同样走 2.0 签名,凭据不足时用 dryRun)。
| 参数 | 类型 | 说明 |
|---|---|---|
| action | enum | 默认 list |
| ref | string | map 用:正式接口的 #num / 标题 |
| mockUrl | string | call 用:mock 完整地址 |
| query | object | |
| body | any | |
| dryRun | boolean |
管理主站 www.bilibili.com 的浏览器 Cookie(与开放平台 client_id/secret 是两套体系)。action=status 列关键 cookie 与过期时间;whoami 验证登录态;import 收下 EditThisCookie 数组 / {name:value} / "k=v; k=v";set / clear / export。默认脱敏,reveal:true 才显示原值。
| 参数 | 类型 | 说明 |
|---|---|---|
| action | enum | 默认 status |
| jar | any | import 的 cookie 内容 |
| name | string | set 用 |
| value | string | set 用 |
| reveal | boolean | 显示完整值(默认脱敏) |
| file | string | 指定 jar 文件;默认按 参数 → BILI_COOKIE_FILE → 包目录 secrets/cookies.json → 启动方 cwd 的顺序解析 |
用 Cookie 罐调主站/主 API 的 Web 接口(不是开放平台的那套签名接口)。自动带 Cookie、UA、Referer;POST 若给 form 则按 x-www-form-urlencoded 并自动补 csrf=bili_jct。路径含 /wbi/、/polymer/ 等会自动做 wbi 签名(w_rid+wts),可显式 wbi:true/false 覆盖。dryRun 只看请求。
| 参数 | 类型 | 说明 |
|---|---|---|
| path | string | 如 x/web-interface/nav,默认拼到 https://www.bilibili.com |
| url | string | 完整 URL,给了就忽略 path |
| method | enum | 默认 GET(有 form 则 POST) |
| query | object | |
| form | object | 表单参数,自动带 csrf |
| body | any | JSON body |
| headers | object | |
| wbi | boolean | 强制开关 wbi 签名;留空则按路径自动判断(/wbi/、/polymer/ 等) |
| dryRun | boolean | |
| maxBytes | integer | 响应截断,默认 60000 |