NextMoe 开发者平台

文档 API v2getCatalogWorkCharacters

getCatalogWorkCharacters

列出一部作品的角色

花名册角色。与 include=characters 同一批条目。需要应用密钥。

get/v2/catalog/works/{id}/characters

scope catalog:readAuthorization: Bearer nmk_live_…（v2 应用密钥,门户自助铸造,无需申请）

参数

参数	类型	位置	说明
`id` 必填	`string`	`path`	十进制 catalog 作品 id。
`nsfw`	`string`	`query`	true 包含 r18。false 或缺省则隐藏 r18。仅 true 或 false。
`cursor`	`string`	`query`	来自先前 next_cursor 的不透明 keyset cursor。必须以 cur_ 开头。
`limit`	`string`	`query`	页大小 1-100，缺省 20。

响应

facetsmap<string, object[]>
具名 facet 桶。仅在请求 facets= 时出现。
- «key»object[] 可空
itemsobject[] 必填
本页成员。空数组，从不为 null。
- display_namestring 必填
  不得用作判别条件。
- figureobject 必填
- idstring 必填
  catalog 角色 id。
- identitystring
  catalog.work.roster.suppressed 提案的不透明花名册行 identity；回传即可，切勿重建。仅经配音署名触达该角色时缺席，此时 roster_role 为 unknown、spoiler 为 none。不得用作判别条件。
- imageobject 必填
- latinstring 必填可空
  未记录则为 null。不得用作判别条件。
- localizedmap<string, object> 必填
  BCP-47 键。没有则为空对象。不得用作判别条件。
- objectstring 必填
  类型判别字段。恒为 character。
  枚举character
- roster_rolestring 必填
  在该作品上的出场强度。
  枚举mainsecondaryappearsunknown
- spoilerstring 必填
  本次出演的剧透等级。
  枚举noneminormajor
- voicesobject[] 必填
  该出场上的配音署名。空数组，从不为 null。
missingstring[]
已请求但不可见的 ids。仅出现在 ids=/refs= 批量车道。
next_cursorstring
不透明 keyset cursor。末页省略。
objectstring 必填
类型判别字段。恒为 list。
枚举list
totalintegerint64
仅当 include_total=true 时出现。与 items 同一可见性闸。

请求示例

cURL

curl "https://api.nextmoe.dev/v2/catalog/works/value/characters" \
  -H "Authorization: Bearer nmk_live_<YOUR_KEY>"