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

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
  }
]

Changes

Changed in 11 of the 50 revisions of this API.132344

Oct 2, 2024c9062e3a3c5413See the full diff
- ○
  the endpoint scheme security jwt was added to the API
  api-security-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  the response optional property / became read-only for the status
  response-optional-property-became-read-only
- ○
  the response property / became required for the status
  response-property-became-required
- ○
  added the required property / to the response with the status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 2, 2024936529d30a41292See the full diff
- ▲
  the response property / became optional for the status
  response-property-became-optional
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  the endpoint scheme security jwt was removed from the API
  api-security-removed
- ○
  the response required property / became not read-only for the status
  response-required-property-became-not-read-only
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 18, 2024041ec1a0e4032See the full diff
- ○
  the endpoint scheme security jwt was added to the API
  api-security-added
- ○
  the endpoint scheme security cookieAuth was removed from the API
  api-security-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 8, 2024d53276437f781See the full diff
- ○
  the endpoint scheme security cookieAuth was added to the API
  api-security-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 3, 2024df9ba4d2a23c12See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  the response optional property / became read-only for the status
  response-optional-property-became-read-only
- ○
  the response property / became required for the status
  response-property-became-required
- ○
  added the required property / to the response with the status
  response-required-property-added
Jun 7, 20248ed0ccbdb5a651See the full diff
- ▲
  the request property / became not nullable
  request-property-became-not-nullable
- ▲
  added the pattern ^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?$ to the request property /
  request-property-pattern-added
- ▲
  added the pattern ^(?![./])[^\0<>:;,?"*|]+(?:/[^\0<>:;,?"*|]+)*$ to the request property /
  request-property-pattern-added
- ▲
  added the pattern ^[^<>:;,?"*|/]+$ to the request property /
  request-property-pattern-added
- ▲
  added the pattern ^[a-z0-9]+:[a-f0-9]{1,128}$ to the request property /
  request-property-pattern-added
- ○
  added the new optional request property /
  new-optional-request-property
Jun 7, 2024378b6af93ee112See the full diff
- ▲
  the response's property type changed from string to object, and format from uuid to no format for status
  response-property-type-changed
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  the response's property pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ was removed for the status
  response-property-pattern-removed
Jun 7, 2024f0b7b1993456111See the full diff
- ▲
  the response's property type changed from object to string, and format from no format to uuid for status
  response-property-type-changed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  the response's property pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ was added for the status
  response-property-pattern-added
Jun 7, 20245ea1c0d602b91See the full diff
- ▲
  the / request property format changed from no format to uri
  request-property-type-changed
Jun 4, 2024a8204c7e01a121See the full diff
- ●
  removed the request property /
  request-property-removed
- ●
  removed the request property /
  request-property-removed
- ○
  added the new optional request property /
  new-optional-request-property

Full history (11 revisions)