Beta

Start File Upload

Last updated Nov 19, 2026View as MarkdownAgent setup / MCP
POST
/v1/files/uploads

Creates a File in the authenticated Workspace and a resumable TUS upload session. A Business is optional; Room attachments require their Business. Uploaded content remains unavailable until it passes the file checks.

Authorization

headerAuthorizationBearer <token>

A signed-in SMB user's access token. Workspace-scoped operations also require SMB-Workspace-Id.

Header Parameters

SMB-Workspace-Id*string

Workspace where this operation runs. Required for user tokens and Workspace API keys.

Formatuuid
Idempotency-Key*string
Length8 <= length <= 200

Request Body

application/json
  1. body
business_id?SmbV0OperationsGetBusinessComparablesRequestBusinessId

Stable SMB Business ID.

Match^biz_[0-7][0-9A-HJKMNP-TV-Z]{25}$
room_id?string

Stable Room ID.

Match^rom_[0-7][0-9A-HJKMNP-TV-Z]{25}$
name*string
Length1 <= length <= 300
description?|
Lengthlength <= 4000
classification?|
Value in"financial""legal""operational""marketing""other"null
tags?array<>
Itemsitems <= 32
content_type*ContentType
Value in"application/pdf""application/vnd.openxmlformats-officedocument.wordprocessingml.document""application/vnd.openxmlformats-officedocument.spreadsheetml.sheet""application/vnd.openxmlformats-officedocument.presentationml.presentation""text/csv""text/tab-separated-values""text/plain""text/markdown""application/json""image/png""image/jpeg""image/webp"
size_bytes*integer
Range1 <= value <= 104857600
sha256?smb_v0_operations_check_api_health_response.__local.Digest
Match^sha256:[0-9a-f]{64}$
access_mode?string

Room attachment visibility. This field may be supplied only when room_id is present.

Value in"inherit_room""restricted""private"
folder_id?|

Room folder to put it in.

Match^rfd_[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

The existing resource or idempotent replay was returned.

application/json
  1. response
file*
upload*
room_file_id*|
Match^rfl_[0-7][0-9A-HJKMNP-TV-Z]{25}$
action_receipt*
idempotent_replay*smb_v0_operations_create_list_request.__local.properties.body.__schema16
request_id*string
curl -X POST 'https://example.com/v1/files/uploads' \  -H 'SMB-Workspace-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Idempotency-Key: stringst' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "content_type": "application/pdf",  "size_bytes": 1}'
{  "file": {    "file_id": "string",    "business_id": "string",    "name": "string",    "description": "string",    "classification": "financial",    "tags": [      "string"    ],    "origin": "upload",    "lifecycle": "active",    "current_version": {      "file_version_id": "string",      "version_number": 1,      "content_type": "string",      "size_bytes": 1,      "sha256": "string",      "processing_status": "pending_upload",      "processing_error": "string",      "summary": "string",      "created_by": {        "type": "person",        "user_id": "string",        "name": "string",        "via": null      },      "created_at": "2019-08-24T14:15:22Z",      "ready_at": "2019-08-24T14:15:22Z",      "protection": {},      "redacted_from": "string",      "redacted_copy": "string"    },    "revision": 1,    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z",    "archived_at": "2019-08-24T14:15:22Z",    "access_level": "view"  },  "upload": {    "upload_id": "string",    "protocol": "tus",    "url": "http://example.com",    "headers": {      "x-signature": "string",      "upload-metadata": "string"    },    "expires_at": "2019-08-24T14:15:22Z",    "max_size_bytes": 104857600  },  "room_file_id": "string",  "action_receipt": {    "receipt_id": "64d0a161-468e-472a-b00e-a06ee9ab7de7",    "command_id": "7d510d78-7444-4252-aeac-9e473949661e",    "operation": "string",    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"  },  "idempotent_replay": true,  "request_id": "string"}