/kaggle/models/search

POST /api/kaggle/models/search

Price: 10 credits

Search Kaggle models by query

How to use it

Search Kaggle models by keyword. Returns each model's title, subtitle, author, license, provenance, vote count, publish and update times, thumbnail image, tags, and model instances.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Search query for models (examples: "bert", "gemma"; minLength: 1)
• count integer required — Number of models to return (min: 1)

Response

• @type string (default: "KaggleModel")
• id integer required
• ref string required
• alias string required
• subtitle string nullable
• description string nullable
• author string nullable
• license_name string nullable
• provenance string nullable
• vote_count integer (default: 0)
• is_private boolean (default: false)
• image string nullable
• web_url string nullable
• published_at string nullable
• updated_at string nullable
• tags array (default: [])
  • @type string (default: "KaggleTag")
  • ref string required
  • name string required
  • full_path string nullable
• instances array (default: [])
  • @type string (default: "KaggleModelInstance")
  • id integer required
  • slug string required
  • instance_type string nullable
  • framework string nullable
  • license_name string nullable
  • fine_tunable boolean (default: false)
  • overview string nullable
  • size_bytes integer (default: 0)
  • version_number integer nullable
  • web_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 — 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.