Skip to main content
API reference sections

Schema

AttributeRow

One matching node. The identity is (workspace, document, node), carried together - never a node id on its own.

Type object

Shape

FieldTypeDescription
workspacerequiredWorkspaceId
documentrequiredDocumentId

DocumentId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path.

noderequiredstring

The node id, meaningful only inside document.

node_kindrequiredstring

The node's kind token - paragraph, task, image.

excerptrequiredstring

The node's text, truncated to a bounded number of characters - characters, never bytes, so no language is cut mid-glyph.

document_titlerequiredstring

The source document's title, from the workspace listing.

trashedrequiredboolean

Whether the source document sits in the trash, inherited down the document tree - a child of a binned parent carries no stamp of its own. Trashed rows are flagged, never hidden: restore must be able to find them.

attributesrequiredarray of AttributeRowValue

Every attribute on the node - not only the ones the filter named, so a row can be drawn without a second request.

Example
{
  "workspace": "00000000-0000-4000-8000-000000000000",
  "document": "00000000-0000-4000-8000-000000000000",
  "node": "string",
  "node_kind": "string",
  "excerpt": "string",
  "document_title": "string",
  "trashed": false,
  "attributes": [
    {
      "id": "string",
      "role": "string",
      "kind": "string",
      "value": "string",
      "zone": "string",
      "label": "string"
    }
  ]
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Generated from contract version 1. Last updated .

Privacy choices

Choose which optional tools Koru may use on this site. Your choice is saved in a cookie in this browser for 12 months. Privacy policy

Privacy choices

Keep you signed in, protect forms and remember your language and this choice.

Always on

PostHog and Google Analytics 4 measure page views and actions such as downloads, using cookies or local storage.

PostHog records how pages are used, with form inputs masked and private pages excluded. Needs Analytics.

Ahrefs Web Analytics measures visits and where they come from, and Google Ads measures whether our ads led to a visit or download.