Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ekso.dev/llms.txt

Use this file to discover all available pages before exploring further.

File attachment on an item or annotation. Files are uploaded as multipart form-data via the POST /api/file/upload endpoint and downloaded as binary streams. The DataFile shape is the metadata record returned alongside the uploaded file — the file content itself isn’t part of this JSON.

​
Sample JSON

Copy, edit, paste. Server-set fields (id, created, tenantId, …) are omitted from the example — they’re populated by the server on response. 
{
  "owner": "Item",
  "ownerId": "item_01HITEM_LOGIN_BUG",
  "fileName": "screenshot-of-error.png",
  "mimeType": "image/png",
  "sizeBytes": 184320
}

​
What Ekso fills in

These fields are managed by the server. You don’t pass them on writes — they appear on the response.
  • sizeBytes — Captured by the upload pipeline once the byte stream finishes streaming to storage.

​
Fields

FieldTypeRequiredNotes
entitystring • nullableServer-setSet by the server. Read-only on writes.
ownerContentOwnerOptionalType of the entity this file is attached to. Item or Annotation only — the controller hard-rejects other owners.
ownerIdstringRequiredId of the owning entity.
uidstringOptional
filenamestringOptional
mimeTypestringOptionalMIME type, detected from the upload’s content-type header.
lengthintegerOptional
tenantIdstringServer-setSet by the server. Read-only on writes.
idstringServer-setSet by the server. Read-only on writes.
createdstring (date-time)Server-setSet by the server. Read-only on writes.
createdBystringServer-setSet by the server. Read-only on writes.
updatedstring (date-time)Server-setSet by the server. Read-only on writes.
updatedBystringServer-setSet by the server. Read-only on writes.
deletedbooleanServer-setSet by the server. Read-only on writes.

​
Used by

​
Response body

  • GET /api/file/{id}
  • GET /api/file/{ownerType}/{ownerId}

​
CLI

ekso file — see the command branches page for available verbs. Body for create / update verbs typically passed via --data @file.json matching the sample JSON above.