Cite numbers or phrases from a public document by page

A public document sent here is kept in our library, to be indexed and read into cited rows; a link on a file-sharing host or carrying a signature or token is read and never kept (kept says which, and why). Each find is located on the document's own page text, exactly as typed (a number as printed: 0.10 is not 0.1, a decimal comma reads as a point; spaces optional; any case; µg read as ug), and answered with every page it is printed on (n_hits, the first 5 with their quote and cite: page, address, the document's sha256, the day read). A find not printed on the pages read is in not_found. held_as names the instruments this server reads rows from when the document is one of them. PDFs, web pages and plain text up to 40 MiB; a scan with no text layer is refused (read.no_text).

get/cite

Request

  • Base URL: https://passage-data.com/api/v1
  • URL: https://passage-data.com/api/v1/cite
  • Auth: one of:
    • none
    • HTTP bearer
    • API key in header x-api-key

Query parameters

urlstring required

The document's public http(s) address.

findstring[] required

What to cite, as the document prints it; repeat for each (at most 10).

Response

Each find with its pages and quotes; or a refused block from reading the document (read.http_<status>, read.unreachable, read.private_host, read.kind_unread, read.no_text, read.damaged, read.failed, engine.timeout, engine.unreachable)

urlstring
final_urlstring
sha256string
bytesinteger
kind'pdf' | 'html' | 'text'
n_pagesinteger
titlestring
fetched_atstring
saysstring
held_asobject[]
nextstring

Changes

No recorded changes to this operation across all 1 revision of this API.