> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cleariflow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 头像 API

> Cleariflow 头像 API 是一款快速、轻量、现代化的 RESTful JSON API，可根据姓名生成高度可定制的首字母头像图片——提升用户体验。

使用方法非常简单：只需提供您的 `api_key` 和 `name`，系统将生成与所提供姓名首字母对应的头像图片。

## 快速开始

### REST

头像 API 与所有 Cleariflow 服务采用相同的架构模式，基于 REST 原则构建。它采用可预测的资源导向 URL，并使用 HTTP 状态码进行错误通信。

### HTTPS

头像 API 要求所有数据传输使用 TLS 1.2 或更高版本的加密协议进行保护。

### API 版本

每个 Cleariflow 服务均包含版本控制。头像 API 当前运行在第 1 版。

### 您的 API 密钥

API 密钥是您访问 Cleariflow 头像 API 的唯一身份验证凭证。请记住，每个 Cleariflow 服务都有独立的 API 密钥，因此访问头像和邮箱验证等不同服务需要不同的密钥。要验证您的请求，必须在基础 URL 中包含 API 密钥。

### 基础 URL

```
https://avatars.cleariflow.com/v1/
```

### 验证端点

Cleariflow 头像 API 只需您的唯一 API 密钥和用户姓名即可生成头像：

```
https://avatars.cleariflow.com/v1/
? api_key = YOUR_UNIQUE_API_KEY
& name = Alexander Rodriguez
```

此请求已成功处理，指定姓名的头像如下：

<img alt="Alexander Rodriguez 的头像" src="https://mintcdn.com/cleariflow/JFqWO7lxhDZeTQpu/assets/cf_avatar.png?fit=max&auto=format&n=JFqWO7lxhDZeTQpu&q=85&s=45fdc40cc251d6313c13a9c620b320b7" width="64" height="64" data-path="assets/cf_avatar.png" />

### 请求参数

<ParamField query="api_key" type="String" required>
  您的唯一 API 密钥。请记住，每个用户为每个 Cleariflow 服务拥有
  独立的 API 密钥，因此您的头像 API 密钥无法用于 IP 地理定位 API，例如。
</ParamField>

<ParamField query="name" type="String" required>
  您要生成头像的姓名。可输入多个姓名（包括名、中间名和姓），
  服务将自动在头像中显示两个字母。可使用下方的 char\_limit 参数修改字母数量。
</ParamField>

<ParamField query="image_size" type="Integer">
  正方形头像图片的像素尺寸。默认为 64 像素，可用尺寸范围为 6 到 512 像素。
</ParamField>

<ParamField query="image_format" type="String">
  生成图片的首选格式。默认为 "png"，也可选择 "svg"。
</ParamField>

<ParamField query="font_size" type="Float">
  字体大小，以 image\_size 的百分比表示。默认为 0.7，可接受值为 0.1 到 1.0。
</ParamField>

<ParamField query="char_limit" type="Integer">
  头像中显示的最大字符数。默认为 2。实际显示的字符数可能少于此限制，但不会更多。字符选择优先不同单词的首字母，然后是不同单词的第二个字母。
</ParamField>

<ParamField query="background_color" type="String">
  背景的十六进制颜色代码。默认为 #335eea。指定十六进制颜色时，省略 "#" 符号。例如，\&background\_color=e4704a 有效，而 \&background\_color=#e4704a 无效。
</ParamField>

<ParamField query="font_color" type="String">
  文字的十六进制颜色代码。默认为白色 (ffffff)。指定十六进制颜色时，省略 "#" 符号。例如，\&font\_color=e4704a 有效，而 \&font\_color=#e4704a 无效。
</ParamField>

<ParamField query="is_rounded" type="Boolean">
  生成圆形头像图片而非正方形。默认为 false。
</ParamField>

<ParamField query="is_uppercase" type="Boolean">
  将头像中所有首字母转换为大写。默认为 true。
</ParamField>

<ParamField query="is_italic" type="Boolean">
  对头像中所有首字母应用斜体样式。默认为 false。
</ParamField>

<ParamField query="is_bold" type="Boolean">
  对头像中所有首字母应用粗体样式。默认为 false。
</ParamField>