v1

latestOpenAPI 3.0.32026-08-061810496.7 KB

Secure spaces, folders & files

Upload file

Processes a file upload via direct transfer or S3 finalization.

MODE 1: Direct Upload (Files < 25 MB)

<ul> <li>Action: Pass the binary content in the `file` parameter.</li> </ul>

MODE 2: S3 Finalization (Files > 25 MB)

<ul> <li>Action: Finalize a large file previously uploaded to S3</li> <li>Requirement: You must provide the `version` string obtained during the 'Request file upload' step</li> </ul>

S3 Workflow Reference:

<ol> <li>Call 'Request file upload' (returns credentials, `key`, and `version`)</li> <li>Upload to S3 using the AWS SDK</li> <li>Call this endpoint with the `version` string to create the file record</li> </ol>

post/api/1/files

Response

Idinteger

@typestring

@idstring

Accessstring

Linkstring

OriginalLinkstring

URLstring

created_atstring

deleted_atstring nullable

expires_atstring nullable

updated_atstring

Scopestring

Editableboolean

RestrictDownloadsboolean

Example response

{
  "Id": 2569693,
  "@type": "Document",
  "@id": "file_2569693",
  "Access": "private",
  "Link": "/dl/hvHTy0JSam/ONr5Ay7MJWmJJfhc",
  "OriginalLink": "/dl/hvHTy0JSam/ONr5Ay7MJWmJJfhc",
  "URL": "hvHTy0JSam/ONr5Ay7MJWmJJfhc",
  "created_at": "2026-06-29T18:54:46.000000Z",
  "deleted_at": null,
  "expires_at": null,
  "updated_at": "2026-06-29T18:54:46.000000Z",
  "creator": {
    "ID": 28144,
    "@type": "User",
    "Title": null,
    "Name": "Roderick Leffler",
    "FirstName": "Roderick",
    "LastName": "Leffler",
    "Avatar": "https://alex-macbook.tail9fea4c.ts.net/images/avatar_male.png",
    "Scope": "external",
    "HasContact": false
  },
  "Scope": "external",
  "Editable": false,
  "RestrictDownloads": false,
  "current": {
    "Id": 617473805,
    "Name": "Cartwright-Balistreri.snd",
    "Size": 939714945,
    "Source": "WEB",
    "ExternalLink": null,
    "MimeType": "application/vnd.kodak-descriptor",
    "Stored": true,
    "AVStatus": null,
    "created_at": "2026-06-29T18:54:46.000000Z",
    "Thumbnail": null,
    "@type": "Version",
    "updated_at": "2026-06-29T18:54:46.000000Z",
    "deleted_at": null
  }
}