文档 API v2getCatalogWork

getCatalogWork

获取一部作品

作品详情。spoiler=none|minor|major 是 tags 块的上限，缺省为 none。已合并 ids 返回 404 ENTITY_MERGED，并带 Link rel=canonical。r18 在没有 nsfw=true 时为 404。可匿名调用，按 IP 地址限流；应用密钥或带 catalog:read 的用户访问令牌各有更高的额度。include= 接受 titles, refs, relations, credits, releases, popularity, ratings, tags, playtimes, series, platforms, intros, covers, screenshots, characters, companies, engines, links。view=full 即 titles, refs, intros, covers, companies, tags, releases, ratings, relations, engines, series, links；credits, popularity, playtimes, platforms, screenshots, characters 只在 include= 点名时返回。

get/v2/catalog/works/{id}

scope catalog:read可匿名调用（不带凭据按 IPv4 地址或 IPv6 /64 限流（默认 30 次/分钟、1,000 次/天）；带 nmk_ 应用密钥或带 catalog:read 的用户访问令牌则走各自更高的额度）

参数

参数	类型	位置	说明
`id` 必填	`string`	`path`	十进制 catalog id。
`nsfw`	`string`	`query`	true 包含 r18。false 或缺省则隐藏 r18。仅 true 或 false。
`view`	`string`	`query`	basic（默认）或 full。封闭词表。
`include`	`string`	`query`	逗号分隔的块。未知 token 返回 400 UNKNOWN_INCLUDE。
`fields`	`string`	`query`	逗号分隔的顶层键。未知 token 返回 400 UNKNOWN_FIELD。object 与 id 始终保留。
`spoiler`	`string`	`query`	标签块的剧透上限：none（缺省）、minor 或 major。封闭词表；未知值为 400。超过上限的标签行不下发。只有源自 VNDB 的标签词表带剧透等级 —— Bangumi 与 DLsite 的民间分类不发布剧透概念，因此那些行读作 none —— 缺省为安全上限。

响应

bannerobject 必填可空
选定的横版图片。没有则为 null。origin=screenshot 表示该作品没有横版封面、改用截图兜底。
- hashstring 必填
  图床内容哈希。
- heightintegerint64 必填可空
  像素高度。未知则为 null。
- originstring 必填
  该图选自哪个池。screenshot 只会出现在 banner 上，是作品没有任何横版封面时的截图回落。censored 是从官方 R18 原图派生的一方重模糊替身图，仅在竖版槽位没有任何其他可用图时提供。
  枚举coverscreenshotcensored
- sexualstring 必填可空
  性描写。null 表示未评估。
  枚举safesuggestiveexplicit
- sourcestring 必填
  开放词表来源。不得用作判别条件。
- thumbhashstring 必填可空
  Thumbhash。未知则为 null。
- urlstringuri 必填
  图片的绝对 URL。从不为裸 hash。
- violencestring 必填可空
  暴力描写。null 表示未评估。目前没有任何 catalog 行经过评估；该值恒为 null。
  枚举tameviolentbrutal
- widthintegerint64 必填可空
  像素宽度。未知则为 null。
charactersobject[]
仅当 include=characters 时出现。没有则为空数组。
- display_namestring 必填
  不得用作判别条件。
- figureobject 必填可空
  立绘图片。没有则为 null。
- idstring 必填
  catalog 角色 id。
- identitystring
  catalog.work.roster.suppressed 提案的不透明花名册行 identity；回传即可，切勿重建。仅经配音署名触达该角色时缺席，此时 roster_role 为 unknown、spoiler 为 none。不得用作判别条件。
- imageobject 必填可空
  角色图片。没有则为 null。
- latinstring 必填可空
  未记录则为 null。不得用作判别条件。
- localizedmap<string, object> 必填
  BCP-47 键。没有则为空对象。不得用作判别条件。
- objectstring 必填
  类型判别字段。恒为 character。
  枚举character
- roster_rolestring 必填
  在该作品上的出场强度。
  枚举mainsecondaryappearsunknown
- spoilerstring 必填
  本次出演的剧透等级。
  枚举noneminormajor
- voicesobject[] 必填
  该出场上的配音署名。空数组，从不为 null。
