Documentation
Product GuideREST API ReferenceMCP Server for AI AgentsWebhooks & EventsIntegrations
READ

get_document

Fetches one generated document by id with its kind, reference, title, format, status, scope, opening prose, stamps and download address, and on request the rendered document as plain words.

Read one document in full. Beside the row list_documents gives (kind, reference, title, format, status, scope, the opening prose as summary, size and checksum, version, the approval stamps, who rendered it and when, when it became final, superseded_by_id, render_failure and download_url), pass with_text true to receive text: the rendered document as plain words, up to 60,000 characters, so you read a BRD or an SRS without downloading it. An HTML document answers with its markup stripped and its lines kept; a PDF answers with its opening prose only, since the file is laid out for paper, so ask the team for an HTML copy when you need the whole SRS. A client guest's token reads final and superseded copies only; a draft it asks for is unknown rather than forbidden.

Requires ability

document:view

The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.

Annotations

Read-only

It reads and never changes anything.

Arguments

document_id*string

UUID of the document to fetch.

with_textbooleanoptional

True to include the rendered document as plain words.

What it returns

{  "data": {    "id": "d4e5f6a7-b8c9-4d0e-8f1a-2b3c4d5e6f70",    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",    "kind": "srs",    "reference": "SRS #1",    "number": 1,    "title": "Software Requirements Specification",    "format": "html",    "status": "draft",    "editable": true,    "readable": true,    "scope": { "baseline_id": null, "drafts": false },    "summary": "The team builds the Customer Portal against this specification.",    "size": 183204,    "checksum": "2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae",    "version": 0,    "approved_at": null,    "approved_revision_id": null,    "rendered_by": "3f8a1c2e-7b4d-4e5f-9a6b-1c2d3e4f5a6b",    "renderer_name": "Bea Analyst",    "rendered_at": "2026-11-03T08:05:00+00:00",    "finalised_at": null,    "superseded_by_id": null,    "render_failure": null,    "download_url": "https://api.example.test/v1/documents/d4e5f6a7-b8c9-4d0e-8f1a-2b3c4d5e6f70/download",    "created_at": "2026-11-03T08:00:00+00:00",    "updated_at": "2026-11-03T08:05:00+00:00",    "text": "Software Requirements Specification\nCustomer Portal (CRM)\n\n1. Introduction\nThe team builds the Customer Portal against this specification.\n\n3. Functional requirements\nCRM-FR-12 Password reset by email …"  }}

How it fails

RESOURCE_NOT_FOUND

unknown document_id, a document of a project outside the token's scope, or, for a client guest's token, a document that is not final or superseded.

FORBIDDEN

the holder's role on the project does not carry document:view.

TOKEN_MISSING_ABILITY

token lacks document:view.

Related

list_documentsthe project's documents with their statuses.generate_documentask for a fresh copy when the record moved on.get_work_itemthe same record, story by story, for the work in hand.Documents APIthe same read over REST, and the file's bytes.

How is this guide?

Last updated on