/civitai/models

POST /api/civitai/models

Price: 1 credit

Get Civitai model details by id or URL

How to use it

Get full details of a Civitai AI model by numeric id or model URL. Returns name, description, type, base models, license flags, download/thumbs stats, creator, tags, and all model versions with their files (weights, hashes, size, format), trained words, and preview images.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• model string required — Model id or model URL (examples: "257749", "https://civitai.com/models/257749/pony-diffusion-v6-xl"; minLength: 1)

Response

• @type string (default: "CivitaiModel")
• id integer required
• name string nullable
• description string nullable
• model_type string nullable
• is_nsfw boolean (default: false)
• nsfw_level integer nullable
• is_minor boolean (default: false)
• is_sfw_only boolean (default: false)
• is_poi boolean (default: false)
• availability string nullable
• user_id integer nullable
• base_models array (default: [])
• supports_generation boolean (default: false)
• allow_no_credit boolean (default: false)
• allow_commercial_use array (default: [])
• allow_derivatives boolean (default: false)
• allow_different_license boolean (default: false)
• cosmetic object nullable
• download_count integer nullable
• thumbs_up_count integer nullable
• thumbs_down_count integer nullable
• comment_count integer nullable
• tipped_amount_count number nullable
• creator object nullable
  • @type string (default: "CivitaiCreator")
  • username string nullable
  • image string nullable
• tags array (default: [])
• model_versions array (default: [])
  • @type string (default: "CivitaiModelVersion")
  • id integer required
  • index integer nullable
  • name string nullable
  • base_model string nullable
  • base_model_type string nullable
  • created_at integer nullable
  • published_at integer nullable
  • status string nullable
  • availability string nullable
  • nsfw_level integer nullable
  • vae_id integer nullable
  • is_covered boolean (default: false)
  • trained_words array (default: [])
  • download_url string nullable
  • download_count integer nullable
  • thumbs_up_count integer nullable
  • thumbs_down_count integer nullable
  • files array (default: [])
    • @type string (default: "CivitaiModelFile")
    • id integer nullable
    • name string nullable
    • size_kb number nullable
    • file_type string nullable
    • pickle_scan_result string nullable
    • virus_scan_result string nullable
    • scanned_at integer nullable
    • file_format string nullable
    • fp string nullable
    • size_category string nullable
    • hashes object nullable
    • is_primary boolean (default: false)
    • download_url string nullable
  • images array (default: [])
    • @type string (default: "CivitaiModelVersionImage")
    • url string required
    • blur_hash string nullable
    • width integer nullable
    • height integer nullable
    • nsfw_level integer nullable
    • image_type string nullable
    • has_meta boolean (default: false)
    • remix_of_id integer nullable
• url string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Model not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.