/huggingface/spaces/search

POST /api/huggingface/spaces/search

Price: 5 credits

Search Hugging Face Spaces

How to use it

Search Hugging Face Spaces by keyword, author, SDK, and tag filters. Sort by likes, last modified, created date, or trending score. Returns matching Spaces with SDK, likes, tags, and runtime details.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• search string nullable — Free-text search keyword (examples: "chatbot")
• author string nullable — Filter by author (org or user) (examples: "multimodalart")
• sdk string nullable — Filter by Space SDK (one of: "gradio", "streamlit", "docker", "static")
• filter array nullable — Tag filters (repeatable) (examples: ["text-to-image"])
• sort string nullable — Sort field (one of: "likes", "lastModified", "createdAt", "trendingScore")
• direction integer nullable — Sort direction: -1 descending, 1 ascending (min: -1; max: 1)
• full boolean — Include files in each result (default: false)
• count integer required — Max result count (min: 1)

Response

• @type string (default: "HuggingfaceSpace")
• id string required
• url string required
• author string nullable
• sha string nullable
• emoji string nullable
• sdk string nullable
• sdk_version string nullable
• license string nullable
• color_from string nullable
• color_to string nullable
• like_count integer nullable
• trending_score number nullable
• tags array (default: [])
• gated union nullable
• is_private boolean (default: false)
• is_disabled boolean (default: false)
• is_dev_mode boolean (default: false)
• subdomain string nullable
• host string nullable
• stage string nullable
• hardware string nullable
• requested_hardware string nullable
• replicas integer nullable
• py_spaces_version string nullable
• created_at string nullable
• last_modified string nullable
• used_storage integer nullable
• card_data object nullable
• models array (default: [])
• siblings array (default: [])

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.