> For the complete documentation index, see [llms.txt](https://docs.wem.io/platform/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.wem.io/platform/wemreference/functions/security/aesencrypt.md).

# AesEncrypt

{% hint style="info" %}
The **`AesEncrypt()`** function generates a base64 encoded ciphertext based on the given <mark style="color:blue;">plaintext</mark>, <mark style="color:blue;">key</mark> and initialization <mark style="color:blue;">vector.</mark>

This function is NOT SQL compatible. For more information about SQL compatibility, see our [documentation](/platform/wemreference/sql-compatibility.md).
{% endhint %}

{% hint style="success" %}
Returns a base64 encoded cipher<mark style="color:green;">**text**</mark>\
Returns <mark style="color:red;">**`invalid key`**</mark>if the wrong key is used and <mark style="color:red;">`invalid initialization vector`</mark> if the wrong vector is used.&#x20;
{% endhint %}

### Syntax

<details>

<summary><code>AesEncrypt(</code><mark style="color:blue;"><code>plaintext</code></mark><code>, </code><mark style="color:blue;"><code>key</code></mark><code>, </code><mark style="color:blue;"><code>vector</code></mark><code>)</code></summary>

`AesEncrypt(text, key, vector)`\
\&#xNAN;*=> +8oDxXf+w91SR+/AkjpdcLSbygah8m3OQdapwnkAjvY=*

</details>

<details>

<summary><code>AesEncrypt(</code><mark style="color:blue;"><code>plaintext</code></mark><code>, </code><mark style="color:blue;"><code>key</code></mark><code>, </code><mark style="color:blue;"><code>vector</code></mark><code>, </code><mark style="color:blue;"><code>encoding with BOM</code></mark><code>)</code></summary>

`AesEncrypt(text, key, vector, false)`\
\&#xNAN;*=> e3ieQNh8nKH/pHImo+JQmZvr+rhSGn4WHQJyTBmPCbA=*

</details>

### Parameters

<table><thead><tr><th width="150">Name</th><th width="150">Type</th><th width="150" align="center">Required</th><th width="248.15953250810662">Description</th><th data-hidden>Required?</th></tr></thead><tbody><tr><td><mark style="color:blue;"><code>plaintext</code></mark></td><td>text</td><td align="center"><span data-gb-custom-inline data-tag="emoji" data-code="2611">☑️</span></td><td>The text to encrypt. </td><td>yes</td></tr><tr><td><mark style="color:blue;"><code>key</code></mark></td><td>text</td><td align="center"><span data-gb-custom-inline data-tag="emoji" data-code="2611">☑️</span></td><td>Text or data field that holds the encryption key. A key can be generated using <a href="/pages/TfJY7FSunL9pgOT3Iz49">AesKey()</a></td><td>yes</td></tr><tr><td><mark style="color:blue;"><code>vector</code></mark></td><td>text</td><td align="center"><span data-gb-custom-inline data-tag="emoji" data-code="2611">☑️</span></td><td>Text or data field that holds the encryption vector. A proper Vector value can be generated using <a href="/pages/sAxYnR2HEr4rC58SNrf6">AesIv()</a> </td><td></td></tr><tr><td><mark style="color:blue;"><code>encoding with BOM</code></mark></td><td>yes/no</td><td align="center"></td><td>enable or disable encoding with BOM (check the receiving party if BOM is required/expected). </td><td></td></tr></tbody></table>


---

# 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://docs.wem.io/platform/wemreference/functions/security/aesencrypt.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.