通过 URL 生成 SVG 头像的 HTTP API
我们的 HTTP API 是将 DiceBear 作为个人资料图片 API 或头像占位图 API 的最简单方式 — 无需身份验证。
用法
使用以下地址,并将 <styleName> 替换为你喜欢的头像样式(camelCase)。支持所有官方 头像样式。
https://api.dicebear.com/10.x/<styleName>/svg一些示例
INFO
我们提供了来自不同艺术家的大量头像样式。这些头像样式采用不同的许可协议,且由艺术家自行选择。为了便于快速了解,我们为你整理了一个许可概览。
选项
所有 核心选项——例如 seed、 flip、rotate、scale、borderRadius、backgroundColor 等——都可作为查询参数使用。 各个样式特有的选项会列在对应的头像样式页面上。例如:
TIP
如果你想传递更多选项,可以像平常使用查询字符串那样,用 & 将它们连接起来。
WARNING
idRandomization、fontFamily、fontWeight 和 title 这些选项不受我们的公共 HTTP API 支持。你可以通过自行托管实例来启用它们。
数组选项
数组值之间用逗号分隔。例如,如果你希望在种子之外向 PRNG 提供多种发型,URL 可能会像这样。请注意,头像样式提供的选项各不相同。在这个示例中,我们使用 像素艺术 头像样式。
枚举选项
枚举值以字符串形式传递。例如,flip 选项接受 none、horizontal、vertical 或 both:
文件格式
SVG推荐
推荐。可无限缩放,无尺寸限制,更高的速率限制。
PNG
最大 256 × 256 px。较低的速率限制。
JPG
最大 256 × 256 px。较低的速率限制。
WebP
最大 256 × 256 px。较低的速率限制。
AVIF
最大 256 × 256 px。较低的速率限制。
JSON
以 JSON 形式返回头像元数据 — 不输出图像。
PNG、JPG、WebP 和 AVIF 使用 Noto Sans 字体,并且目前 支持以下子集:cyrillic、cyrillic-ext、devanagari、 greek、greek-ext、japanese、korean、latin、latin-ext、 simplified-chinese、thai 和 vietnamese。
版本控制
你可以在 URL 中设置版本。只需将前面示例中的 10.x 替换为你想要的版本即可。
| 版本 | 状态 | 生命周期结束 |
|---|---|---|
10.x | 活跃 | — |
9.x | 活跃 | — |
8.x | 已弃用 | 2028 年 4 月 30 日 |
7.x | 已弃用 | 2028 年 4 月 30 日 |
6.x | 已弃用 | 2028 年 4 月 30 日 |
5.x | 已弃用 | 2028 年 4 月 30 日 |
WARNING
5.x–8.x 版本将在 2028 年 4 月 30 日到达生命周期终点。届时,这些版本的 HTTP API 将关闭并不再可用。请升级到最新版本。详情请参阅 公告。
INFO
你可以自行托管 API,以在生命周期结束后继续使用已停止维护的版本。
自托管头像 API
需要私有或商业部署?你可以自行托管头像 API,以完全控制可用性、速率限制和数据隐私。
合理使用与速率限制
我们的 API 可免费用于非商业用途,但请负责任地使用。我们保留封禁滥用用户的权利。
目前我们将每秒请求数限制为 SVG 50 次,以及 PNG、JPG、WebP 和 AVIF 10 次。超过限制会返回 HTTP 429 Too Many Requests。我们保留随时更改这些限制而不另行通知的权利。
如需商业用途或更高限制,请搭建你自己的实例。 我们很乐意回答问题——欢迎在 GitHub 上发起 讨论。
变更与可用性
请注意,我们保留随时更新 API 的权利。虽然我们会尽最大努力保持向后兼容,但无法保证一定如此。即使我们会尽量始终返回相同的头像,设计,尤其是源代码也可能发生变化。此外,我们也无法保证 API 始终可用。如果你需要持续稳定地访问该 API,我们建议你搭建自己的实例。