Skip to main content
POST
/
api
/
core
/
works
/
search
/core/works/search
curl --request POST \
  --url https://api.anysite.io/api/core/works/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "q": "<string>",
  "count": 2,
  "timeout": 300,
  "sort": "relevance"
}
'
[
  {
    "id": 123,
    "url": "<string>",
    "@type": "@core_work",
    "title": "<string>",
    "abstract": "<string>",
    "full_text": "<string>",
    "authors": [],
    "contributors": [],
    "doi": "<string>",
    "arxiv_id": "<string>",
    "mag_id": "<string>",
    "pubmed_id": "<string>",
    "oai_ids": [],
    "document_type": "<string>",
    "field_of_study": "<string>",
    "year_published": 123,
    "citation_count": 123,
    "language": "<string>",
    "publisher": "<string>",
    "download_url": "<string>",
    "identifiers": [],
    "data_providers": [],
    "output_urls": [],
    "source_fulltext_urls": [],
    "links": [],
    "journals": [],
    "references": [],
    "created_at": "<string>",
    "updated_at": "<string>",
    "accepted_at": "<string>",
    "deposited_at": "<string>",
    "published_at": "<string>"
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
q
string
required

Search query. Plain keywords, or Lucene syntax with fields (title, abstract, authors, doi, yearPublished, documentType, language, fieldOfStudy, dataProviders.id), boolean operators (AND/OR/NOT), and ranges (yearPublished>2020, yearPublished:[2018 TO 2022]). When scoping a text term to a field, quote or parenthesize it: title:"cancer" or title:(cancer) (a bare title:cancer matches nothing).

Minimum string length: 1
Examples:

"machine learning"

"title:\"cancer\" AND yearPublished>2020"

​
count
integer
required

Max result count

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
sort
enum<string>
default:relevance

Result ordering

Available options:
relevance,
recency,
citations_desc,
citations_asc,
year_desc,
year_asc

Response

Successful Response

​
id
integer
required
​
url
string
required
​
@type
string
default:@core_work
​
title
string | null
​
abstract
string | null
​
full_text
string | null
​
authors
CoreAuthor · object[]
​
contributors
string[]
​
doi
string | null
​
arxiv_id
string | null
​
mag_id
string | null
​
pubmed_id
string | null
​
oai_ids
string[]
​
document_type
string | null
​
field_of_study
string | null
​
year_published
integer | null
​
citation_count
integer | null
​
language
string | null
​
publisher
string | null
​
download_url
string | null
​
identifiers
CoreIdentifier · object[]
​
data_providers
CoreWorkDataProvider · object[]
​
output_urls
string[]
​
source_fulltext_urls
string[]
​
links
CoreWorkLink · object[]
​
journals
CoreWorkJournal · object[]
​
references
CoreWorkReference · object[]
​
created_at
string | null
​
updated_at
string | null
​
accepted_at
string | null
​
deposited_at
string | null
​
published_at
string | null