getCatalogSchema

某族的可编辑字段 schema

无需认证的元数据:include token、FULL_SET 以及编辑引擎字段。include/full_set 描述该族的详情面,list_include/list_full_set 描述其集合面,work 的集合面更窄。不评估调用方能力。未知 object 为 404 NOT_FOUND。schemas/release 会设置 creation_disabled。

get/v2/catalog/schemas/{object}
无需凭据(匿名可调 —— 不需要 API 密钥)

参数

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

本 schema 描述的族。未知族为 404 NOT_FOUND。

workcompanycharacterreleasetagengineseries

响应

  • creation_disabledboolean 必填

    该族不能再新建行时为 true。在 release 上恒为 true。

  • entity_typestring 必填

    本族写入时使用的编辑引擎类型。

    枚举catalog.workcatalog.labelcatalog.charactercatalog.releasecatalog.tagcatalog.enginecatalog.series
  • fieldsobject[] 必填

    可编辑字段。空数组,从不为 null。不评估操作者能力。

    • baseintegerint64 必填

      整数编码字段上词表首个 token 的线上码。除非模型将 0 保留给 null,否则为 0。

    • deprecatedboolean 必填

      写入该键会被拒绝时为 true。

    • diff_hintstring 必填

      该字段的 diff 应如何渲染。

      枚举inlinelinesitemsimage
    • elementobject
    • encodingstring

      写入该字段时线上如何携带词表取值。当且仅当 vocabulary 非空时出现,否则缺席。int 表示线上值为 base 加 token 在词表发布顺序中的下标;token 表示线上值就是 token 字符串本身。词表的发布顺序只在按 int 读取处构成契约——token 编码下该顺序只是展示顺序。

      枚举tokenint
    • field_typestring 必填

      控件类型。不是领域词表。

      枚举texti18nmapenumintdatelistrefimagehash
    • keystring 必填

      编辑引擎字段键。不得用作判别条件。

    • max_elementsintegerint64 必填

      列表字段元素数量上限。标量字段为 0。

    • max_suppressedintegerint64 必填

      该字段抑制集合的上限。无抑制时为 0。

    • nullableboolean 必填

      接受 null 且 null 会清空存储值时为 true。

    • vocabularystring 必填

      指明该字段接受哪个 /v2/vocabularies 词表的 token。字段没有词表时为空。整数编码字段上 token 只是标签,线上值为 base 加 token 在词表发布顺序中的下标。

  • full_setstring[] 必填

    详情面上 view=full 会展开的 token。include 的子集。空数组,从不为 null。

  • includestring[] 必填

    该家族 DETAIL 面接受的 include= 令牌。空数组,从不为 null。full_set 是其子集。

  • list_full_setstring[] 必填

    集合面上 view=full 会展开的 token。list_include 的子集。空数组,从不为 null。

  • list_includestring[] 必填

    该族 COLLECTION 面接受的 include= token,不一定与详情面词表相同:列表按批量水合,因此只有逐条记录形状的块留在详情面与子资源上。空数组,从不为 null。

  • objectstring 必填

    类型判别字段。恒为 object_schema。

    枚举object_schema
  • target_objectstring 必填

    本 schema 描述的族。

    枚举workcompanycharacterreleasetagengineseries

请求示例

cURL
curl "https://api.nextmoe.dev/v2/catalog/schemas/work"

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

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