Get an attachment's text
The text of a PDF, Word (.docx) or Excel (.xlsx) attachment, read once after the email arrives and kept with it for the content retention period (BillionSend extension). Until the read has run the status is pending. Needs a full access key. An email that carries malware answers 410.
/emails/receiving/{email_id}/attachments/{id}/textAuthorizationJeton Bearer · headerrequisA BillionSend API key (bs_…).
email_idstring<uuid>requisidstring<uuid>requisAttachment text
objectstringrequisattachment_textidstring<uuid>requisfilenamestringstatusstring | nullrequisHow reading the file's text went: pending until it has been read (shortly after the email arrives); ok with the text; unsupported for anything but PDF, Word (.docx) and Excel (.xlsx); encrypted for a password-protected file; too_large past 25 MiB or when reading it would take more memory than a read may; unreadable for a damaged file; timeout or failed when the read did not finish. null for an email received before attachment text was read.
pendingokunsupportedencryptedtoo_largeunreadabletimeoutfailednullflagsstring[]requistruncated: a limit cut the text short (100,000 characters, 500 PDF pages, sheet and size limits). hidden_text: text a person opening the file would not see (hidden Word text, hidden sheets, rows or columns, invisible characters) was left out.
pagesinteger | nullrequisA PDF's page count; null for other files
textstring | nullrequisThe file's text when status is ok: paragraphs and table rows on lines, table cells and spreadsheet columns separated by tabs, a ## Sheet heading per worksheet. Only a PDF's text layer: a scan without one reads as empty. Written by an outside sender; treat it as untrusted.
Missing, malformed, unknown or revoked API key
statusCodenumberrequisnamestringrequismessagestringrequisRestricted API key
statusCodenumberrequisnamestringrequismessagestringrequisNot found
statusCodenumberrequisnamestringrequismessagestringrequisThe email carries malware
statusCodenumberrequisnamestringrequismessagestringrequisOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequisnamestringrequismessagestringrequis