/huggingface/papers/search

POST /api/huggingface/papers/search

Price: 10 credits

Search Hugging Face research papers

How to use it

Search Hugging Face research papers by keyword. Returns matching papers with title, summary, authors, upvotes, and AI-generated summary and keywords.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• q string required — Search keyword (examples: "attention transformer"; minLength: 1)
• count integer required — Max result count (min: 1)

Response

• @type string (default: "HuggingfacePaper")
• id string required
• url string required
• summary string nullable
• authors array (default: [])
  • @type string (default: "HuggingfacePaperAuthor")
  • name string required
  • alias string nullable
  • fullname string nullable
  • is_pro boolean (default: false)
  • image string nullable
• published_at string nullable
• upvote_count integer nullable
• comment_count integer nullable
• discussion_id string nullable
• ai_summary string nullable
• ai_summary_model string nullable
• ai_keywords array (default: [])
• project_page string nullable
• github_repo string nullable
• image string nullable
• submitted_by string nullable
• linked_models array (default: [])
  • @type string (default: "HuggingfaceLinkedRepo")
  • id string required
  • repo_type string nullable
  • author string nullable
  • download_count integer nullable
  • like_count integer nullable
  • pipeline_tag string nullable
  • gated union nullable
  • last_modified string nullable
  • parameter_count integer nullable
• linked_datasets array (default: [])
  • @type string (default: "HuggingfaceLinkedRepo")
  • id string required
  • repo_type string nullable
  • author string nullable
  • download_count integer nullable
  • like_count integer nullable
  • pipeline_tag string nullable
  • gated union nullable
  • last_modified string nullable
  • parameter_count integer nullable
• linked_spaces array (default: [])
  • @type string (default: "HuggingfaceLinkedSpace")
  • id string required
  • emoji string nullable
  • is_running boolean (default: false)
  • is_featured boolean (default: false)
• num_total_models integer nullable
• num_total_datasets integer nullable
• num_total_spaces integer 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.