MCS 蓝图站
搜索本地预览

开发者

开放 API

面向第三方工具提供公开蓝图、版本、创作者和社区数据，也可以用个人密钥读取自己的蓝图与收藏。

接口地址 /api/v1

接口规范 JSON 管理 API 密钥

API 密钥与权限

在账户设置按需创建密钥，完整 token 只在创建成功时返回一次。请求使用 Authorization: Bearer mcs_live_…。public:read 读取公开内容，account:read 读取自己的蓝图和收藏。API 密钥仅用于读取，上传、发布、追加版本和资料修改必须在网页会话中完成。密钥应保存在服务端，不要写入网页代码或公开仓库。

限制与网页操作

每个密钥每分钟最多 120 次，匿名读取也有限制；收到 429 后按 Retry-After 等待。上传、发布、追加版本、评论和资料修改只在网页会话中完成，并继续执行同源安全校验。

接口目录

公开数据端点

账户数据

读取当前账户的作品、收藏和开发者密钥相关数据。

2 个端点
GET
/api/v1/account/blueprints读取我的蓝图
需要认证

读取我的蓝图

读取当前账户拥有的蓝图及其审核、版本和互动摘要。

接口标识
listOwnedBlueprints
访问
需要 API 密钥（个人内容读取）
参数
分页游标、页码、filter、关键词、分类、文件格式、gameVersion、排序、每页数量
响应状态
200 · 400 · 401 · 429 · 503
请求参数
cursor分页游标
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
page页码
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：1
filterfilter
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
q关键词
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
category分类
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
format文件格式
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
gameVersiongameVersion
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
sort排序
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
limit每页数量
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：1
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/account/blueprints" \
  --header "Authorization: Bearer $MCS_API_KEY" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
400
请求格式不正确。
401
需要认证。
429
请求过于频繁，请根据 Retry-After 等待。
503
数据库暂时不可用。
GET
/api/v1/account/favourites读取我的收藏
需要认证

读取我的收藏

读取当前账户收藏的公开蓝图摘要。

接口标识
listAccountFavourites
访问
需要 API 密钥（个人内容读取）
参数
分页游标、每页数量
响应状态
200 · 429
请求参数
cursor分页游标
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
limit每页数量
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：0
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/account/favourites" \
  --header "Authorization: Bearer $MCS_API_KEY" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
429
请求过于频繁，请根据 Retry-After 等待。

公开发现

读取公开蓝图、分类和创作者目录。

11 个端点
GET
/api/v1/blueprints读取公开蓝图

读取公开蓝图

按分类、格式、创作者和状态分页读取公开蓝图。

接口标识
listPublicBlueprints
访问
公开读取（可选 公开内容读取）
参数
排序、extra、featured、分类、文件格式、gameVersion、mod、创作者、关键词、分页游标、页码、每页数量
响应状态
200 · 400 · 429 · 503
请求参数
sort排序
查询

latest/oldest 按更新时间降序/升序；popular/least_popular 按热度降序/升序。同值按时间及 ID 排序。featured 保留兼容。

示例：latest
extraextra
查询

额外状态 private,pending,rejected，逗号分隔。登录后默认附加自己的私有与待审核作品；none 仅公开。私有作品仅本人可见，管理员可查看其他人的非私有待审核及未通过作品。

示例：string
featuredfeatured
查询

仅编辑精选，与排序独立

示例：false
category分类
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
format文件格式
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：create
gameVersiongameVersion
查询

源文件游戏版本：java-1.7.10、java-1.12 至 java-1.21、bedrock 或 unknown；不是作品版本号

示例：string
modmod
查询

服务端解析出的模组 namespace

示例：string
creator创作者
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
q关键词
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
cursor分页游标
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
page页码
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：1
limit每页数量
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：1
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/blueprints" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
400
请求格式不正确。
429
请求过于频繁，请根据 Retry-After 等待。
503
数据库暂时不可用。
GET
/api/v1/blueprints/mod-facets接口详情

接口详情

查看请求参数、响应状态、认证要求和可直接运行的请求示例。

接口标识
discovery_mod_facets
访问
公开读取（可选 公开内容读取）
参数
分类、文件格式、gameVersion、关键词、创作者、extra、featured
响应状态
200 · 400 · 429
请求参数
category分类
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
format文件格式
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：create
gameVersiongameVersion
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
q关键词
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
creator创作者
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
extraextra
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
featuredfeatured
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：false
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/blueprints/mod-facets" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
400
请根据状态码和响应体处理。
429
请求过于频繁，请根据 Retry-After 等待。
GET
/api/v1/categories读取蓝图分类

