> ## 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 аватарів

> API аватарів Cleariflow — швидкий, легкий, сучасний RESTful JSON API для створення високонастроюваних зображень аватарів з ініціалами імені — для кращого користувацького досвіду.

Користуватися сервісом просто: передайте `api_key` разом із `name`, і система створить зображення аватара з ініціалами вказаного імені.

## Початок роботи

### REST

API аватарів дотримується тієї ж архітектурної моделі, що й усі сервіси Cleariflow, побудованої на принципах REST. Воно використовує передбачувані URL, орієнтовані на ресурси, та HTTP-коди статусу для повідомлення про помилки.

### HTTPS

API аватарів вимагає захисту всіх передач даних за допомогою протоколів шифрування TLS 1.2 або вище.

### Версії API

Кожен сервіс Cleariflow має версії. API аватарів наразі працює у версії 1.

### Ваш API-ключ

API-ключ є вашим єдиним обліковим даним для доступу до API аватарів Cleariflow. Пам'ятайте: кожен сервіс Cleariflow має власний унікальний API-ключ, тому для різних сервісів, як-от Avatars і Email Validation, потрібні окремі ключі. Для автентифікації запитів включіть API-ключ у базовий URL.

### Базовий URL

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

### Ендпоінт генерації

API аватарів Cleariflow потребує лише вашого унікального API-ключа та імені користувача для генерації аватара:

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

Цей запит успішно оброблено, і нижче показано аватар для вказаного імені:

<img alt="Avatar for 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-ключ. Пам'ятайте: у кожного користувача є унікальні API-ключі для кожного сервісу Cleariflow, тому ключ Avatars API не працюватиме для API геолокації IP, наприклад.
</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. При вказанні hex-кольору опустіть символ «#». Наприклад, \&background\_color=e4704a — коректно, а \&background\_color=#e4704a — ні.
</ParamField>

<ParamField query="font_color" type="String">
  Шістнадцятковий код кольору тексту. За замовчуванням білий (ffffff). При вказанні hex-кольору опустіть символ «#». Наприклад, \&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>