/civitai/images/search

POST /api/civitai/images/search

Price: 5 credits

Search Civitai community images

How to use it

Search Civitai community-generated images by model id, model version id, creator username, or post id. Sort by reactions, comments, or recency. Returns image url, dimensions, base model, linked model versions, and reaction counts.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• model_id integer nullable — Filter by model id
• model_version_id integer nullable — Filter by model version id
• username string nullable — Filter by creator username (examples: "PurpleSmartAI")
• post_id integer nullable — Filter by post id
• nsfw string nullable — Maximum adult-content level to include (one of: "None", "Soft", "Mature", "X")
• sort string nullable — Sort order (one of: "Most Reactions", "Most Comments", "Most Collected", "Newest", "Oldest")
• period string nullable — Time window for popularity sorting (one of: "AllTime", "Year", "Month", "Week", "Day")
• count integer required — Max result count (min: 1)

Response

• @type string (default: "CivitaiImage")
• id integer required
• url string nullable
• blur_hash string nullable
• width integer nullable
• height integer nullable
• nsfw_level string nullable
• image_type string nullable
• is_nsfw boolean (default: false)
• browsing_level integer nullable
• created_at integer nullable
• post_id integer nullable
• username string nullable
• base_model string nullable
• model_version_ids array (default: [])
• cry_count integer nullable
• laugh_count integer nullable
• like_count integer nullable
• dislike_count integer nullable
• heart_count integer nullable
• comment_count integer nullable
• meta object 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 — The entity was not found, or a precondition failed 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.