Documents

Get the full contents (elements) of one tab, with its revision (`rev`, also the weak `ETag`): what a changeset base names.

get/documents/{id}/tabs/{tabId}

Request

  • Base URL: https://www.livediagram.app/api
  • URL: https://www.livediagram.app/api/documents/{id}/tabs/{tabId}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Owner-Id

Path parameters

idstring required
tabIdstring required

Query parameters

viewstring

A view instead of the plain read: outline, graph, layout, comments, show, find, pages, lint. lint (the diagram lint) takes only json.

jsonstring

1 answers the view as JSON (OutlineView, GraphView, …) instead of text.

budgetstring

Fit the view to this many tokens (characters ÷ 3), 1 to 1000000; what it leaves out is named on its last line.

doorstring

cli (default) or mcp: the syntax of the command the last line names.

onlystring

outline, layout: one element (a ref, unique prefix or id) and what nests under it.

coarsestring

layout: 1 for rows per container instead of geometry.

stylestring

outline: 1 adds the non-default style attributes.

refstring

show (required): the element, by ref, unique prefix or id.

qstring

find (required): the text to look for, 1 to 200 characters.

allstring

comments: 1 adds resolved threads.

Response

Success. With view: the tab as text, its first line the header with rev. A ref that names nothing is 404 target_not_found, several 400 target_ambiguous, each with candidates (RefErrorBody).

Changes

No recorded changes to this operation across all 1 revision of this API.