Skip to main content

Upload any Model

You can upload any model to use on Image Pipeline. Please ensure that you only upload models licensed for commercial use as Public Models.Models that you have developed for your own or your company's use can be uploaded as Private Models.

Public Models​

Once you upload a Public Model, it to be available in the Models Page once verification is complete that is it working correctly and adheres to our Terms & Conditions. Please note that any violation of Terms & Conditions will result in a temporary ban or a complete ban.

When uploading a Public Model, ensure that

  • You correctly mark is as NSFW or not
    • NSFW includes nudity and obscenity
    • Child Pornography, Violence, Gore is a violation of our Terms & Conditions
  • Credit the original uploader in the description or it can be reported and taken down
  • Add any instructions for using the model in the description

Here's an example for Public Models

ENDPOINT:

https://api.imagepipeline.io/load_model/v1/

AUTHORIZATION: API-Key

JSON BODY:

{
  "model_name": "Add-more-details",
  "model_url": "https://civitai.com/api/download/models/87153?type=Model&format=SafeTensor",
  "base_model": "sd1.5",
  "model_type": "lora",
  "description": "Developed for adding more details to SD 1.5 images. Tweak the lora weights between 0.5 to 1.",
  "sample_images": ["https://image.civitai.com/xG1nkqKTMzGDvpLrqFT7WA/c1697174-7c8d-4bde-b053-7b1ec0692b64/width=450/xyz_grid-0361-132340235-8k%20portrait%20of%20beautiful%20cyborg%20with%20brown%20hair,%20intricate,%20elegant,%20highly%20detailed,%20majestic,%20digital%20photography,%20art%20by%20artg_.jpeg"],
  "tags": "SD 1.5, LoRA",
  "nsfw": false,
  "revision": "fp16",
  "model_extension": "lora",
  "trigger_words": "",
  "visibility": "public"
}

Private Models​

You can upload Private models to ensure the other users cannot generate images with that model. Use cases include:

  • If you have trained a model on your own photos and you do not want them to go public
  • If you are using models that are copyrighted by your company
  • If you are working on a secret project 😉

Here's an example for Private Models

ENDPOINT:

https://api.imagepipeline.io/load_model/v1/

AUTHORIZATION: API-Key

JSON BODY:

{
  "model_name": "Add-more-details",
  "model_url": "https://civitai.com/api/download/models/87153?type=Model&format=SafeTensor",
  "base_model": "sd1.5",
  "model_type": "lora",
  "description": "Developed for adding more details to SD 1.5 images. Tweak the lora weights between 0.5 to 1.",
  "sample_images": ["https://image.civitai.com/xG1nkqKTMzGDvpLrqFT7WA/c1697174-7c8d-4bde-b053-7b1ec0692b64/width=450/xyz_grid-0361-132340235-8k%20portrait%20of%20beautiful%20cyborg%20with%20brown%20hair,%20intricate,%20elegant,%20highly%20detailed,%20majestic,%20digital%20photography,%20art%20by%20artg_.jpeg"],
  "tags": "SD 1.5, LoRA",
  "nsfw": false,
  "revision": "fp16",
  "model_extension": "lora",
  "trigger_words": "",
  "visibility": "private"
}

Response​

You will receive a model_id that you will then need to pass when generating images. Please pass it in the correct parameter depending on the model type.

Model upload Schema:​

Field NameTypeDescription
model_namestringPass the model name. This name will be displayed in Models Page
pretrained_model_pathstringPass only if using HuggingFace
model_urlstringPass download url of the model file
base_modelstringAllowed values: "sd1.5", "sdxl"
model_typestringAllowed values: "lora", "controlnet", "checkpoint", "embedding"
descriptionstringPass the tips for users to use this model
model_extensionstringAllowed values: "safetensors", "ckpt"
revisionstringAllowed values: "fp16", "fp32"
trigger_wordsstringPass trigger words that need to be added in prompts
sample_imagesarray, stringItems: string
tagsstringOptional comma separated tags. Default: ""
nsfwbooleanWhether model is not safe for work. Default: false
visibilitystringAllowed values: "private", "public"