Upload file

Reserve a direct upload slot for a local file that is too large for MCP base64.

← All Files endpoints · Capability overview

POST/v1/files/upload-file

https://api.vee3.io/v1/files/upload-file

0 tokens

Reserve a direct upload slot for a local file that is too large for MCP base64.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

files.upload_file

Parameters3 fields

file_namestringRequired

Desired file name or path for the uploaded file. Use folder/subfolder/.../file_name to organize files in folders. Extension is optional and is replaced based on detected file type. Do not use '..' or absolute paths.

max length 255

retention_daysintegerOptional

How many days to keep the file after upload completes. Default 7. Billing uses size and this retention.

Default: 7 · min 1, max 90

existing_files"stop" | "continue" | "replace"Optional

What to do when a stored file already uses the same name. 'stop' (default) fails on the first duplicate. 'continue' skips duplicates and keeps uploading remaining files. 'replace' overwrites duplicated stored files.

Default: "stop"

Response9 fields

upload_codestring

Short code to pass to the @vee3/upload CLI.

upload_idstring

Stable identifier for the reserved upload.

expires_atstring

ISO 8601 timestamp when the upload code can no longer be resolved (60 minutes after reserve).

max_bytesinteger

Maximum allowed file size in bytes.

retention_daysinteger

Days the file will be retained after upload completes.

existing_filesenum

Policy for files that already exist: stop, continue, or replace.

install_commandstring

One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.

commandstring

Suggested terminal command for uploading the local file or folder.

troubleshootingstring

What to do if installation or uploading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps.

HTTP errors: unauthorized, payment_required, validation_error, upload_file_name_in_use

Example request

Python

import requests

url = "https://api.vee3.io/v1/files/upload-file"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "file_name": "media/clips/launch-video",
    "retention_days": 7
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Upload code for the CLI.

reserved.json

{
  "upload_code": "aJ2nF1k9",
  "upload_id": "3edecf04-99d5-4d89-86b3-8dcdfc6452f5",
  "expires_at": "2026-06-21T14:00:00Z",
  "max_bytes": 2147483648,
  "retention_days": 7,
  "existing_files": "stop",
  "install_command": "npm install -g @vee3/cli",
  "command": "vee3-upload aJ2nF1k9 ./path/to/file-or-folder",
  "troubleshooting": "If installation or uploading fails, call meta-tools.describe with tool_name 'files.upload_file' and follow its setup and troubleshooting notes."
}