Skip to main content
API reference sections

Schema

ChatAttachment

The public metadata of one stored attachment. A path reference keeps its path here because the person explicitly chose to send that path to an agent.

Type object

Shape

FieldTypeDescription
idrequiredChatAttachmentId

ChatAttachmentId - a client-minted UUID v4, never derived from content or location.

message_idMessageId or null

The user message it was sent with; None while it is staged.

ordinalinteger (uint32, >= 0) or null
kindrequiredChatAttachmentKind
sourcerequiredChatAttachmentSource
file_namerequiredstring
media_typerequiredstring
byte_countrequiredinteger (uint64, >= 0)
dimensionsarray of any or null

Width and height, for a picture.

originWorkspaceFileOrigin or null
reference_pathstring or null
created_atrequiredTimestamp

Epoch milliseconds, UTC. Signed, so instants before 1970 are representable.

Example
{
  "id": "00000000-0000-4000-8000-000000000000",
  "message_id": "00000000-0000-4000-8000-000000000000",
  "ordinal": 0,
  "kind": "image",
  "source": "clipboard",
  "file_name": "string",
  "media_type": "string",
  "byte_count": 0,
  "dimensions": [
    {}
  ],
  "origin": {
    "workspace_id": "00000000-0000-4000-8000-000000000000",
    "document_id": "00000000-0000-4000-8000-000000000000"
  },
  "reference_path": "string",
  "created_at": 0
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Generated from contract version 1. Last updated .

Privacy choices

Choose which optional tools Koru may use on this site. Your choice is saved in a cookie in this browser for 12 months. Privacy policy

Privacy choices

Keep you signed in, protect forms and remember your language and this choice.

Always on

PostHog and Google Analytics 4 measure page views and actions such as downloads, using cookies or local storage.

PostHog records how pages are used, with form inputs masked and private pages excluded. Needs Analytics.

Ahrefs Web Analytics measures visits and where they come from, and Google Ads measures whether our ads led to a visit or download.