Skip to main content
Reads one document in full: the document itself, the folder it lives in, the status of its latest generation, and the tickets a reader sees in the app. Each ticket’s body is the markdown implementation spec — that is the work you are being asked to do. Get a documentId from list_documents. For the typical read-then-implement loop, see the agent workflow guide.

Input

string (uuid)
required
Id of the document to read, as returned by list_documents.

Output

object
required
object
The folder holding the document. null when the document is not in a folder.
object
Status of the document’s latest generation. null when nothing has been generated yet.
object[]
required

Notes

  • Tickets that are hidden, deleted, or merged into another ticket are left out, so the list matches what a person sees in the app. The rest are returned in the app’s own order.
  • A ticket’s body can come back empty when the document is read in a compact form. When that happens, read the ticket with get_ticket to get the full spec rather than treating it as an empty ticket.
  • A document outside the bound workspace reads as not found, even if your user account can otherwise reach it — for example a document shared with you from another workspace. Resolve those with a share link instead.
  • imageCount above zero means the person marked up real UI screenshots while recording. Fetch them with get_ticket_images and read them as part of the spec.