---
title: "table.attachments.put: Store an attachment — Table kit command — Kition"
description: "Stores a file's bytes (base64) in the document; answers the attachment value (url, name, type, size) to put in an attachment field's list."
canonical: "https://developer.kition.ai/docs/kits/table/commands/table.attachments.put"
---

> Canonical HTML: [https://developer.kition.ai/docs/kits/table/commands/table.attachments.put](https://developer.kition.ai/docs/kits/table/commands/table.attachments.put)

# table.attachments.put

**Store an attachment.** Stores a file's bytes (base64) in the document; answers the attachment value (url, name, type, size) to put in an attachment field's list.

- Kit: Table 0.4.0 (.ktable); reference: [Table kit commands](https://developer.kition.ai/docs/kits/table.md)
- Changes the document: yes

## Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `asOrigin` | `string` | no | system:<name> writes as a host feature, outside the undo history. Agents leave it out. |
| `data` | `string` | no | The file's bytes, standard base64. |
| `mimeType` | `string` | no |  |
| `name` | `string` | no |  |
| `tableId` | `integer \| string` | yes | The table's id. |

## Call through table_run

```text
table_run {
  "path": "<file>.ktable",
  "steps": [{ "command": "table.attachments.put", "params": { "tableId": <integer | string> } }]
}
```

The required parameters, with placeholders for their types: not a tested example. Optional: `asOrigin`, `data`, `mimeType`, `name`. table_run answers the step’s result in `completed[i].result`.

## Result

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `change` | `object \| null` | no | What the call changed, or null. |
| `error` | `object` | no | Why the call failed (A18); the file is as it was. |
| `result` | `object` | no | The attachment value: put it in the list an attachment field's value holds. |

```json
{
  "additionalProperties": false,
  "description": "The request's own answer is in `result`, beside `change`: what the call changed in the document (null when nothing changed). A failed call answers `error` instead (A18).",
  "properties": {
    "change": {
      "description": "What the call changed, or null.",
      "oneOf": [
        {
          "additionalProperties": false,
          "description": "What one projection changed in the relational tables, by integer id. Every list is sorted and\nholds no repeats.",
          "properties": {
            "dashboards": {
              "description": "A dashboard, or the base's list of them, changed.",
              "type": "boolean"
            },
            "documentId": {
              "type": "string"
            },
            "origin": {
              "description": "Who wrote it: kind:principal, or a system origin's label.",
              "type": "string"
            },
            "recordsDeleted": {
              "description": "[tableId, rowKey] pairs.",
              "items": {
                "items": {},
                "type": "array"
              },
              "type": "array"
            },
            "recordsReordered": {
              "description": "Tables whose records' positions changed.",
              "items": {
                "type": "integer"
              },
              "type": "array"
            },
            "recordsUpserted": {
              "description": "[tableId, rowKey] pairs.",
              "items": {
                "items": {},
                "type": "array"
              },
              "type": "array"
            },
            "schema": {
              "description": "Tables whose fields were added, removed, updated, or reordered.",
              "items": {
                "type": "integer"
              },
              "type": "array"
            },
            "tables": {
              "description": "Tables whose own row changed: created, deleted, renamed, moved, or given a new primary\nfield.",
              "items": {
                "type": "integer"
              },
              "type": "array"
            },
            "views": {
              "description": "Views created, deleted, updated, or reordered, or whose column widths or visibility\nchanged.",
              "items": {
                "type": "integer"
              },
              "type": "array"
            }
          },
          "required": [
            "tables",
            "schema",
            "views",
            "recordsReordered",
            "dashboards"
          ],
          "type": "object"
        },
        {
          "type": "null"
        }
      ]
    },
    "error": {
      "additionalProperties": false,
      "description": "Why the call failed (A18); the file is as it was.",
      "properties": {
        "code": {
          "enum": [
            "invalid-params",
            "invalid-op",
            "invalid-value",
            "not-found",
            "read-only",
            "unknown-command",
            "command-failed",
            "not-open",
            "draft-required",
            "not-allowed",
            "unsupported",
            "unavailable",
            "failed"
          ],
          "type": "string"
        },
        "index": {
          "description": "The failing step or operation.",
          "type": "integer"
        },
        "message": {
          "type": "string"
        },
        "retryable": {
          "type": "boolean"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "result": {
      "additionalProperties": true,
      "description": "The attachment value: put it in the list an attachment field's value holds.",
      "properties": {
        "mimeType": {
          "description": "The file's media type.",
          "type": "string"
        },
        "name": {
          "description": "The file's name.",
          "type": "string"
        },
        "sha256": {
          "description": "The bytes' SHA-256.",
          "type": "string"
        },
        "sizeBytes": {
          "description": "The file's size in bytes.",
          "type": "integer"
        },
        "url": {
          "description": "kition-blob: and the bytes' SHA-256.",
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
```

## Parameter schema

```json
{
  "additionalProperties": false,
  "properties": {
    "asOrigin": {
      "description": "system:<name> writes as a host feature, outside the undo history. Agents leave it out.",
      "type": "string"
    },
    "data": {
      "default": "",
      "description": "The file's bytes, standard base64.",
      "type": "string"
    },
    "mimeType": {
      "default": "",
      "type": "string"
    },
    "name": {
      "default": "",
      "type": "string"
    },
    "tableId": {
      "description": "The table's id.",
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ],
      "x-khp-types": [
        "Table"
      ]
    }
  },
  "required": [
    "tableId"
  ],
  "type": "object"
}
```

Generated from kition-sdk packages/script/kits/table.ts and the kit itself (kition-table@ee73209).
