Read Attachment

Read structured content for a single attachment by kind and ID. Use attachment_kind and attachment_id returned in note attachment metadata.

Request body

attachment_idstring uuid required

UUID of the attachment to read. For note attachment metadata returned by GET /v2/notes/{note_id}, pass the attachment_id value directly.

attachment_kind'pdf' | 'image' | 'audio_recording' | 'calendar_event' | 'email' required

content_limitinteger nullable

Maximum content characters to return. Defaults to 10,000 and is capped at 20,000.

content_offsetinteger

Zero-based character offset for audio, calendar, and email content.

page_limitinteger nullable

Maximum number of PDF pages to return. Defaults to 5 and is capped at 20.

page_offsetinteger

Zero-based page offset for PDF attachments.

Response

OK

attachment_idstring uuid required

attachment_kind'pdf' | 'image' | 'audio_recording' | 'calendar_event' | 'email' required

request_idstring required

Example response

{
  "attachment_id": "2511691e-cfd2-47bc-a4b6-0104234ee1af",
  "attachment_kind": "pdf",
  "audio_recording": null,
  "calendar_event": null,
  "email": null,
  "image": null,
  "pdf": {
    "filename": "product-spec.pdf",
    "has_more": true,
    "mime_type": "application/pdf",
    "page_count": 7,
    "page_limit": 5,
    "page_offset": 0,
    "pages": [
      {
        "key_entities": [
          "Launch"
        ],
        "page_number": 1,
        "plain_text": "Launch requirements...",
        "suggested_search": "launch requirements",
        "summary": "Overview of launch requirements."
      }
    ],
    "suggested_search": "product launch requirements",
    "summary": "Product requirements and launch milestones."
  },
  "request_id": "api-request-036ed6c7-de00-459f-a89b-43d26aafe522"
}