/huggingface/discussions

POST /api/huggingface/discussions

Price: 1 credit

Get a single Hugging Face repo discussion or pull request by number, with comments

How to use it

Get a single discussion or pull request on a Hugging Face model, dataset, or Space repo by its number. Returns title, status, opening text, author, the full comment thread, and (for pull requests) the diff URL.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• repo string required — Repository id ('org/name') the discussion belongs to (examples: "google-bert/bert-base-uncased"; minLength: 1)
• num integer required — Discussion or pull request number (min: 1)
• repo_type string — Repository type (default: "model"; one of: "model", "dataset", "space")

Response

• @type string (default: "HuggingfaceDiscussionDetail")
• num integer required
• url string required
• status string nullable
• is_pull_request boolean (default: false)
• is_locked boolean (default: false)
• is_pinned boolean (default: false)
• created_at string nullable
• repo_id string nullable
• repo_type string nullable
• text string nullable
• diff_url string nullable
• author object nullable
  • @type string (default: "HuggingfaceDiscussionAuthor")
  • alias string required
  • fullname string nullable
  • type string nullable
  • image string nullable
  • is_pro boolean (default: false)
  • follower_count integer nullable
• comments array (default: [])
  • @type string (default: "HuggingfaceDiscussionComment")
  • text string nullable
  • created_at string nullable
  • reaction_count integer nullable
  • author object nullable
    • @type string (default: "HuggingfaceDiscussionAuthor")
    • alias string required
    • fullname string nullable
    • type string nullable
    • image string nullable
    • is_pro boolean (default: false)
    • follower_count 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 — Discussion 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.