Skip to content

API 总览 ​

公共约定 ​

  • 示例基础地址:https://markify.example.com。
  • JSON 请求使用 Content-Type: application/json。
  • 上传使用 multipart/form-data,字段名为 file。
  • Token 使用大小写敏感的 base64url 字符串,不应记录到公开日志。
  • 除实时流和二进制结果外,错误响应使用 JSON。

公开业务接口 ​

方法路径请求成功响应
POST/v1/resourcemultipart 图片201 资源元数据
DELETE/v1/resource/{resourceToken}路径参数204
POST/v1/source/streamsCreateStreamRequest201 流元数据
GET/v1/source/stream/{streamToken}路径参数200 multipart 流
DELETE/v1/source/streams/{streamToken}路径参数204
POST/v1/source/previewRenderRequest200 发布结果
POST/v1/source/renderRenderRequest200 ZIP
POST/v1/render/image旧 multipart 模型200 图片

健康与观测 ​

方法路径说明
GET/health/liveAPI 进程存活
GET/health/readyAPI 可接收请求
GET/health/dependencies已注册 Worker 状态
GET/logsAPI 持久化日志查询

状态码 ​

状态码含义
200查询、预览或渲染成功
201资源或预览流创建成功
204删除成功,无响应体
400请求模型、字段组合或 JSON 非法
404资源、流或端点不存在
409资源状态冲突或预览被新请求取代
410资源或流已经过期
413上传或输出超过单项限制
422媒体内容不可处理
429Worker 或订阅者并发达到上限
502Worker 返回了无效响应
503Worker/资源服务不可用或流容量耗尽
504下游渲染超时
507tmpfs、资源或预览帧容量耗尽

Worker 可选不等于业务可选

API readiness 不依赖 Worker,但调用图片预览或渲染时必须配置并启动 Image Worker。

Markify 文档与协议随实现同步演进。