Sign in
models-files

Start Model File Download

Changed on

Initiates a new model file download from HuggingFace repository. Creates a download request that can be tracked for progress. Returns existing request if download is already in progress.

post/bodhi/v1/models/files/pull

Request

  • Base URL: http://localhost:1135
  • URL: http://localhost:1135/bodhi/v1/models/files/pull
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL /bodhi/v1/auth/initiate, token URL /bodhi/v1/auth/callback, scopes: resource_power_user)

Request body

repostring required

HuggingFace repository name in format 'username/repository-name'

filenamestring required

Model file name to download (typically .gguf format)

Example request

{
  "filename": "mistral-7b-instruct-v0.1.Q4_K_M.gguf",
  "repo": "TheBloke/Mistral-7B-Instruct-v0.1-GGUF"
}

Response

Existing download request found

idstring required
repostring required
filenamestring required
status'pending' | 'completed' | 'error' required
errorstring nullable
total_bytesinteger nullable
downloaded_bytesinteger required
started_atstring date-time nullable
archived_atstring date-time nullable
created_atstring date-time required
updated_atstring date-time required

Changes

  • 8ee55e8903d9Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 11825ee4b44dRevision changes
    • breaking

      removed 'propertyNames' constraint from the / response property for the status

    • breaking

      removed 'propertyNames' constraint from the / response property for the status

    • breaking

      removed 'propertyNames' constraint from the / response property for the status

    • breaking

      removed 'propertyNames' constraint from the / response property for the status

    • breaking

      the / response's property type changed from object null to string null for status

    • breaking

      the / response's property type changed from object null to string null for status

    • breaking

      the / response's property type changed from object null to string null for status

    • breaking

      the / response's property type changed from object null to string null for status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status