Skip to main content
GET
扫描一段目录候选

路径参数

bookmd5
string
必填

文档的内容标识。取自 GET /study-sets/{topicid}/documents 响应里各项的 bookmd5、GET /ui-state 的 state.bookmd5,或 GET /search?scope=documents。

查询参数

start
integer
必填

起始页,PDF 页序。与结束页一同必填,缺任一项会被拒。

必填范围: x >= 1
end
integer
必填

结束页,PDF 页序。与起始页一同必填,单次跨度上限 60 页。

必填范围: x >= 1

响应

标题候选。

candidates
object[]

检测出的标题候选。同一页内的先后不是阅读顺序。

pagesScanned
number

为 0 表示页范围越界或整段为留白,此时不返回 nextStart。

truncated
boolean

扫描页数达到单次跨度上限,仅返回已扫描的部分。

nextStart
number
hint
string