> For the complete documentation index, see [llms.txt](https://zaralx.gitbook.io/assets/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://zaralx.gitbook.io/assets/zaralx-assets-1.md).

# zaralX Assets

## GET /

> Get API information and version details

```json
{"openapi":"3.0.3","info":{"title":"zaralX Assets","version":"1.1.0"},"servers":[{"url":"https://assets.zaralx.ru/api"}],"paths":{"/":{"get":{"description":"Get API information and version details","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Project information message"},"sources":{"type":"object","properties":{"vanilla":{"type":"object","properties":{"version":{"type":"string","description":"Minecraft vanilla version"}}}}}}}}}}}}}}}
```

## GET /swagger

> Get OpenAPI/Swagger specification for the API

```json
{"openapi":"3.0.3","info":{"title":"zaralX Assets","version":"1.1.0"},"servers":[{"url":"https://assets.zaralx.ru/api"}],"paths":{"/swagger":{"get":{"description":"Get OpenAPI/Swagger specification for the API","responses":{"200":{"description":"OpenAPI 3.0 specification document","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"description":"OpenAPI 3.0 specification document"}}}}}}}}}
```

## GET /v1/minecraft/vanilla/item/categories

> Get all categories with items

```json
{"openapi":"3.0.3","info":{"title":"zaralX Assets","version":"1.1.0"},"servers":[{"url":"https://assets.zaralx.ru/api"}],"paths":{"/v1/minecraft/vanilla/item/categories":{"get":{"description":"Get all categories with items","responses":{"200":{"description":"Categories data object","content":{"application/json":{"schema":{"type":"object","description":"Categories data object","required":["tools_and_utilities","building_blocks","food_and_drinks","natural_blocks","op_blocks","functional_blocks","spawn_eggs","redstone_blocks","colored_blocks","ingredients","combat"],"properties":{"tools_and_utilities":{"type":"array","items":{"type":"string"},"uniqueItems":true},"building_blocks":{"type":"array","items":{"type":"string"},"uniqueItems":true},"food_and_drinks":{"type":"array","items":{"type":"string"},"uniqueItems":true},"natural_blocks":{"type":"array","items":{"type":"string"},"uniqueItems":true},"op_blocks":{"type":"array","items":{"type":"string"},"uniqueItems":true},"functional_blocks":{"type":"array","items":{"type":"string"},"uniqueItems":true},"spawn_eggs":{"type":"array","items":{"type":"string"},"uniqueItems":true},"redstone_blocks":{"type":"array","items":{"type":"string"},"uniqueItems":true},"colored_blocks":{"type":"array","items":{"type":"string"},"uniqueItems":true},"ingredients":{"type":"array","items":{"type":"string"},"uniqueItems":true},"combat":{"type":"array","items":{"type":"string"},"uniqueItems":true}},"additionalProperties":false}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","description":"Internal server error","properties":{"error":{"type":"string"},"message":{"type":"string"}}}}}},"503":{"description":"Service unavailable - categories not initialized","content":{"application/json":{"schema":{"type":"object","description":"Service unavailable - categories not initialized","properties":{"error":{"type":"string"},"message":{"type":"string"}}}}}}}}}}}
```

## GET /v1/minecraft/vanilla/item/{item}/icon

>

```json
{"openapi":"3.0.3","info":{"title":"zaralX Assets","version":"1.1.0"},"servers":[{"url":"https://assets.zaralx.ru/api"}],"paths":{"/v1/minecraft/vanilla/item/{item}/icon":{"get":{"parameters":[{"schema":{"type":"string"},"in":"path","name":"item","required":true,"description":"The item identifier"}],"responses":{"200":{"description":"![Example](https://assets.zaralx.ru/api/v1/minecraft/vanilla/item/diamond_block/icon)","content":{"image/webp":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Item not found","content":{"application/json":{"schema":{"description":"Item not found","type":"object"}}}}}}}}}
```

## GET /v1/minecraft/vanilla/item/{item}/lang/{lang}/name

> Get the localized name of an item in a specific language

```json
{"openapi":"3.0.3","info":{"title":"zaralX Assets","version":"1.1.0"},"servers":[{"url":"https://assets.zaralx.ru/api"}],"paths":{"/v1/minecraft/vanilla/item/{item}/lang/{lang}/name":{"get":{"description":"Get the localized name of an item in a specific language","parameters":[{"schema":{"type":"string"},"in":"path","name":"item","required":true,"description":"The item identifier"},{"schema":{"type":"string"},"in":"path","name":"lang","required":true,"description":"The language code"}],"responses":{"200":{"description":"The localized item name","content":{"application/json":{"schema":{"type":"string","description":"The localized item name"}}}},"400":{"description":"Bad request - unknown language or item not found","content":{"application/json":{"schema":{"type":"object","description":"Bad request - unknown language or item not found","properties":{"message":{"type":"string"},"lang_keys":{"type":"array","items":{"type":"string"},"description":"Available language keys (only present when language is unknown)"}}}}}}}}}}}
```

## GET /v1/minecraft/vanilla/lang/{id}

> Get language data by language identifier

```json
{"openapi":"3.0.3","info":{"title":"zaralX Assets","version":"1.1.0"},"servers":[{"url":"https://assets.zaralx.ru/api"}],"paths":{"/v1/minecraft/vanilla/lang/{id}":{"get":{"description":"Get language data by language identifier","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The language identifier"}],"responses":{"200":{"description":"Language data object containing all translations","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"description":"Language data object containing all translations"}}}},"400":{"description":"Bad request - unknown language","content":{"application/json":{"schema":{"type":"object","description":"Bad request - unknown language","properties":{"message":{"type":"string"},"lang_keys":{"type":"array","items":{"type":"string"},"description":"Available language keys"}}}}}}}}}}}
```

## GET /v1/minecraft/vanilla/player/face/{identifier}

> Get player face image by UUID or nickname

```json
{"openapi":"3.0.3","info":{"title":"zaralX Assets","version":"1.1.0"},"servers":[{"url":"https://assets.zaralx.ru/api"}],"paths":{"/v1/minecraft/vanilla/player/face/{identifier}":{"get":{"description":"Get player face image by UUID or nickname","parameters":[{"schema":{"type":"string"},"in":"path","name":"identifier","required":true,"description":"Player UUID or Minecraft nickname"}],"responses":{"200":{"description":"![Example](https://assets.zaralx.ru/api/v1/minecraft/vanilla/player/face/_zaralX_)","content":{"image/png":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad request - invalid UUID or nickname","content":{"application/json":{"schema":{"type":"object","description":"Bad request - invalid UUID or nickname","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","description":"Internal server error","properties":{"message":{"type":"string"},"error":{"type":"string","description":"Error message"}}}}}}}}}}}
```

## GET /v1/minecraft/vanilla/player/face/{identifier}/full

> Get full player face image (with layers) by UUID or nickname

```json
{"openapi":"3.0.3","info":{"title":"zaralX Assets","version":"1.1.0"},"servers":[{"url":"https://assets.zaralx.ru/api"}],"paths":{"/v1/minecraft/vanilla/player/face/{identifier}/full":{"get":{"description":"Get full player face image (with layers) by UUID or nickname","parameters":[{"schema":{"type":"string"},"in":"path","name":"identifier","required":true,"description":"Player UUID or Minecraft nickname"}],"responses":{"200":{"description":"![Example](https://assets.zaralx.ru/api/v1/minecraft/vanilla/player/face/_zaralX_/full)","content":{"image/png":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad request - invalid UUID or nickname","content":{"application/json":{"schema":{"type":"object","description":"Bad request - invalid UUID or nickname","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","description":"Internal server error","properties":{"message":{"type":"string"},"error":{"type":"string","description":"Error message"}}}}}}}}}}}
```

## GET /v1/minecraft/vanilla/player/skin/{identifier}

> Get player skin image by UUID or nickname

```json
{"openapi":"3.0.3","info":{"title":"zaralX Assets","version":"1.1.0"},"servers":[{"url":"https://assets.zaralx.ru/api"}],"paths":{"/v1/minecraft/vanilla/player/skin/{identifier}":{"get":{"description":"Get player skin image by UUID or nickname","parameters":[{"schema":{"type":"string"},"in":"path","name":"identifier","required":true,"description":"Player UUID or Minecraft nickname"}],"responses":{"200":{"description":"![Example](https://assets.zaralx.ru/api/v1/minecraft/vanilla/player/skin/_zaralX_)","content":{"image/png":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad request - invalid UUID or nickname","content":{"application/json":{"schema":{"type":"object","description":"Bad request - invalid UUID or nickname","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","description":"Internal server error","properties":{"message":{"type":"string"},"error":{"type":"string","description":"Error message"}}}}}}}}}}}
```