Skip to main content
GET
https://api.novita.ai
/
v3
/
model
Get Model
curl --request GET \
  --url https://api.novita.ai/v3/model \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>'
{
  "models": [
    {
      "id": 123,
      "name": "<string>",
      "hash_sha256": "<string>",
      "sd_name": "<string>",
      "type": {
        "name": "<string>",
        "display_name": "<string>"
      },
      "categories": [
        "<string>"
      ],
      "status": 123,
      "download_url": "<string>",
      "tags": [
        "<string>"
      ],
      "cover_url": "<string>",
      "source": "<string>",
      "base_model": "<string>",
      "base_model_type": "<string>",
      "download_url_ttl": 123,
      "sd_name_in_api": "<string>"
    }
  ],
  "pagination": {
    "next_cursor": "<string>"
  }
}
This API endpoint is designed to retrieve information on both public and private models. It allows users to access details such as model specifications, status, and usage guidelines, ensuring comprehensive insights into the available modeling resources.

​
Request Headers

​
Content-Type
string
required
Enum: application/json
​
Authorization
string
required
Bearer authentication format, for example: Bearer {{API Key}}.

​
Query Parameters

​
filter.visibility
string
Model types: public or private. If not set, the interface will query all types of models.
​
filter.source
string
Source of the model.
Enum: civitai, training, uploading
​
filter.types
string
Specifies the types of models to include in the query.
Enum: checkpoint, lora, vae, controlnet, upscaler, textualinversion
​
filter.is_sdxl
boolean
Whether the model is SDXL or not. Setting this parameter to true includes only SDXL models in the query results, which are typically large-scale, high-performance models designed for extensive data processing tasks. Conversely, setting it to false excludes these models from the results. If left unspecified, the filter will not discriminate based on the SDXL classification, including all model types in the search results.
​
filter.query
string
Searches the content of sd_name, name, and tags.
​
filter.is_inpainting
boolean
If set to true, it will filter out the checkpoints used for inpainting. The default is false.
​
pagination.limit
string
Number of models to query per request, range (0, 100].
​
pagination.cursor
string
pagination.cursor is used to specify which record to start returning from. If it is empty, it means to get it from the beginning. Generally, the content of the next page is obtained by passing in the next_cursor field value from the response packet.

​
Response

​
models
object[]
​
pagination
object

​
Example

request 
curl --location 'https://api.novita.ai/v3/model?filter.visibility=public&pagination.limit=2&pagination.cursor=c_0' \
--header 'Authorization: Bearer {{API Key}}'
response 
{
  "models": [
    {
      "id": 114600,
      "name": "V4.0-inpainting (VAE)",
      "hash_sha256": "1A805277C8",
      "sd_name": "realisticVisionV40_v40VAE-inpainting_81543.safetensors",
      "type": {
        "name": "checkpoint",
        "display_name": "Checkpoint"
      },
      "categories": [],
      "status": 1,
      "tags": [
        "photorealistic",
        "anatomical",
        "base model",
        "cgi",
        "realistic",
        "semi-realistic"
      ],
      "cover_url": "https://next-app-static.s3.amazonaws.com/images-prod/xG1nkqKTMzGDvpLrqFT7WA/f291a219-4a86-45ab-96eb-c53446b3e4df/width=450/1495044.jpeg",
      "base_model": "SD 1.5",
      "base_model_type": "Inpainting",
      "download_url_ttl": 2592000,
      "sd_name_in_api": "realisticVisionV40_v40VAE-inpainting_81543.safetensors",
      "is_sdxl": false
    },
    {
      "id": 55199,
      "name": "beta2",
      "hash_sha256": "BA43B0EFEE",
      "sd_name": "GoodHands-beta2_39807.safetensors",
      "type": {
        "name": "locon",
        "display_name": "locon"
      },
      "categories": [],
      "status": 1,
      "tags": ["photorealistic", "concept", "hands"],
      "cover_url": "https://next-app-static.s3.amazonaws.com/images-prod/xG1nkqKTMzGDvpLrqFT7WA/031a378c-3d66-45da-5d67-966c47cd4800/width=450/599083.jpeg",
      "base_model": "SD 1.5",
      "base_model_type": "Standard",
      "download_url_ttl": 2592000,
      "sd_name_in_api": "GoodHands-beta2_39807",
      "is_sdxl": false
    }
  ],
  "pagination": {
    "next_cursor": "c_WzgwNDY2NiwiNTUxOTkiXQ=="
  }
}