读取蓝图分类

读取当前启用的蓝图分类及封面信息。

接口标识
listBlueprintCategories
访问
公开读取（可选 公开内容读取）
响应状态
200 · 429 · 503
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/categories" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
429
请求过于频繁，请根据 Retry-After 等待。
503
数据库暂时不可用。
GET
/api/v1/categories/{category_id}/cover获取分类封面

获取分类封面

读取分类封面图片。

接口标识
getCategoryCover
访问
公开读取（可选 公开内容读取）
参数
分类标识（必填）
响应状态
200 · 307 · 404 · 429 · 503
请求参数
category_id分类标识
路径
必填

用于定位请求中的具体资源。

示例：00000000-0000-7000-8000-000000000001
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/categories/YOUR_CATEGORY_ID/cover" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
307
请根据状态码和响应体处理。
404
请根据状态码和响应体处理。
429
请求过于频繁，请根据 Retry-After 等待。
503
请根据状态码和响应体处理。
GET
/api/v1/creators读取创作者列表

读取创作者列表

按公开作品和互动数据分页读取创作者列表。

接口标识
listPublicCreators
访问
公开读取（可选 公开内容读取）
参数
分页游标、页码、每页数量
响应状态
200 · 400 · 429 · 503
请求参数
cursor分页游标
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
page页码
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：1
limit每页数量
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：1
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/creators" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
400
请求格式不正确。
429
请求过于频繁，请根据 Retry-After 等待。
503
数据库暂时不可用。
GET
/api/v1/creators/{account_id}/avatar获取创作者头像

获取创作者头像

读取创作者头像图片。

接口标识
getCreatorAvatar
访问
公开读取（可选 公开内容读取）
参数
账户标识（必填）、修订号
响应状态
200 · 304 · 404 · 429 · 503
请求参数
account_id账户标识
路径
必填

用于定位请求中的具体资源。

示例：00000000-0000-7000-8000-000000000001
revision修订号
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：0
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/creators/YOUR_ACCOUNT_ID/avatar" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
304
请根据状态码和响应体处理。
404
请根据状态码和响应体处理。
429
请求过于频繁，请根据 Retry-After 等待。
503
请根据状态码和响应体处理。
GET
/api/v1/creators/{account_id}/background获取创作者背景

获取创作者背景

读取创作者背景图片。

接口标识
getCreatorBackground
访问
公开读取（可选 公开内容读取）
参数
账户标识（必填）、修订号
响应状态
200 · 304 · 404 · 429 · 503
请求参数
account_id账户标识
路径
必填

用于定位请求中的具体资源。

示例：00000000-0000-7000-8000-000000000001
revision修订号
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：0
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/creators/YOUR_ACCOUNT_ID/background" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
304
请根据状态码和响应体处理。
404
请根据状态码和响应体处理。
429
请求过于频繁，请根据 Retry-After 等待。
503
请根据状态码和响应体处理。
GET
/api/v1/creators/{handle}获取创作者资料

获取创作者资料

读取创作者公开资料及代表作品。

接口标识
getPublicCreator
访问
公开读取（可选 公开内容读取）
参数
创作者标识（必填）
响应状态
200 · 404 · 429 · 503
请求参数
handle创作者标识
路径
必填

用于定位请求中的具体资源。

示例：string
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/creators/YOUR_HANDLE" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
404
请根据状态码和响应体处理。
429
请求过于频繁，请根据 Retry-After 等待。
503
数据库暂时不可用。
GET
/api/v1/creators/{handle}/favourites读取创作者收藏

读取创作者收藏

读取创作者公开收藏的蓝图摘要。

接口标识
listPublicCreatorFavourites
访问
公开读取（可选 公开内容读取）
参数
创作者标识（必填）、页码、每页数量
响应状态
200 · 404 · 429 · 503
请求参数
handle创作者标识
路径
必填

用于定位请求中的具体资源。

示例：string
page页码
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：1
limit每页数量
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：1
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/creators/YOUR_HANDLE/favourites" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
404
请根据状态码和响应体处理。
429
请求过于频繁，请根据 Retry-After 等待。
503
数据库暂时不可用。
GET
/api/v1/discovery/home获取首页发现数据

获取首页发现数据

读取首页分类、精选、热门、最新和创作者数据。

