> ## 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.

# Avatars-API

> Die Cleariflow Avatars-API ist eine schnelle, leichtgewichtige und moderne RESTful JSON-API zur Erstellung hochgradig anpassbarer Avatar-Bilder mit Initialen aus einem Namen — für ein besseres Nutzererlebnis.

Die Nutzung ist unkompliziert: Übergeben Sie Ihren `api_key` zusammen mit einem `name`, und das System erstellt ein Avatar-Bild mit den Initialen des angegebenen Namens.

## Erste Schritte

### REST

Die Avatars-API folgt dem gleichen Architekturmuster wie alle Cleariflow-Dienste und ist um REST-Prinzipien herum aufgebaut. Sie verwendet vorhersehbare, ressourcenorientierte URLs und HTTP-Statuscodes zur Fehlerkommunikation.

### HTTPS

Die Avatars-API erfordert, dass alle Datenübertragungen mit TLS 1.2 oder höher verschlüsselt werden.

### API-Versionen

Jeder Cleariflow-Dienst ist versioniert. Die Avatars-API befindet sich derzeit in Version 1.

### Ihr API-Schlüssel

Ihr API-Schlüssel ist Ihre ausschließliche Authentifizierungsberechtigung für den Zugriff auf die Cleariflow Avatars-API. Beachten Sie, dass jeder Cleariflow-Dienst einen eigenen API-Schlüssel hat — Sie benötigen also separate Schlüssel für Avatars und E-Mail-Validierung. Zur Authentifizierung Ihrer Anfragen fügen Sie Ihren API-Schlüssel in die Basis-URL ein.

### Basis-URL

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

### Validierungs-Endpunkt

Die Cleariflow Avatars-API benötigt nur Ihren eindeutigen API-Schlüssel und den Namen des Nutzers zur Avatar-Erstellung:

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

Diese Anfrage wurde erfolgreich verarbeitet — das resultierende Avatar für den angegebenen Namen erscheint unten:

<img alt="Avatar für 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" />

### Anfrageparameter

<ParamField query="api_key" type="String" required>
  Ihr eindeutiger API-Schlüssel. Beachten Sie, dass jeder Nutzer für jeden Cleariflow-Dienst eigene API-Schlüssel hat — Ihr Avatars-API-Schlüssel funktioniert z. B. nicht für die IP-Geolokalisierungs-API.
</ParamField>

<ParamField query="name" type="String" required>
  Der Name, für den ein Avatar erstellt werden soll. Sie können mehrere Namen eingeben (Vor-, Mittel- und Nachname) — der Dienst zeigt automatisch zwei Buchstaben im Avatar. Die Anzahl der Buchstaben lässt sich mit dem Parameter `char_limit` unten anpassen.
</ParamField>

<ParamField query="image_size" type="Integer">
  Die Abmessungen des quadratischen Avatar-Bildes in Pixeln. Standardmäßig 64 Pixel; verfügbare Größen von 6 bis 512 Pixeln.
</ParamField>

<ParamField query="image_format" type="String">
  Das gewünschte Format des generierten Bildes. Standardmäßig „png"; alternativ „svg".
</ParamField>

<ParamField query="font_size" type="Float">
  Die Schriftgröße als Prozentsatz von `image_size`. Standardmäßig 0,7; zulässige Werte zwischen 0,1 und 1,0.
</ParamField>

<ParamField query="char_limit" type="Integer">
  Die maximale Anzahl anzuzeigender Zeichen im Avatar. Standardmäßig 2. Die tatsächlich angezeigte Anzahl kann geringer, aber nie größer sein. Die Zeichenauswahl priorisiert unterschiedliche Wörter, dann den zweiten Buchstaben unterschiedlicher Wörter.
</ParamField>

<ParamField query="background_color" type="String">
  Der hexadezimale Farbcode für den Hintergrund. Standardmäßig #335eea. Bei Angabe einer Hex-Farbe das „#"-Symbol weglassen. Beispiel: `&background_color=e4704a` ist gültig, `&background_color=#e4704a` ist ungültig.
</ParamField>

<ParamField query="font_color" type="String">
  Der hexadezimale Farbcode für den Text. Standardmäßig weiß (ffffff). Bei Angabe einer Hex-Farbe das „#"-Symbol weglassen. Beispiel: `&font_color=e4704a` ist gültig, `&font_color=#e4704a` ist ungültig.
</ParamField>

<ParamField query="is_rounded" type="Boolean">
  Erzeugt ein kreisförmiges statt quadratisches Avatar-Bild. Standardmäßig `false`.
</ParamField>

<ParamField query="is_uppercase" type="Boolean">
  Wandelt alle Initialen im Avatar in Großbuchstaben um. Standardmäßig `true`.
</ParamField>

<ParamField query="is_italic" type="Boolean">
  Wendet Kursivschrift auf alle Initialen im Avatar an. Standardmäßig `false`.
</ParamField>

<ParamField query="is_bold" type="Boolean">
  Wendet Fettschrift auf alle Initialen im Avatar an. Standardmäßig `false`.
</ParamField>