File element
This is a rich text element, compatible only with the rich_text block. It must be used within the rich_text_list, rich_text_quote, or rich_text_section block element within the rich_text block's elements array.
Fields
| Field | Type | Description | Required? |
|---|---|---|---|
type | String | The type of object; in this case, "file". | Required |
file_id | String | The ID of the file to link to. | Required |
style | Object | An object of optional boolean properties that dictate style: bold, italic, strike, highlight, client_highlight, and underline. | Optional |
text | String | Title of the file. | Optional |
url | String | URL of the file. | Optional |
is_skill_invocation | Boolean | Indicates whether this file element was inserted as a skill invocation. | Optional |
Example
- JSON
{
"blocks": [
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"type": "file",
"file_id": "F123ABC456"
}
]
}
]
}
]
}