> For the complete documentation index, see [llms.txt](https://enoch-app.gitbook.io/enoch/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://enoch-app.gitbook.io/enoch/api-references/enoch-rest-apis/get-metadata.md).

# GET - Metadata

Get a 2D render of an avatar for stickers or profile pictures.

## Get avatar 2D render by id.

<mark style="color:blue;">`GET`</mark> `https://models.enochavatar.me`

Get an avatar 2D image with desired settings.&#x20;

#### Path Parameters

| Name                                           | Type   | Description      |
| ---------------------------------------------- | ------ | ---------------- |
| avatarId.png<mark style="color:red;">\*</mark> | String | ID of an avatar. |

#### Query Parameters

| Name        | Type   | Description                             |
| ----------- | ------ | --------------------------------------- |
| scene       | String | Name of portrait type to render.        |
| blendShapes | String | Map of 3D meshes to their blend shapes. |

{% tabs %}
{% tab title="200: OK 2D Render of the avatar." %}

{% endtab %}

{% tab title="404: Not Found The requested avatar is not available." %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}

### Parameters, expected values, and examples

{% tabs %}
{% tab title="/avatarId.png" %}
ID of an avatar with .png file extension.

**Expected values (String)**

* `6185a4acfb622cf1cdc49348.png`

{% hint style="info" %}
It may take some time to render the image in the backend for the initial request. For subsequent requests, the images will be fetched from cache and delivered much faster.
{% endhint %}
{% endtab %}

{% tab title="Example" %}
**Request avatar render by ID.**

```
https://models.enochavatar.me/6185a4acfb622cf1cdc49348.png
```

**Returned value**

You will receive a .png image[.](https://docs.fileformat.com/3d/glb/)&#x20;

![](/files/eHPFhdwIkMFll5hdVNFj)
{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="?scene" %}
Name of the portrait type to render.

**Expected values (String)**

* `fullbody-portrait-v1` - Creates a portrait from a full-body avatar...
* `fullbody-portrait-v1-transparent`  - ... with transparent background (default).
* `halfbody-portrait-v1` - Creates a portrait from a half-body avatar...
* `halfbody-portrait-v1-transparent`  - ... with transparent background (default).
* `fullbody-posture-v1-transparent`  - Creates a portrait with a pose from a full-body avatar.
  {% endtab %}

{% tab title="Example" %}
**Request avatar render with transparent fullbody posture**

```
https://models.enochavatar.me/6185a4acfb622cf1cdc49348.png?scene=fullbody-posture-v1-transparent
```

![](/files/TtxCaimfk2PJulg06toA)

**Request avatar render for full body portrait on dark background**

```
https://models.enochavatar.me/6185a4acfb622cf1cdc49348.png?scene=fullbody-portrait-v1
```

![](/files/9W0wJJ76zi6ESOjvvQpW)
{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="?blendShapes" %}
Map of 3D meshes to their blend shapes.

**Expected values (String)**\
`blendShapes[Wolf3D_Head][mouthSmile]=0.2 }`&#x20;

* &#x20;`Wolf3D_Head` is the affected node in the avatar.&#x20;
* `mouthSmile` is an example of a blend shape included in the avatar.

You can find all available blend shapes in Full-body Avatars.

{% hint style="info" %}
You can combine multiple blend shapes by concatenating them with '&' as shown in the following example:

`?blendShapes[Wolf3D_Head][mouthSmile]=0.2`**`&`**`blendShapes[Wolf3D_Head][browInnerUp]=0.2`
{% endhint %}
{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://enoch-app.gitbook.io/enoch/api-references/enoch-rest-apis/get-metadata.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.