Skip to main content
POST
papers.snippets.search

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
required

Academic text to search for.

paperDois
string[]

Public paper DOIs to restrict the excerpts to.

Required array length: 1 - 5 elements

Public DOI, for example 10.5555/example-paper.

Required string length: 1 - 512
authorNames
string[]

Author names to match approximately; all names must match.

Required array length: 1 - 10 elements
Required string length: 1 - 256
Pattern: ^[^,]+$
venues
string[]

Venue names to include.

Required array length: 1 - 10 elements
Required string length: 1 - 256
Pattern: ^[^,]+$
fieldsOfStudy
enum<string>[]

Academic fields to include.

Required array length: 1 - 10 elements
Available options:
Computer Science,
Medicine,
Chemistry,
Biology,
Materials Science,
Physics,
Geology,
Psychology,
Art,
History,
Geography,
Sociology,
Business,
Political Science,
Economics,
Philosophy,
Mathematics,
Engineering,
Environmental Science,
Agricultural and Food Sciences,
Education,
Law,
Linguistics
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 excerpts, 1 to 20; default 10.

Required range: x >= 1

Response

The result

results
object[]
required

The matching items.

nextCursor
string

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