Get Item Scan
The envelope itself, as a PNG.
WITHOUT THIS THE STATION CANNOT BE USED. The page showed extracted fields and no envelope, so a transcriber had nothing to check them against and a correct read was indistinguishable from an invented one. Reading mail means looking at the mail.
PROXIED, NEVER LINKED. The scan lives behind a Google Storage signed URL that expires in about fifteen minutes, so a URL handed to the browser is a dead link by the time anybody clicks it, and storing one would leak a credential-bearing address into a page. Roost fetches it per request instead, which also keeps the scan behind Roost's own auth rather than behind a secret in a query string.
ONLY THE ENVELOPE. render_envelope_front returns page 1, the outside face, and never the letter, so there is no path from this endpoint to somebody's private correspondence.
Request
- Base URL: https://api.pigeonly.com (the document declares no server; this is the origin it was published from)
- URL: https://api.pigeonly.com/api/transcription/items/{item_id}/scan
- Auth: none declared
Path parameters
Response
Successful Response
Changes
No recorded changes to this operation across all 1 revision of this API.