Skip to main content
POST
papers.search-filtered

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
query
string

Academic text to search for.

mode
enum<string>
default:keyword

Keyword or meaning-based search; default keyword.

Available options:
keyword,
semantic
rerank
boolean
default:false

Request an extra relevance pass; costs up to USD 0.002 per page.

doi
string

Public DOI, for example 10.5555/example-paper.

Required string length: 1 - 512
authorOrcid
string

Public ORCID identifying an academic author.

Required string length: 1 - 64
institutionRor
string

Public ROR identifier for a research institution.

Required string length: 1 - 64
venueIssn
string

Public ISSN identifying a journal.

Required string length: 1 - 9
Pattern: ^\d{4}-\d{3}[\dX]$
funderDoi
string

Public DOI, for example 10.5555/example-paper.

Required string length: 1 - 512
language
string

Two-letter publication language.

Required string length: 1 - 2
Pattern: ^[a-z]{2}$
openAccess
boolean

Require public access, or require closed access.

minCitationCount
integer

Minimum number of citations.

Required range: 0 <= x <= 9007199254740991
fromYear
integer

First publication year, inclusive.

Required range: 1000 <= x <= 3000
toYear
integer

Last publication year, inclusive.

Required range: 1000 <= x <= 3000
types
enum<string>[]

Publication formats to include.

Required array length: 1 - 12 elements
Available options:
article,
review,
conference-paper,
book,
book-chapter,
dataset,
preprint,
report,
thesis,
editorial,
letter,
other
fromDate
string

Publication date, YYYY-MM-DD.

Required string length: 1 - 10
Pattern: ^\d{4}-\d{2}-\d{2}$
toDate
string

Publication date, YYYY-MM-DD.

Required string length: 1 - 10
Pattern: ^\d{4}-\d{2}-\d{2}$
limit
number

Maximum rows, 1 to 50; default 10.

Required range: x >= 1
cursor
string

Opaque continuation from the previous page; keep all filters unchanged.

Required string length: 1 - 8192

Response

The result

results
object[]
required

The matching items.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.