getCatalogWork
获取一部作品
作品详情。spoiler=none|minor|major 是 tags 块的上限，缺省为 none。已合并 ids 返回 404 ENTITY_MERGED，并带 Link rel=canonical。r18 在没有 nsfw=true 时为 404。需要应用密钥。
/v2/catalog/works/{id}catalog:readAuthorization: Bearer nmk_live_…（v2 应用密钥,门户自助铸造,无需申请）参数
| 参数 | 类型 | 位置 | 说明 |
|---|---|---|---|
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必填hashstring必填图床内容哈希。
heightintegerint64 必填 可空像素高度。未知则为 null。
sexualstring必填 可空性描写。null 表示未评估。
枚举safesuggestiveexplicitsourcestring必填开放词表来源。不得用作判别条件。
thumbhashstring必填 可空Thumbhash。未知则为 null。
urlstringuri 必填图片的绝对 URL。从不为裸 hash。
violencestring必填 可空暴力描写。null 表示未评估。目前没有任何 catalog 行经过评估；该值恒为 null。
枚举tameviolentbrutalwidthintegerint64 必填 可空像素宽度。未知则为 null。
charactersobject[]仅当 include=characters 时出现。没有则为空数组。
display_namestring必填不得用作判别条件。
figureobject必填idstring必填catalog 角色 id。
identitystringcatalog.work.roster.suppressed 提案的不透明花名册行 identity；回传即可，切勿重建。仅经配音署名触达该角色时缺席，此时 roster_role 为 unknown、spoiler 为 none。不得用作判别条件。
imageobject必填latinstring必填 可空未记录则为 null。不得用作判别条件。
localizedmap<string, object>必填BCP-47 键。没有则为空对象。不得用作判别条件。
objectstring必填类型判别字段。恒为 character。
枚举characterroster_rolestring必填在该作品上的出场强度。
枚举mainsecondaryappearsunknownspoilerstring必填本次出演的剧透等级。
枚举noneminormajorvoicesobject[]必填该出场上的配音署名。空数组，从不为 null。
claimobject必填content_limitstring必填本认领的编辑展示轴。
枚举sfwnsfwsitestring必填认领站点 key。
site_work_idstring必填站点自己的作品 id，不是 catalog id。
statestring必填认领生命周期状态。
枚举livedraftpendingdeclinedhidden
companiesobject[]仅当 include=companies 时出现。没有则为空数组。
attribution_rolestring必填在本作品上的主要身份。
枚举circlepublisherdeveloperbrandcompany_kindstring必填公司注册表类别。
枚举game_brandbunkopublisheranime_studiodoujin_circlegroupdisplay_namestring必填不得用作判别条件。
idstring必填catalog 公司 id。
localizedmap<string, object>必填BCP-47 键。没有则为空对象。不得用作判别条件。
logoobjectobjectstring必填类型判别字段。恒为 company。
枚举companywork_countintegerint64 必填同一 NSFW 闸下可见的作品。
content_ratingstring必填作品的年龄轴。
枚举all_agessensitiver18coverobject必填hashstring必填图床内容哈希。
heightintegerint64 必填 可空像素高度。未知则为 null。
sexualstring必填 可空性描写。null 表示未评估。
枚举safesuggestiveexplicitsourcestring必填开放词表来源。不得用作判别条件。
thumbhashstring必填 可空Thumbhash。未知则为 null。
urlstringuri 必填图片的绝对 URL。从不为裸 hash。
violencestring必填 可空暴力描写。null 表示未评估。目前没有任何 catalog 行经过评估；该值恒为 null。
枚举tameviolentbrutalwidthintegerint64 必填 可空像素宽度。未知则为 null。
coversobject[]仅当 include=covers 时出现。没有则为空数组。
cover_kindstring必填来自置顶阶梯的上游封面类别：main、dig、pkgfront、pkgback 及其同类。开放词表。未记录则为空。不得用作判别条件。
hashstring必填图床内容哈希。
heightintegerint64 必填 可空像素高度。未知则为 null。
idstring必填catalog_work_cover 行 id，而非图片 hash。
portrait_pinnedboolean必填该行是否钉为竖版封面。
sexualstring必填 可空性描写。null 表示未评估。
枚举safesuggestiveexplicitsourcestring必填开放词表来源。不得用作判别条件。
thumbhashstring必填 可空Thumbhash。未知则为 null。
urlstringuri 必填图片的绝对 URL。从不为裸 hash。
violencestring必填 可空暴力描写。null 表示未评估。目前恒为 null。
枚举tameviolentbrutalvote_countintegerint64 必填此封面行的净票数。
widthintegerint64 必填 可空像素宽度。未知则为 null。
created_atstringdate-time 必填RFC 3339 UTC。
creditsobject[]仅当 include=credits 时出现。没有则为空数组。
creditsobject[]必填记在此 role 下的署名。空数组，从不为 null。
role_keystring必填署名职务 token。
role_namestring必填不得用作判别条件。
display_namestring必填主显示名。永不为空。不得用作判别条件。
enginesobject[]仅当 include=engines 时出现。没有则为空数组。
display_namestring必填不得用作判别条件。
idstring必填catalog 引擎 id。
objectstring必填类型判别字段。恒为 engine。
枚举enginework_countintegerint64 必填同一 NSFW 闸下可见的作品。
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_gamemusicobjectstring必填类型判别字段。恒为 work。
枚举workolangstringbcp47 必填原语言，BCP-47。开放词表语言。
platformsobject[]仅当 include=platforms 时出现。没有则为空数组。
platformstring必填不得用作判别条件。
sourcestring必填开放词表来源。不得用作判别条件。
playtimesobject[]仅当 include=playtimes 时出现。没有则为空数组。
minutesintegerint64 必填估计分钟数。
sourcestring必填开放词表来源。不得用作判别条件。
vote_countintegerint64 必填支撑该估计的票数。
popularityobject[]仅当 include=popularity 时出现。没有则为空数组。
metricstring必填来源原生的指标令牌。
sourcestring必填开放词表来源。不得用作判别条件。
valueintegerint64 必填指标值。
ratingsobject[]仅当 include=ratings 时出现。没有则为空数组。
distributionobject[]源原生刻度上的投票直方图，升序且稀疏：无票的取值没有桶。仅出现在作品详情面和 works/{id}/ratings，列表面永不携带。各柱不共用一个分母：bangumi、dlsite 和 howlongtobeat 把直方图与聚合一起发布，故其柱之和等于 vote_count；erogamescape 的柱来自独立同步的评论镜像，其和是自己的分母，不必等于 vote_count；vndb 的柱省略私有列表上的票，故其和至多为 vote_count。
rankintegerint64 必填 可空来源排名。未记录则为 null。
scorenumberdouble 必填来源原生的聚合分数。
sourcestring必填开放词表来源。不得用作判别条件。
statsobjectvote_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 日。
枚举daymonthyearrelease_statusstring必填该 release 的世界状态，有别于我方的认知缺口。
枚举releaseddatedannouncedcancelledunknownreleasesobject[]仅当 include=releases 时出现。没有则为空数组。
datestringdate 必填 可空日历日期。无日期则为 null。
idstring必填catalog 发行 id。
langstringbcp47 必填BCP-47。未记录则为空。
objectstring必填类型判别字段。恒为 release。
枚举releaseplatformstring必填不得用作判别条件。
platformsstring[]必填本发行上的全部平台。空数组，从不为 null。
refsobject[]必填exact 上游锚。空数组，从不为 null。
release_kindstring必填发售类别。
枚举defaultdigitalphysicaltrialpatchtitlestring必填 可空不得用作判别条件。
work_idstring必填 可空父作品 id。在作品子资源上为 null，此时作品由 URL 给出。
screenshotsobject[]仅当 include=screenshots 时出现。没有则为空数组。
captionstring必填不得用作判别条件。
hashstring必填图床内容哈希。
heightintegerint64 必填 可空像素高度。未知则为 null。
sexualstring必填 可空性描写。null 表示未评估。
枚举safesuggestiveexplicitsourcestring必填开放词表来源。不得用作判别条件。
thumbhashstring必填 可空Thumbhash。未知则为 null。
urlstringuri 必填图片的绝对 URL。从不为裸 hash。
violencestring必填 可空暴力描写。null 表示未评估。目前恒为 null。
枚举tameviolentbrutalwidthintegerint64 必填 可空像素宽度。未知则为 null。
seriesobject[]仅当 include=series 时出现。没有则为空数组。
display_namestring必填不得用作判别条件。
idstring必填catalog 系列 id。
member_countintegerint64 必填同一 NSFW 门下可见的成员。
objectstring必填类型判别字段。恒为 series。
枚举seriessourcestring必填开放词表来源。不得用作判别条件。
tagsobject[]仅当 include=tags 时出现。没有则为空数组。
display_namestring必填不得用作判别条件。
idstring必填 可空规范 tag id。本行未映射时为 null。
is_sexualboolean必填该 tag 是否属于性相关族。
sourcestring必填开放词表来源。不得用作判别条件。
spoilerstring必填本次挂接的剧透等级。
枚举noneminormajortag_kindstring必填 可空标签词表类别。未映射则为 null。
枚举contentmetatierstring必填 可空标签库存档位。未映射则为 null。
枚举corelongtailhiddenwork_countintegerint64 必填 可空同一 NSFW 闸下可见的作品。未映射则为 null。
titlesobject[]仅当 include=titles 时出现。没有则为空数组。
is_machineboolean必填该标题是否机翻。
langstringbcp47 必填BCP-47 语言标签。
latinstring必填 可空罗马字转写。未记录则为 null。不得用作判别条件。
titlestring必填不得用作判别条件。
title_kindstring必填search_hint 为内部取值，永不出现在本类型上。
枚举officialaliasabbreviation
updated_atstringdate-time 必填RFC 3339 UTC。
via_companyobjectdisplay_namestring必填不得用作判别条件。
idstring必填catalog 公司 id。
localizedmap<string, object>必填BCP-47 键。没有则为空对象。不得用作判别条件。
objectstring必填类型判别字段。恒为 company。
枚举company
请求示例
curl "https://api.nextmoe.dev/v2/catalog/works/value" \
-H "Authorization: Bearer nmk_live_<YOUR_KEY>"