claimobject 必填可空
未认领时为 null。view=basic 下也从不省略。
- content_limitstring 必填
  本认领的编辑展示轴。
  枚举sfwnsfw
- sitestring 必填
  认领站点 key。
- site_work_idstring 必填
  站点自己的作品 id。kungal、moyu 与 letmoe 按 catalog id 给页面编号，在这几站它等于作品 id；其他站点用各自的编号。
- statestring 必填
  认领生命周期状态。
  枚举livedraftpendingdeclinedhidden
companiesobject[]
仅当 include=companies 时出现。没有则为空数组。
- attribution_rolestring 必填
  在本作品上的主要身份。
  枚举circlepublisherdeveloperbrand
- company_kindstring 必填
  公司注册表类别。
  枚举game_brandbunkopublisheranime_studiodoujin_circlegroup
- display_namestring 必填
  不得用作判别条件。
- idstring 必填
  catalog 公司 id。
- localizedmap<string, object> 必填
  BCP-47 键。没有则为空对象。不得用作判别条件。
- logoobject
- objectstring 必填
  类型判别字段。恒为 company。
  枚举company
- work_countintegerint64 必填
  在同一 nsfw 下、不加其他筛选时，GET /v2/catalog/works?company_id={id} 列出的作品数。
content_limitstring 必填
展示轴：这部作品能否展示给没有选择成人内容的读者。每部作品都带，认领与否，也是 content_limit 过滤器筛选的值。它不是 content_rating：封面安全的 r18 游戏是 sfw，封面全部被判 explicit 的作品不论分级都是 nsfw。已认领作品在 claim.content_limit 里带同一个值。
枚举sfwnsfw
content_ratingstring 必填
作品的年龄轴。
枚举all_agessensitiver18
coverobject 必填可空
选定的竖版图片。没有则为 null。
- hashstring 必填
  图床内容哈希。
- heightintegerint64 必填可空
  像素高度。未知则为 null。
- originstring 必填
  该图选自哪个池。screenshot 只会出现在 banner 上，是作品没有任何横版封面时的截图回落。censored 是从官方 R18 原图派生的一方重模糊替身图，仅在竖版槽位没有任何其他可用图时提供。
  枚举coverscreenshotcensored
- sexualstring 必填可空
  性描写。null 表示未评估。
  枚举safesuggestiveexplicit
- sourcestring 必填
  开放词表来源。不得用作判别条件。
- thumbhashstring 必填可空
  Thumbhash。未知则为 null。
- urlstringuri 必填
  图片的绝对 URL。从不为裸 hash。
- violencestring 必填可空
  暴力描写。null 表示未评估。目前没有任何 catalog 行经过评估；该值恒为 null。
  枚举tameviolentbrutal
- widthintegerint64 必填可空
  像素宽度。未知则为 null。
coversobject[]
仅当 include=covers 时出现。没有则为空数组。
- cover_kindstring 必填
  来自置顶阶梯的上游封面类别：main、dig、pkgfront、pkgback 及其同类。开放词表。未记录则为空。不得用作判别条件。
- hashstring 必填
  图床内容哈希。
- heightintegerint64 必填可空
  像素高度。未知则为 null。
- idstring 必填
  catalog_work_cover 行 id，而非图片 hash。
- portrait_pinnedboolean 必填
  该行是否钉为竖版封面。
- sexualstring 必填可空
  性描写。null 表示未评估。
  枚举safesuggestiveexplicit
- sourcestring 必填
  开放词表来源。不得用作判别条件。
- thumbhashstring 必填可空
  Thumbhash。未知则为 null。
- urlstringuri 必填
  图片的绝对 URL。从不为裸 hash。
- violencestring 必填可空
  暴力描写。null 表示未评估。目前恒为 null。
  枚举tameviolentbrutal
- vote_countintegerint64 必填
  此封面行的净票数。
- widthintegerint64 必填可空
  像素宽度。未知则为 null。
created_atstringdate-time 必填
RFC 3339 UTC。
creditsobject[]
仅当 include=credits 时出现。没有则为空数组。
- creditsobject[] 必填
  记在此 role 下的署名。空数组，从不为 null。
- role_keystring 必填
  注册表 token；与 /v2/catalog/roles 相接。并不总是 ASCII：约 231 个在用注册键中有 39 个是 CJK，另有一些以数字开头，此处曾声明的 ascii-slug pattern 会拒绝大多数真实署名组。不得用作判别条件。
