Mailbox API

Request attachment text

Changed on

Extract readable text from an attachment up to 7500000 bytes, at no extra charge. Repeating this request reuses the same current source extraction for 24 hours; no request body or Idempotency-Key is needed. Conversion runs for at most 30 seconds. OCR is unavailable. Current mailbox access and the source attachment are checked before serving cached text. If extraction cannot complete, use the original attachment download.

post/mailbox/messages/{message_id}/attachments/{attachment_id}/text

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailbox/messages/{message_id}/attachments/{attachment_id}/text
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendmux.ai/oauth/authorize, token URL https://app.sendmux.ai/oauth/token, scopes: mailbox.read)

Path parameters

message_idstring required

Message ID in the selected mailbox.

attachment_idstring required

Attachment ID from that message.

Query parameters

max_bytesinteger

Maximum UTF-8 text bytes returned. Default 262144; maximum 1048576. Applies to cached results too.

mailbox_idstring

Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.

Response

Conversion completed. Check outcome before using text; original attachment downloads remain available.

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "id": "ext_example"
  }
}

Changes