v1

latestOpenAPI 3.0.3MIT2026-07-17493640.5 KB
Downloads Management

Start new downloads

Initiates new downloads.

post/downloads

Request body

source_urlstring uri required
file_namestring

A filename that is valid on macOS, Windows, and Linux

target_directorystring

A uri-style relative path that is valid on macOS, Windows, and Linux

file_hashstring

The hash type and hash of the file separated by colon

file_sizeinteger

Bytes

Example request

[
  {
    "source_url": "https://localhost:8080/v1/api",
    "file_name": "Mistral-7B-Instruct-v0.3-Q8_0.gguf",
    "target_directory": "folder/subfolder/file.txt",
    "file_hash": "sha256:404857e776114baada71a08ebd3bba79d721ec7fca99705e7e7b892ae8bc583f",
    "file_size": 7702565088
  }
]

Response

Downloads started

idstring uuid required
source_urlstring uri required
file_namestring

A filename that is valid on macOS, Windows, and Linux

target_directorystring

A uri-style relative path that is valid on macOS, Windows, and Linux

file_hashstring

The hash type and hash of the file separated by colon

file_sizeinteger

Bytes

downloadedinteger

Bytes

progressnumber nullable
status'downloading' | 'paused' | 'processing' | 'completed' | 'verified' | 'failed'
start_timenumber nullable
transfer_ratenumber nullable

Example response

[
  {
    "id": "7bea4732-214f-40e7-9161-4e7241a2b97e",
    "source_url": "https://localhost:8080/v1/api",
    "file_name": "Mistral-7B-Instruct-v0.3-Q8_0.gguf",
    "target_directory": "folder/subfolder/file.txt",
    "file_hash": "sha256:404857e776114baada71a08ebd3bba79d721ec7fca99705e7e7b892ae8bc583f",
    "file_size": 7702565088,
    "downloaded": 7702565088,
    "progress": 10.05,
    "status": "downloading",
    "start_time": 1717398019.4677122,
    "transfer_rate": 49028995.95526451
  }
]