接口标识
getHomeDiscovery
访问
公开读取（可选 公开内容读取）
响应状态
200 · 429 · 503
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/discovery/home" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
429
请求过于频繁，请根据 Retry-After 等待。
503
数据库暂时不可用。
GET
/api/v1/discovery/random获取 发现

获取 发现

查看请求参数、响应状态、认证要求和可直接运行的请求示例。

接口标识
getRandomDiscovery
访问
公开读取（可选 公开内容读取）
参数
seed、每页数量
响应状态
200 · 400 · 429 · 503
请求参数
seedseed
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
limit每页数量
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：1
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/discovery/random" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
400
请求格式不正确。
429
请求过于频繁，请根据 Retry-After 等待。
503
数据库暂时不可用。

蓝图与版本

读取蓝图详情、版本历史和预览数据。

7 个端点
GET
/api/v1/blueprints/{blueprint_id}获取蓝图详情

获取蓝图详情

读取蓝图详情、作者、版本和互动统计。

接口标识
getBlueprint
访问
公开读取（可选 公开内容读取）
参数
蓝图标识（必填）
响应状态
200 · 400 · 401 · 404 · 429 · 503
请求参数
blueprint_id蓝图标识
路径
必填

用于定位请求中的具体资源。

示例：00000000-0000-7000-8000-000000000001
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/blueprints/YOUR_BLUEPRINT_ID" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
400
请求格式不正确。
401
提供的认证信息无效。
404
资源不存在或当前不可见。
429
请求过于频繁，请根据 Retry-After 等待。
503
数据库暂时不可用。
GET
/api/v1/blueprints/{blueprint_id}/versions读取蓝图版本

读取蓝图版本

读取蓝图的不可变版本列表。

接口标识
listBlueprintVersions
访问
公开读取（可选 公开内容读取）
参数
蓝图标识（必填）、分页游标、每页数量
响应状态
200 · 400 · 401 · 404 · 429 · 503
请求参数
blueprint_id蓝图标识
路径
必填

用于定位请求中的具体资源。

示例：00000000-0000-7000-8000-000000000001
cursor分页游标
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
limit每页数量
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：1
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/blueprints/YOUR_BLUEPRINT_ID/versions" \
  --header "Accept: application/json"
状态说明
200
返回不可变的版本记录。
400
请求格式不正确。
401
提供的认证信息无效。
404
资源不存在或当前不可见。
429
请求过于频繁，请根据 Retry-After 等待。
503
数据库暂时不可用。
GET
/api/v1/blueprints/{blueprint_id}/versions/{version_number}获取版本详情

获取版本详情

读取指定版本的解析状态和文件信息。

接口标识
getBlueprintVersion
访问
公开读取（可选 公开内容读取）
参数
蓝图标识（必填）、版本号（必填）
响应状态
200 · 400 · 401 · 404 · 429 · 503
请求参数
blueprint_id蓝图标识
路径
必填

用于定位请求中的具体资源。

示例：00000000-0000-7000-8000-000000000001
version_number版本号
路径
必填

用于定位请求中的具体资源。

示例：1
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/blueprints/YOUR_BLUEPRINT_ID/versions/YOUR_VERSION_NUMBER" \
  --header "Accept: application/json"
状态说明
200
返回不可变的版本记录。
400
请求格式不正确。
401
提供的认证信息无效。
404
资源不存在或当前不可见。
429
请求过于频繁，请根据 Retry-After 等待。
503
数据库暂时不可用。
GET
/api/v1/blueprints/{blueprint_id}/versions/{version_number}/download下载蓝图版本

下载蓝图版本

获取指定版本的短时有效下载响应。

接口标识
downloadBlueprintVersion
访问
公开读取（可选 公开内容读取）
参数
蓝图标识（必填）、版本号（必填）
响应状态
307 · 400 · 401 · 404 · 429 · 503
请求参数
blueprint_id蓝图标识
路径
必填

用于定位请求中的具体资源。

示例：00000000-0000-7000-8000-000000000001
version_number版本号
路径
必填

用于定位请求中的具体资源。

示例：1
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/blueprints/YOUR_BLUEPRINT_ID/versions/YOUR_VERSION_NUMBER/download" \
  --header "Accept: application/json"
状态说明
307
返回短时有效的下载地址。
400
请求格式不正确。
401
提供的认证信息无效。
404
资源不存在或当前不可见。
429
请求过于频繁，请根据 Retry-After 等待。
503
请根据状态码和响应体处理。
GET
/api/v1/blueprints/{blueprint_id}/versions/{version_number}/images/{position}获取蓝图预览图

获取蓝图预览图

