/pubpeer/publications

POST /api/pubpeer/publications

Price: 5 credits

Get a PubPeer publication by its id or URL, with the complete post-publication comment thread — every comment's text, pseudonymous author, moderation history and author-response flag — alongside the paper's title, abstract, DOI, PMID, authors and journals

How to use it

Read the criticism attached to a published paper. The whole thread comes back in one call, so `comments` is the complete discussion and `comment_count` matches its length. `text` is the comment body, `is_from_author` marks a reply by an author of the paper, and `updates` records later edits — a comment edited after posting is common and the original wording is not kept. Commenters are pseudonymous, so `author_name` is a chosen alias and not a real identity. The only accepted input is a PubPeer publication id or URL: a DOI or PMID cannot be looked up here, though the record returns both once resolved.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• publication string required — PubPeer publication id — the 30-character code in a pubpeer.com URL, or the word slug a small number of records carry there instead — or the URL itself (examples: "5B3E65CD87EB4605DB235BB179F4C5", "https://pubpeer.com/publications/5B3E65CD87EB4605DB235BB179F4C5"; minLength: 1)

Response

• @type string (default: "PubpeerPublication")
• id string required
• url string nullable
• abstract string nullable
• doi string nullable
• pmid string nullable
• source_url string nullable
• published_year integer nullable
• comment_count integer nullable
• has_author_response boolean nullable
• journal_has_team boolean nullable
• acknowledged_by string nullable
• created_at integer nullable
• updated_at integer nullable
• last_commented_at integer nullable
• authors array (default: [])
  • @type string (default: "PubpeerAuthor")
  • id string required
  • display_name string nullable
  • first_name string nullable
  • last_name string nullable
  • email string nullable
  • orcid string nullable
  • affiliations array (default: [])
• journals array (default: [])
  • @type string (default: "PubpeerPublicationJournal")
  • id string required
  • issn string nullable
• comments array (default: [])
  • @type string (default: "PubpeerComment")
  • id string required
  • position integer nullable
  • text string nullable
  • author_name string nullable
  • author_alias string nullable
  • author_status string nullable
  • is_author_verified boolean nullable
  • is_from_author boolean nullable
  • is_accepted boolean nullable
  • is_visible boolean nullable
  • is_important boolean nullable
  • is_disabled boolean nullable
  • accepted_at integer nullable
  • selected_at integer nullable
  • url string nullable
  • updates array (default: [])
    • @type string (default: "PubpeerCommentUpdate")
    • action string required
    • created_at integer nullable
    • author_name 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 — No PubPeer publication has that id 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.