Read a letter
read_letterRead a photo of an old handwritten letter, postcard or document with FamilyLore: the transcription in its own script, a translation and notes on what it meant then. Use it when the person attaches a photo of a handwritten page and asks what it says. It reads pre-1918 Russian and Ukrainian cursive, German Kurrent and Sütterlin, Yiddish, and old English cursive. It needs the person's FamilyLore account and uses one page of the account's allowance. It starts the reading and answers at once with the page id; a reading takes about a minute and a half. If the photo can't be attached here, call it without one: it answers with a one-time link where the person sends the photo to FamilyLore, and the page id to pass to get_reading once they have.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| year | No | The year it was written, if the person knows it roughly (1912 for 'about 1912') | |
| photo | No | The photo of the page the person attached | |
| page_id | No | A page already on FamilyLore that hasn't been read, from FamilyLore's own photo upload | |
| language | No | The letter's language, if the person says it or it is plain: ru_uk = Russian or Ukrainian, de_kurrent = German (Kurrent or Sütterlin), yi = Yiddish, en = English (old cursive). Leave it out and FamilyLore tells. | |
| target_language | No | The language to translate it into: en (English), de (German), ru (Russian), pl (Polish), it (Italian), fr (French), uk (Ukrainian). English if left out. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | reading: started (about a minute and a half); read: the page already has its reading; waiting_for_photo: the person sends the photo at upload_link, then FamilyLore reads it | |
| page_id | Yes | The page's id on FamilyLore | |
| page_url | Yes | The page on familylore.ai, with the person's other pages | |
| allowance | No | Pages left, as the Account page counts them | |
| upload_link | No | waiting_for_photo: where the person sends the photo, once | |
| link_expires_at | No | When upload_link stops working (UTC) | |
| converted_from_heic | No | The photo was an iPhone HEIC, read as a JPEG |