读取指定版本的一张预览图。

接口标识
previewBlueprintVersionImage
访问
公开读取（可选 公开内容读取）
参数
蓝图标识（必填）、版本号（必填）、预览图位置（必填）
响应状态
200 · 307 · 404 · 429 · 503
请求参数
blueprint_id蓝图标识
路径
必填

用于定位请求中的具体资源。

示例：00000000-0000-7000-8000-000000000001
version_number版本号
路径
必填

用于定位请求中的具体资源。

示例：1
position预览图位置
路径
必填

用于定位请求中的具体资源。

示例：0
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/blueprints/YOUR_BLUEPRINT_ID/versions/YOUR_VERSION_NUMBER/images/YOUR_POSITION" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
307
返回短时有效的下载地址。
404
请根据状态码和响应体处理。
429
请求过于频繁，请根据 Retry-After 等待。
503
请根据状态码和响应体处理。
GET
/api/v1/blueprints/{blueprint_id}/versions/{version_number}/preview获取结构预览

获取结构预览

读取结构预览数据；大体积文件可能标记为不可传输。

接口标识
previewBlueprintVersion
访问
公开读取（可选 公开内容读取）
参数
蓝图标识（必填）、版本号（必填）
响应状态
307 · 400 · 401 · 404 · 429 · 503
请求参数
blueprint_id蓝图标识
路径
必填

用于定位请求中的具体资源。

示例：00000000-0000-7000-8000-000000000001
version_number版本号
路径
必填

用于定位请求中的具体资源。

示例：1
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/blueprints/YOUR_BLUEPRINT_ID/versions/YOUR_VERSION_NUMBER/preview" \
  --header "Accept: application/json"
状态说明
307
返回短时有效的下载地址。
400
请求格式不正确。
401
提供的认证信息无效。
404
请根据状态码和响应体处理。
429
请求过于频繁，请根据 Retry-After 等待。
503
请根据状态码和响应体处理。
GET
/api/v1/blueprints/{blueprint_id}/versions/{version_number}/source读取蓝图源数据

读取蓝图源数据

读取指定版本的源文件响应。

接口标识
readBlueprintVersionSource
访问
公开读取（可选 公开内容读取）
参数
蓝图标识（必填）、版本号（必填）
响应状态
200 · 307 · 400 · 401 · 404 · 429 · 503
请求参数
blueprint_id蓝图标识
路径
必填

用于定位请求中的具体资源。

示例：00000000-0000-7000-8000-000000000001
version_number版本号
路径
必填

用于定位请求中的具体资源。

示例：1
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/blueprints/YOUR_BLUEPRINT_ID/versions/YOUR_VERSION_NUMBER/source" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
307
返回短时有效的下载地址。
400
请求格式不正确。
401
提供的认证信息无效。
404
资源不存在或当前不可见。
429
请求过于频繁，请根据 Retry-After 等待。
503
请根据状态码和响应体处理。

评论互动

读取蓝图评论、回复和互动信息。

2 个端点
GET
/api/v1/blueprints/{blueprint_id}/comments读取蓝图评论

读取蓝图评论

读取蓝图下的顶层评论及其展示状态。

接口标识
listBlueprintCommentRoots
访问
公开读取（可选 公开内容读取）
参数
蓝图标识（必填）、分页游标、每页数量
响应状态
200 · 400 · 404 · 429 · 503
请求参数
blueprint_id蓝图标识
路径
必填

用于定位请求中的具体资源。

示例：00000000-0000-7000-8000-000000000001
cursor分页游标
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
limit每页数量
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：1
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/blueprints/YOUR_BLUEPRINT_ID/comments" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
400
请求格式不正确。
404
请根据状态码和响应体处理。
429
请求过于频繁，请根据 Retry-After 等待。
503
请根据状态码和响应体处理。
GET
/api/v1/blueprints/{blueprint_id}/comments/{root_comment_id}/replies读取评论回复

读取评论回复

读取指定评论下的回复。

接口标识
listBlueprintCommentReplies
访问
公开读取（可选 公开内容读取）
参数
蓝图标识（必填）、主评论标识（必填）、分页游标、每页数量
响应状态
200 · 400 · 404 · 429 · 503
请求参数
blueprint_id蓝图标识
路径
必填

用于定位请求中的具体资源。

示例：00000000-0000-7000-8000-000000000001
root_comment_id主评论标识
路径
必填

用于定位请求中的具体资源。

