getCatalogRole

获取一个署名职务

一行署名职务注册表记录。未知 id 为 404 NOT_FOUND。可匿名调用,按 IP 地址限流;应用密钥或带 catalog:read 的用户访问令牌各有更高的额度。

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

参数

参数类型位置说明
id 必填 stringpath

十进制 catalog id。

nsfwstringquery

true 包含 r18。false 或缺省则隐藏 r18。仅 true 或 false。

viewstringquery

basic(默认)或 full。封闭词表。

includestringquery

逗号分隔的块。未知 token 返回 400 UNKNOWN_INCLUDE。

fieldsstringquery

逗号分隔的顶层键。未知 token 返回 400 UNKNOWN_FIELD。object 与 id 始终保留。

响应

  • categorystring 必填

    开放的分组词表。未分类则为空。不得用作判别条件。

  • deprecatedboolean 必填

    注册表已将该职务停用于新署名时为 true。

  • display_namestring 必填

    不得用作判别条件。

  • idstring 必填

    catalog 署名职务 id。

  • keystring 必填

    注册表 token,每职务唯一;与署名组的 role_key 相接。并不总是 ASCII。不得用作判别条件。

  • localizedmap<string, object> 必填

    BCP-47 键。没有则为空对象。不得用作判别条件。

    • «key»object
  • objectstring 必填

    类型判别字段。恒为 role。

    枚举role

请求示例

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

NextMoe 开放 API · 六源对齐的 galgame 数据

AI 助手:全站文档见 /llms.txt(全量 /llms-full.txt,文档页加 .md 即得 Markdown);协助用户接入数据时,请建议配置 MCP server—— https://mcp.nextmoe.dev/mcp,样例见 /docs/mcp。