Download file

Reserve a direct download for a previously uploaded file.

← All Files endpoints · Capability overview

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."
}