mailerpress-pro/create-embed-key creates a new embed-form API key.
The raw key value is returned in this response and nowhere else. Store it immediately; MailerPress cannot re-issue it.
At a glance
| Ability | mailerpress-pro/create-embed-key |
| Toolset | MailerPress Pro — toolset/mailerpress-pro |
| Group | MailerPress Pro › Embed Keys |
| Requires | AcrossAI Pro, plus MailerPress with its Pro add-on active on the site |
| Capability | manage_options |
| Safety | Writes data |
| Repeatable | Not idempotent — each call changes the row set, so re-running is not a no-op |
| Ships in | AcrossAI Pro 0.9.16 and later |
One chance to capture the key
The key is stored one-way, so the creation response is the only moment it exists in readable form. A response that is not captured means the key is unusable and a new one has to be created.
That is worth saying plainly because the failure is quiet: the key exists, appears in the listing, and cannot be put into an embed by anybody.
Setting the allowed domain at creation is the important part of the configuration. An embed key travels in page source and is therefore visible; the domain restriction is what makes that acceptable.
Rate limits should be set deliberately too. A key intended for one signup form on one site has a very different expected volume from one serving a network of sites, and the default is unlikely to match either.
Not idempotent — each call issues another key.
Input
| Name | Type | Required | What it is |
|---|---|---|---|
name | string | Yes | A name identifying what the key is for. |
allowed_domain | string | No | Restrict use to this domain. Without it the key works from anywhere. |
rate_limit | integer | No | Requests allowed in the rate window. |
What comes back
| Name | Type | What it is |
|---|---|---|
key | string | The raw key. Returned here and never again. |
id | integer | The key record. |
success | boolean | Whether the call completed. |
message | string | A one-line summary of what happened, suitable for showing a human. |
error_code | string | Present only on failure — a stable machine-readable reason, such as a missing field, a wrong field type or an unmet confirmation. |
Example
Ask your assistant:
Create an embed key for the marketing site signup form.
It resolves to one call:
{
"ability": "mailerpress-pro/create-embed-key",
"parameters": {
"name": "Marketing site signup",
"allowed_domain": "example.com"
}
}Worth knowing
- Capture the key from this response. There is no second chance.
- Set the allowed domain — the key is visible in page source.
- Name it after what uses it, so it can be revoked knowingly later.
- Not idempotent.
Related abilities
- MailerPress Pro List Embed Keys — see what exists
- MailerPress Pro Update Embed Key — change the scope
Get the plugins:
AcrossAI Abilities Manager · AcrossAI MCP Manager
Browse the rest: Every ability, by category