Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Path Parameters

id
required

Unique attachment identifier

Pattern: ^[0-9a-z]+$

Response

200 - application/json

OK

Text extracted from a PDF, DOCX, or plain-text attachment

id
string
required

Unique identifier of the attachment

Pattern: ^[cC][^\s-]{8,}$
filename
string
required

Original filename of the attachment

mimeType
string
required

Declared MIME type of the attachment

status
enum<string>
required

Outcome of extraction. EXTRACTED: text holds the content (possibly an empty string — a scanned PDF with no text layer extracts to nothing). UNSUPPORTED: no extractor for this file type; only PDF, DOCX, and plain-text formats are supported. FAILED: the bytes could not be parsed (malformed, encrypted, or too large). UNSUPPORTED and FAILED are final — the file never changes, so retrying returns the same answer. PENDING is never returned; it is the pre-extraction state of the stored row.

Available options:
PENDING,
EXTRACTED,
UNSUPPORTED,
FAILED
text
string | null
required

Extracted plain text, or null unless status is EXTRACTED. Truncated at 1,000,000 characters. Extracted once and cached, so repeat reads are free.