- role_namestring 必填
  不得用作判别条件。
display_namestring 必填
主显示名。永不为空。不得用作判别条件。
enginesobject[]
仅当 include=engines 时出现。没有则为空数组。
- display_namestring 必填
  不得用作判别条件。
- idstring 必填
  catalog 引擎 id。
- objectstring 必填
  类型判别字段。恒为 engine。
  枚举engine
- work_countintegerint64 必填
  在同一 nsfw 下、不加其他筛选时，GET /v2/catalog/works?engine_id={id} 列出的作品数。
idstring 必填
作品 id。十进制整数的 JSON 字符串。
introsobject[]
仅当 include=intros 时出现。没有则为空数组。
- is_machineboolean 必填
  该简介是否机翻。
- langstringbcp47 必填
  BCP-47 语言标签。
- sourcestring 必填
  开放词表来源。不得用作判别条件。
- valuestring 必填
  不得用作判别条件。
latinstring 必填可空
罗马字转写。未记录则为 null。不得用作判别条件。
linksobject[]
仅当 include=links 时出现。没有则为空数组。
- sourcestring 必填
  开放词表来源。不得用作判别条件。
- urlstringuri 必填
  绝对 URL。
localizedmap<string, object> 必填
BCP-47 键，稀疏。没有则为空对象。不得用作判别条件。
- «key»object
mediumstring 必填
从不为 null。
枚举galgamemanganovelanimeasmrdoujin_gamemusic
objectstring 必填
类型判别字段。恒为 work。
枚举work
olangstringbcp47 必填
原语言，BCP-47。开放词表语言。
platformsobject[]
仅当 include=platforms 时出现。没有则为空数组。
- platformstring 必填
  不得用作判别条件。
- sourcestring 必填
  开放词表来源。不得用作判别条件。
playtimesobject[]
仅当 include=playtimes 时出现。没有则为空数组。
- minutesintegerint64 必填
  估计分钟数。
- sourcestring 必填
  开放词表来源。不得用作判别条件。
- vote_countintegerint64 必填
  支撑该估计的票数。
popularityobject[]
仅当 include=popularity 时出现。没有则为空数组。
- metricstring 必填
  来源原生的指标令牌。唯一的例外是 nextmoe/favorites,它是我们自己的:把这部作品放进收藏夹的去重用户数。与其他每一行不同,这一行恒有,因此 0 表示无人收藏,而不是未知。
- sourcestring 必填
  开放词表来源。不得用作判别条件。
- valueintegerint64 必填
  指标值。绝不跨源相加——DLsite 的一笔销售与 Bangumi 的一次收藏不是同一个单位。
ratingsobject[]
仅当 include=ratings 时出现。没有则为空数组。
- distributionobject[]
  源原生刻度上的投票直方图，升序且稀疏：无票的取值没有桶。仅出现在作品详情面和 works/{id}/ratings，列表面永不携带。各柱不共用一个分母：bangumi、dlsite 和 howlongtobeat 把直方图与聚合一起发布，故其柱之和等于 vote_count；erogamescape 的柱来自独立同步的评论镜像，其和是自己的分母，不必等于 vote_count；vndb 的柱省略私有列表上的票，故其和至多为 vote_count。
- rankintegerint64 必填可空
  来源排名。未记录则为 null。
- scorenumberdouble 必填
  来源原生的聚合分数。
- sourcestring 必填
  开放词表来源。不得用作判别条件。
- statsobject
- vote_countintegerint64 必填
  支撑 score 的票数。
refsobject[]
仅当 include=refs 时出现。没有则为空数组。
- external_idstring 必填
  上游 id 原文。除精确匹配外不得用作判别条件。它是该实体自身粒度上的身份锚，不一定对应可访问页面：credit-name 的 vndb ref 是没有独立页面的 staff-alias id。可浏览 URL 来自 links。
- sourcestring 必填
  开放词表来源。不得用作判别条件。
relationsobject[]
仅当 include=relations 时出现。没有则为空数组。
- phrasestring 必填
  不得用作判别条件。
- relation_typestring 必填
  关联令牌。
