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

# AI Format Message

Reformat raw blockchain/trading data into clean, human-readable message text using AI. Shortens hex addresses, formats numbers, translates jargon, and styles output for Slack/Discord/Telegram. Ideal for: message formatting, alert messages, trade notifications, event summaries before sending to messaging platforms.

![AI Format Message logo](https://ai-icon.b3.fun/logo/discord)
Catalog action Utility

Reformat raw blockchain/trading data into clean, human-readable message text using AI. Shortens hex addresses, formats numbers, translates jargon, and styles output for Slack/Discord/Telegram. Ideal for: message formatting, alert messages, trade notifications, event summaries before sending to messaging platforms.


## At a Glance

| Field | Value |
| --- | --- |
| Action ID | `ai-format-message` |
| Category | Utility |
| Connector | Not required |
| Requires gas | No |
| Funds movement | None declared |
| Tags | `ai`, `notification`, `utility`, `slack`, `discord`, `telegram` |

## Payload Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `rawText` | `string \| object \| array` | Yes | Raw text or structured event data to format. Can be a string, JSON object, or array from a previous workflow step. |
| `eventType` | `string` | No | Domain context hint for the AI formatter \(e.g., 'prediction market order', 'token swap', 'price alert', 'DeFi position'\). Helps produce more accurate formatting. |
| `platform` | `string` | No | Target messaging platform. Slack uses mrkdwn, Discord uses markdown, Telegram uses HTML. Default: 'general' |

## Result Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `output` | `string` | Yes | The formatted, human-readable message text |
| `model` | `string` | Yes | The model that was used |
| `usage` | `object` | No | Token usage statistics from OpenRouter |

## Examples

**Workflow node**

```json
{
  "type": "ai-format-message",
  "payload": {
    "rawText": "Workflow completed"
  },
  "children": []
}
```
  **Test with API**

```bash
curl -X POST "https://api.b3os.org/v1/actions/ai-format-message/test" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "inputs": {
    "rawText": "Workflow completed"
  }
}'
```

**Use expressions for dynamic values**

Payload fields can use workflow expressions such as `{{$trigger.body.amount}}`, `{{$nodes.fetch.result.price}}`, and `{{$props.asset}}` when the value should come from a trigger, prior node, or reusable workflow prop.