Files

Upload, list, and download files for use with other Vee3 capabilities.

POST/v1/files/delete-file

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

0 tokens

Delete a previously uploaded file from account storage.

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.delete_file

Parameters1 field

file_namestringRequired

Relative file name or path to delete. Use files.list_uploaded_files to see available names.

max length 255

Response1 field

file_namestring

Deleted file name.

HTTP errors: unauthorized, payment_required, validation_error, uploaded_file_not_found

Example request

Python

import requests

url = "https://api.vee3.io/v1/files/delete-file"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "file_name": "reports/q1-summary.pdf"
}

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

Example responses1 example

200File removed from storage.

deleted.json

{
  "file_name": "reports/q1-summary.pdf"
}

POST/v1/files/download-file

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

0 tokens

Reserve a direct download for a previously uploaded file.

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.download_file

Parameters1 field

file_namestringRequired

Relative file name or path to download. Use files.list_uploaded_files to see available names.

max length 255

Response9 fields

download_codestring

Short code to pass to the @vee3/get-file CLI.

download_idstring

Stable identifier for the reserved download.

expires_atstring

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

file_namestring

Stored file name.

size_bytesinteger

Object size in bytes when known.

content_typestring

MIME type on the stored object when known.

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 downloading to a local path.

troubleshootingstring

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

HTTP errors: unauthorized, payment_required, validation_error, uploaded_file_not_found

Example request

Python

import requests

url = "https://api.vee3.io/v1/files/download-file"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "file_name": "reports/q1-summary.pdf"
}

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

Example responses1 example

200Download code for the CLI.

reserved.json

{
  "download_code": "bK3mP9x2",
  "download_id": "4feacf05-aae6-5e9a-97c4-9edfcd756306",
  "expires_at": "2026-06-21T14:00:00Z",
  "file_name": "reports/q1-summary.pdf",
  "size_bytes": 1048576,
  "content_type": "application/pdf",
  "install_command": "npm install -g @vee3/cli",
  "command": "vee3-get-file bK3mP9x2 ./path/to/save",
  "troubleshooting": "If installation or downloading fails, call meta-tools.describe with tool_name 'files.download_file' and follow its setup and troubleshooting notes."
}

POST/v1/files/extend-file

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

0 tokens

Extend how long a retained upload stays in storage.

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.extend_file

Parameters2 fields

file_namestringRequired

Relative file name or path to extend. Use files.list_uploaded_files and choose a file that includes retained_until.

max length 255

additional_retention_daysintegerRequired

Days to add to the file's retention schedule.

min 1, max 90

Response5 fields

file_namestring

Extended file name.

retained_untilstring

ISO 8601 timestamp when the file is now scheduled to be removed.

additional_retention_daysinteger

Days added in this request.

token_costinteger

Tokens billed for this extension.

size_bytesinteger

File size in bytes used for billing.

HTTP errors: unauthorized, payment_required, validation_error, insufficient_tokens, uploaded_file_not_found

Example request

Python

import requests

url = "https://api.vee3.io/v1/files/extend-file"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "file_name": "reports/q1-summary.pdf",
    "additional_retention_days": 7
}

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

Example responses1 example

200Retention extended with token cost.

extended.json

{
  "file_name": "reports/q1-summary.pdf",
  "retained_until": "2026-07-05T14:00:00Z",
  "additional_retention_days": 7,
  "token_cost": 4,
  "size_bytes": 1048576
}

GET/v1/files/uploaded-files

https://api.vee3.io/v1/files/uploaded-files

0 tokens

List files currently uploaded for the authenticated Vee3 account.

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.list_uploaded_files

Parameters1 field

folderstringOptional

Optional folder path (for example media/clips). When set, only files under that folder (including nested subfolders) are returned. Do not use '..' or absolute paths.

max length 200

Response7 fields

filesarrayitems

6 fields

Files currently stored for the authenticated account, newest first.

upload_idstring

Upload session identifier when Vee3 can match this file to a prior files.upload_file reservation.

file_namestring

Stored file name, including folders when used (for example media/clips/launch-video.mp4).

content_typestring

MIME type of the file.

size_bytesinteger

File size in bytes.

uploaded_atstring

ISO 8601 timestamp when the file was uploaded.

retained_untilstring

ISO 8601 timestamp when the file is scheduled to be removed. Present when Vee3 matched the file to a completed upload session.

HTTP errors: unauthorized, payment_required, validation_error

Example request

Python

import requests

url = "https://api.vee3.io/v1/files/uploaded-files"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "folder": "media/clips"
}

response = requests.get(url, headers=headers, params=params)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Two uploaded files.

two_bucket_objects.json

{
  "files": [
    {
      "upload_id": "3edecf04-99d5-4d89-86b3-8dcdfc6452f5",
      "file_name": "launch-video.mp4",
      "content_type": "video/mp4",
      "size_bytes": 52428800,
      "uploaded_at": "2026-06-21T14:05:00Z",
      "retained_until": "2026-06-28T14:05:00Z"
    },
    {
      "file_name": "legacy-asset.png",
      "content_type": "image/png",
      "size_bytes": 2048,
      "uploaded_at": "2026-06-20T09:15:00Z"
    }
  ]
}

POST/v1/files/move-file

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

0 tokens

Move a stored upload to a new account-relative path.

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.move_file

Parameters2 fields

source_file_namestringRequired

Current relative file name or path. Use files.list_uploaded_files to see available names.

max length 255

destination_file_namestringRequired

New relative file name or path. Must not already exist in account storage.

max length 255

Response2 fields

source_file_namestring

Previous file name.

destination_file_namestring

New file name after the move.

HTTP errors: unauthorized, payment_required, validation_error, uploaded_file_not_found, uploaded_file_name_in_use

Example request

Python

import requests

url = "https://api.vee3.io/v1/files/move-file"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "source_file_name": "q1-summary.pdf",
    "destination_file_name": "reports/q1-summary.pdf"
}

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

Example responses1 example

200File moved to the new path.

moved.json

{
  "source_file_name": "q1-summary.pdf",
  "destination_file_name": "reports/q1-summary.pdf"
}

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

Parameters2 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

Response8 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.

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.

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,
  "install_command": "npm install -g @vee3/cli",
  "command": "vee3-upload aJ2nF1k9 ./path/to/file",
  "troubleshooting": "If installation or uploading fails, call meta-tools.describe with tool_name 'files.upload_file' and follow its setup and troubleshooting notes."
}