Skip to main content
POST
email.message.clean

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
inbox
string
required

Owned mailbox address.

Required string length: 1 - 320
messageId
string
required

The public RFC Message-ID of the message.

Required string length: 1 - 998

Remove links.

cleanImages
boolean
default:true

Remove images.

imagesAsMarkdown
boolean
default:true

Represent retained images as Markdown.

cleanTables
boolean
default:true

Remove tables.

removeConclusionPhrases
boolean
default:true

Remove concluding phrases.

htmlAsMarkdown
boolean
default:false

Return Markdown rather than plain text.

Response

The result

text
string

Cleaned plain text, at most 100 KB.

Maximum string length: 100000
markdown
string

Cleaned Markdown, at most 100 KB.

Maximum string length: 100000