> ## Documentation Index
> Fetch the complete documentation index at: https://docs.openmail.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Extract attachment text

> Extracts and returns the plain text content of an attachment. Supports PDF, DOCX, XLSX, PPTX, images (via OCR), and other common formats. The result is cached on the message after the first extraction.



## OpenAPI

````yaml https://api.openmail.sh/openapi.json get /v1/attachments/{messageId}/{filename}/text
openapi: 3.0.3
info:
  title: OpenMail API
  description: >-
    Email infrastructure API for AI agents. Create inboxes, send and receive
    email, and get real-time notifications via webhooks.
  version: 1.0.0
  license:
    name: Proprietary
servers:
  - url: https://api.openmail.sh
security:
  - bearerAuth: []
tags:
  - name: pods
    description: Isolated sub-accounts for your end users or tenants
  - name: inboxes
    description: Email inboxes and their webhook configuration
  - name: domains
    description: >-
      Custom domains: add your own sending/receiving domain, publish DNS, and
      verify it
  - name: owned-domains
    description: >-
      Domains your organisation controls but does not send from. Prove ownership
      with one TXT record and mail to their addresses stops counting toward the
      cold outreach limits.
  - name: messages
    description: Sending and listing messages
  - name: drafts
    description: Create, view, edit and send saved email drafts
  - name: threads
    description: Conversation threads and read status
  - name: attachments
    description: Downloading and extracting text from attachments
  - name: policy
    description: >-
      Correspondent policy — provider-enforced allow/block rules and allowlist
      mode, scoped per account, pod, or inbox. Account-wide key only.
  - name: limits
    description: >-
      Sending limits: today's cold outreach caps on new recipients, per account,
      inbox, and domain, and what raises them
  - name: webhooks
    description: >-
      Webhook endpoints: where events are sent, how each request is
      authenticated, and the delivery log. Account-wide key only.
  - name: feedback
    description: Reporting bugs, friction, and feature requests to the OpenMail team
paths:
  /v1/attachments/{messageId}/{filename}/text:
    get:
      tags:
        - attachments
      summary: Extract attachment text
      description: >-
        Extracts and returns the plain text content of an attachment. Supports
        PDF, DOCX, XLSX, PPTX, images (via OCR), and other common formats. The
        result is cached on the message after the first extraction.
      operationId: getAttachmentText
      parameters:
        - schema:
            type: string
          in: path
          name: messageId
          required: true
        - schema:
            type: string
          in: path
          name: filename
          required: true
          description: >-
            Use attachments[].id to select a specific file. A legacy filename
            selects the first exact match.
      responses:
        '200':
          description: Extracted text content
          content:
            application/json:
              schema:
                description: Extracted text content
                type: object
                additionalProperties: true
                properties:
                  filename:
                    type: string
                  inboxId:
                    type: string
                    description: Inbox the parent message belongs to
                  contentType:
                    type: string
                  extractionMethod:
                    type: string
                    description: Method used to extract text (e.g. pdf, docx, ocr)
                  text:
                    type: string
        '404':
          description: Attachment not found
          content:
            application/json:
              schema:
                description: Attachment not found
                allOf:
                  - $ref: '#/components/schemas/Error'
        '422':
          description: Text could not be extracted from the attachment
          content:
            application/json:
              schema:
                description: Text could not be extracted from the attachment
                allOf:
                  - $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      additionalProperties: true
      properties:
        error:
          type: string
        message:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.