示例：00000000-0000-7000-8000-000000000001
cursor分页游标
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
limit每页数量
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：1
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/blueprints/YOUR_BLUEPRINT_ID/comments/YOUR_ROOT_COMMENT_ID/replies" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
400
请求格式不正确。
404
请根据状态码和响应体处理。
429
请求过于频繁，请根据 Retry-After 等待。
503
请根据状态码和响应体处理。

社区讨论

读取社区主题和回复内容。

4 个端点
GET
/api/v1/community/discussions读取最近讨论

读取最近讨论

读取公开蓝图最近发生的评论讨论。

接口标识
listRecentCommunityDiscussions
访问
公开读取（可选 公开内容读取）
参数
分页游标、每页数量
响应状态
200 · 400 · 429 · 503
请求参数
cursor分页游标
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
limit每页数量
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：1
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/community/discussions" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
400
请求格式不正确。
429
请求过于频繁，请根据 Retry-After 等待。
503
请根据状态码和响应体处理。
GET
/api/v1/community/posts读取社区帖子

读取社区帖子

分页读取公开的求助和讨论帖子。

接口标识
listCommunityPosts
访问
公开读取（可选 公开内容读取）
参数
分页游标、内容类型、状态、关键词、每页数量
响应状态
200 · 400 · 429 · 503
请求参数
cursor分页游标
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
kind内容类型
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：discussion
status状态
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：open
q关键词
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
limit每页数量
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：1
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/community/posts" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
400
请求格式不正确。
429
请求过于频繁，请根据 Retry-After 等待。
503
请根据状态码和响应体处理。
GET
/api/v1/community/posts/{post_id}获取帖子详情

获取帖子详情

读取一个社区帖子的正文和状态。

接口标识
getCommunityPost
访问
公开读取（可选 公开内容读取）
参数
帖子标识（必填）
响应状态
200 · 400 · 404 · 429 · 503
请求参数
post_id帖子标识
路径
必填

用于定位请求中的具体资源。

示例：00000000-0000-7000-8000-000000000001
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/community/posts/YOUR_POST_ID" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
400
请求格式不正确。
404
请根据状态码和响应体处理。
429
请求过于频繁，请根据 Retry-After 等待。
503
请根据状态码和响应体处理。
GET
/api/v1/community/posts/{post_id}/replies读取帖子回复

读取帖子回复

读取社区帖子的回复列表。

接口标识
listCommunityPostReplies
访问
公开读取（可选 公开内容读取）
参数
帖子标识（必填）、分页游标、每页数量
响应状态
200 · 400 · 404 · 429 · 503
请求参数
post_id帖子标识
路径
必填

用于定位请求中的具体资源。

示例：00000000-0000-7000-8000-000000000001
cursor分页游标
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
limit每页数量
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：1
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/community/posts/YOUR_POST_ID/replies" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
400
请根据状态码和响应体处理。
404
请根据状态码和响应体处理。
429
请求过于频繁，请根据 Retry-After 等待。
503
请根据状态码和响应体处理。

站点信息

读取当前部署的公开能力信息。

1 个端点
GET
/api/v1/openapi.json获取接口规范

获取接口规范

读取当前部署版本的开发者 OpenAPI 规范。

接口标识
getOpenApiDocument
访问
公开读取（可选 公开内容读取）
参数
文档受众
响应状态
200 · 400 · 401 · 403 · 429
请求参数
audience文档受众
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/openapi.json?audience=developer" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
400
请根据状态码和响应体处理。
401
请根据状态码和响应体处理。
403
请根据状态码和响应体处理。
429
请求过于频繁，请根据 Retry-After 等待。

蓝图搜索

按关键词检索公开蓝图。

1 个端点
GET
/api/v1/search搜索蓝图

搜索蓝图

按关键词搜索公开蓝图。

接口标识
searchBlueprints
访问
公开读取（可选 公开内容读取）
参数
关键词（必填）、分类、文件格式、创作者、分页游标、每页数量
响应状态
200 · 404 · 429
请求参数
query关键词
查询
必填

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
category分类
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
format文件格式
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：create
creator创作者
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
cursor分页游标
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：string
limit每页数量
查询

用于筛选、排序或分页；没有标记为必填时可以省略。

示例：0
请求示例替换地址中的占位符，并将密钥放在环境变量中。
curl --request GET \
  --url "/api/v1/search?query=string" \
  --header "Accept: application/json"
状态说明
200
请根据状态码和响应体处理。
404
请根据状态码和响应体处理。
429
请求过于频繁，请根据 Retry-After 等待。