Sign in

v2

latestOpenAPI 3.1.02026-07-2664759910.6 KB
external
external-v2

Answer Question About Attachment

Ask one focused question about a single attachment by kind and ID. Use attachment_kind and attachment_id returned in note attachment metadata.

post/v2/attachments/answer-question

Request body

attachment_idstring uuid required

UUID of the attachment to inspect. 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
questionstring required

Focused question to answer using only this attachment. Maximum: 10,000 characters (and no more than 10,000 UTF-8 bytes).

Response

OK

answerstring required
attachment_idstring uuid required
attachment_kind'pdf' | 'image' | 'audio_recording' | 'calendar_event' | 'email' required
page_referencesinteger[]
request_idstring required

Example response

{
  "answer": "The document lists launch readiness, pricing, and support milestones.",
  "attachment_id": "2511691e-cfd2-47bc-a4b6-0104234ee1af",
  "attachment_kind": "pdf",
  "page_references": [
    1,
    3
  ],
  "request_id": "api-request-036ed6c7-de00-459f-a89b-43d26aafe522"
}