开发者 API

HILIA API 为自动化流程提供隐形水印功能，例如为发布流程中的每张图像添加标记，或扫描传入图像以寻找你的水印。该 API 为付费服务，其密钥与网页工具分开管理。

身份认证

在 hilia.tyo.com.au/keys 创建和管理 API 密钥（需要登录）。每个请求都必须通过以下任一方式发送密钥：

Authorization: Bearer <your-api-key>

或：

X-Api-Key: <your-api-key>

API 密钥可以设置月度配额；密钥页面以 calls used / quota 显示使用量。已撤销或未知的密钥会收到 401；超出配额的密钥会收到 429。

端点

所有端点均使用 POST 方法，位于 https://hilia.tyo.com.au/api/v1/ 下，并接受 multipart/form-data。

端点	用途	字段
`/api/v1/wm/embed`	嵌入文本 ID	`image`、`key`、`text`（≤32 字节）、`strength`（可选）
`/api/v1/wm/extract`	恢复文本 ID	`image`、`key`
`/api/v1/wm/detect`	检查水印并返回置信度	`image`、`key`

这里的 key 字段是你的水印密钥，也就是用于保护水印的秘密；它不同于认证 API 请求所用的 API 密钥。

示例

curl -X POST https://hilia.tyo.com.au/api/v1/wm/embed \
  -H "Authorization: Bearer $HILIA_API_KEY" \
  -F "[email protected]" \
  -F "key=$WATERMARK_KEY" \
  -F "text=order-8841" \
  -o product-shot-marked.jpg

之后，可以确认某张图像是否带有你的水印：

curl -X POST https://hilia.tyo.com.au/api/v1/wm/detect \
  -H "Authorization: Bearer $HILIA_API_KEY" \
  -F "[email protected]" \
  -F "key=$WATERMARK_KEY"

响应

Embed 返回添加水印后的图像字节，内容类型与输入图像相同。
Extract 和 Detect 返回 JSON：前者返回嵌入的文本，后者返回是否存在水印及其置信度分数。
错误：401 表示密钥无效；429 表示超出配额；输入错误（格式不受支持、上传文件过大等）会收到服务返回的 4xx。

Tip

各项操作的含义，包括强度、存活能力以及 Embed 与 Detect 的区别，都与网页工具相同。请参阅隐形水印。