- workWork 必填
release_datestringdate 必填可空
日历日期。当 release_status 为 announced、cancelled 或 unknown 时为 null。
release_date_precisionstring 必填可空
release_date 为 null 时为 null。精确到月的日期落在该月 1 日；精确到年的日期落在 1 月 1 日。
枚举daymonthyear
release_statusstring 必填
该 release 的世界状态，有别于我方的认知缺口。
枚举releaseddatedannouncedcancelledunknown
releasesobject[]
仅当 include=releases 时出现。没有则为空数组。
- datestringdate 必填可空
  日历日期。无日期则为 null。
- engineobject
- idstring 必填
  catalog 发行 id。
- langstringbcp47 必填
  BCP-47。未记录则为空。
- objectstring 必填
  类型判别字段。恒为 release。
  枚举release
- platformstring 必填
  不得用作判别条件。
- platformsstring[] 必填
  本发行上的全部平台。空数组，从不为 null。
- refsobject[] 必填
  exact 上游锚。空数组，从不为 null。
- release_kindstring 必填
  发售类别。
  枚举defaultdigitalphysicaltrialpatch
- titlestring 必填可空
  不得用作判别条件。
- work_idstring 必填可空
  父作品 id。在作品子资源上为 null，此时作品由 URL 给出。
screenshotsobject[]
仅当 include=screenshots 时出现。没有则为空数组。
- captionstring 必填
  不得用作判别条件。
- hashstring 必填
  图床内容哈希。
- heightintegerint64 必填可空
  像素高度。未知则为 null。
- sexualstring 必填可空
  性描写。null 表示未评估。
  枚举safesuggestiveexplicit
- sourcestring 必填
  开放词表来源。不得用作判别条件。
- thumbhashstring 必填可空
  Thumbhash。未知则为 null。
- urlstringuri 必填
  图片的绝对 URL。从不为裸 hash。
- violencestring 必填可空
  暴力描写。null 表示未评估。目前恒为 null。
  枚举tameviolentbrutal
- widthintegerint64 必填可空
  像素宽度。未知则为 null。
seriesobject[]
仅当 include=series 时出现。没有则为空数组。
- display_namestring 必填
  不得用作判别条件。
- idstring 必填
  catalog 系列 id。
- member_countintegerint64 必填
  在同一 nsfw 下、不加其他筛选时，GET /v2/catalog/works?series_id={id} 列出的作品数。
- objectstring 必填
  类型判别字段。恒为 series。
  枚举series
- sourcestring 必填
  开放词表来源。不得用作判别条件。
tagsobject[]
仅当 include=tags 时出现。没有则为空数组。
- display_namestring 必填
  不得用作判别条件。
- idstring 必填可空
  规范 tag id。本行未映射时为 null。
- is_sexualboolean 必填
  该 tag 是否属于性相关族。
- sourcestring 必填
  开放词表来源。不得用作判别条件。
- spoilerstring 必填
  本次挂接的剧透等级。
  枚举noneminormajor
- tag_kindstring 必填可空
  标签词表类别。未映射则为 null。
  枚举contentmeta
- tierstring 必填可空
  标签库存档位。未映射则为 null。
  枚举corelongtailhidden
- work_countintegerint64 必填可空
  在同一 nsfw 下、不加其他筛选时，GET /v2/catalog/works?tag_id={id} 列出的作品数，以每小时一次的重算为准。未映射则为 null。
titlesobject[]
仅当 include=titles 时出现。没有则为空数组。
- is_machineboolean 必填
  该标题是否机翻。
- langstringbcp47 必填
  BCP-47 语言标签。
- latinstring 必填可空
  罗马字转写。未记录则为 null。不得用作判别条件。
- titlestring 必填
  不得用作判别条件。
- title_kindstring 必填
  search_hint 为内部取值，永不出现在本类型上。
  枚举officialaliasabbreviation
updated_atstringdate-time 必填
RFC 3339 UTC。
via_companyobject
- display_namestring 必填
  不得用作判别条件。
- idstring 必填
  catalog 公司 id。
- localizedmap<string, object> 必填
  BCP-47 键。没有则为空对象。不得用作判别条件。
- objectstring 必填
  类型判别字段。恒为 company。
  枚举company

请求示例

cURL

curl "https://api.nextmoe.dev/v2/catalog/works/1"