Downloads Management

Retrieve all downloads

Retrieve the information of all downloads.

get/downloads

Query parameters

sortstring

Example:["title","ASC"]

Specifies the sorting order and field (e.g., ["title", "ASC"]).

rangestring

Example:[0, 24]

Specifies the range of results to return (e.g., [0, 24]).

filterstring

Example:{"title":"bar"}

JSON string specifying the filter conditions (e.g., {"title":"bar"}).

Response

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 9 of the 50 revisions of this API.5522

Oct 2, 2024c9062e3a3c541See the full diff
- ○
  the endpoint scheme security jwt 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
Oct 2, 2024936529d30a411See the full diff
- ○
  the endpoint scheme security jwt was removed from the API
  api-security-removed
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
Jun 7, 202433cd508fee931See the full diff
- ●
  deleted the query request parameter limit
  request-parameter-removed
Jun 7, 2024378b6af93ee12See the full diff
- ○
  the / response's property pattern ^[^<>:;,?"*|/]+$ was added for the status
  response-property-pattern-added
- ○
  the / response's property pattern ^(?![./])[^\0<>:;,?"*|]+(?:/[^\0<>:;,?"*|]+)*$ was added for the status
  response-property-pattern-added
Jun 7, 20245ea1c0d602b94See the full diff
- ○
  the / response's property pattern ^[a-z0-9]+:[a-f0-9]{1,128}$ was added for the status
  response-property-pattern-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 added for the status
  response-property-pattern-added
- ○
  the / response's property pattern ^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?$ was added for the status
  response-property-pattern-added
- ○
  the response required property / became read-only for the status
  response-required-property-became-read-only
Jun 4, 2024a8204c7e01a122See the full diff
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  added the new verified enum value to the / response property for the response status
  response-property-enum-value-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
Jun 4, 2024578e8efc5755529See the full diff
- ▲
  the response header X-Total-Count became optional for the status
  response-header-became-optional
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the / response's property format changed from uri to no format for status
  response-property-type-changed
- ●
  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
- ○
  added the new optional query request parameter limit
  new-optional-request-parameter
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  removed the verified enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  the / response's property pattern ^[^<>:;,?"*|/]+$ was removed for the status
  response-property-pattern-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 removed for the status
  response-property-pattern-removed
- ○
  the / response's property pattern ^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?$ was removed for the status
  response-property-pattern-removed
- ○
  the / response's property pattern ^(?![./])[^\0<>:;,?"*|]+(?:/[^\0<>:;,?"*|]+)*$ was removed for the status
  response-property-pattern-removed
- ○
  the response required property / became not read-only for the status
  response-required-property-became-not-read-only
This revision also has 32 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history