For AI agents: markdown of this page — /docs-content-en/chats/messages/attach.md documentation index — /llms.txt

Attachments (ATTACH blocks)

Rich message layout — cards, field-value tables, images, files and dividers. Passed in the attach field together with message.

attach is an array of blocks. Each block is an object with a single type key. The MESSAGE text block takes a string; the other blocks take an array of objects with fields.

Block types

MESSAGE — text

A text string. Supports BB codes.

JSON 
{ "MESSAGE": "Task status updated" }

GRID — field-value table

Field Type Description
FieldNAME Typestring DescriptionField name
FieldVALUE Typestring DescriptionField value
FieldDISPLAY Typestring DescriptionLayout: LINE (inline), BLOCK, ROW
FieldWIDTH Typeinteger DescriptionColumn width in pixels
JSON 
{ "GRID": [
  { "NAME": "Task", "VALUE": "Prepare the report", "DISPLAY": "LINE" },
  { "NAME": "Status", "VALUE": "Done", "DISPLAY": "LINE" }
] }
Field Type Description
FieldNAME Typestring DescriptionLink title
FieldLINK Typestring DescriptionURL
FieldDESC Typestring DescriptionDescription
FieldPREVIEW Typestring DescriptionPreview image URL
JSON 
{ "LINK": [{ "NAME": "Documentation", "LINK": "https://example.com/docs", "DESC": "API reference" }] }

IMAGE — image

Field Type Description
FieldLINK Typestring DescriptionImage URL
FieldNAME Typestring DescriptionCaption
FieldPREVIEW Typestring DescriptionPreview URL
FieldWIDTH Typeinteger DescriptionWidth in pixels
FieldHEIGHT Typeinteger DescriptionHeight in pixels
JSON 
{ "IMAGE": [{ "LINK": "https://example.com/chart.png", "NAME": "Sales chart", "WIDTH": 600, "HEIGHT": 400 }] }

FILE — file

Field Type Description
FieldLINK Typestring DescriptionFile URL
FieldNAME Typestring DescriptionFile name
FieldSIZE Typeinteger DescriptionSize in bytes
JSON 
{ "FILE": [{ "LINK": "https://example.com/report.pdf", "NAME": "report.pdf", "SIZE": 2048576 }] }

USER — user card

Field Type Description
FieldNAME Typestring DescriptionUser name
FieldAVATAR Typestring DescriptionAvatar URL
FieldLINK Typestring DescriptionProfile URL
JSON 
{ "USER": [{ "NAME": "John Brown", "LINK": "https://example.com/u/42" }] }

DELIMITER — divider line

Field Type Description
FieldSIZE Typeinteger DescriptionWidth in pixels
FieldCOLOR Typestring DescriptionColor in hexadecimal format
JSON 
{ "DELIMITER": [{ "SIZE": 200, "COLOR": "#c6c6c6" }] }

Full example

JSON 
{
  "message": "Task report",
  "attach": [
    { "MESSAGE": "[B]Task status updated[/B]" },
    { "DELIMITER": [{}] },
    { "GRID": [
      { "NAME": "Task", "VALUE": "Prepare the report", "DISPLAY": "LINE" },
      { "NAME": "Status", "VALUE": "Done", "DISPLAY": "LINE" }
    ] },
    { "LINK": [{ "NAME": "Open the task", "LINK": "https://example.com/tasks/42" }] }
  ]
}

See also