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

# YAML

> Read a stream as YAML data.

Reads an incoming stream of YAML, such as a downloaded file or an API response, and turns it into items your integration can work with. Use this when the data you receive is in YAML. The whole document is read at once, and you can point at a list inside it so each entry becomes a separate item.

This documentation describes: [Schema](/schemas/stream-deserializer/yaml)

## Fields

**Pattern to items**

Optional

A dot-notated path to the list inside the YAML that holds the items you want to process, so each entry becomes a separate entity. For example, use `products` to read the entries from a top-level `products` list. Leave it empty to treat the whole document as a single item. Do not add `*`; the system steps through the list for you.

**Input stream is not UTF-8 encoded**

Optional

Turn this on when the incoming data uses a character encoding other than UTF-8, so accented and special characters come through correctly. It reveals two more settings: the encoding the data is currently in, and how to handle characters that cannot be converted.

**Input encoding**

Optional

Shown when the input is not UTF-8. The character encoding the incoming data is currently in. Choose from UTF-16, ISO-8859-1, or Windows-1252.

**On unconvertible characters**

Optional

Shown when the input is not UTF-8. What to do with characters that have no UTF-8 equivalent: NONE keeps them as-is, IGNORE drops them, and TRANSLIT replaces them with the closest available character.

## Sample data

This format reads an incoming stream, so it is selected on a step that fetches a file or a response (for example reading a file from a folder) rather than run on data you already have. The example below shows the YAML it reads and the items it produces with the settings listed.

| Field | Value |
| - | - |
| Pattern to items | `products` |

Input (the YAML in the stream):

```yaml theme={null}
products:
  - sku: A1
    name: Wool scarf
  - sku: B2
    name: Leather belt
```

Output (one item per entry in the matched list):

```json theme={null}
{ "sku": "A1", "name": "Wool scarf" }
{ "sku": "B2", "name": "Leather belt" }
```

```json Configuration theme={null}
{
  "prototype": "yaml",
  "parameters": {
    "pattern": "products"
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.