Skip to main content
API reference sections

Schema

DocumentLocation

GET /v1/documents/{id}/location.

A document id is globally unique, but opening it still needs the profile and workspace which own it. Legacy Koru pills predate routed references and carry only this id; this response lets a client upgrade that old reference at the boundary where the authoritative catalog lives.

Type object

Shape

FieldTypeDescription
profilerequiredProfileId
workspacerequiredWorkspaceId
documentrequiredDocumentId

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

Example
{
  "profile": "00000000-0000-4000-8000-000000000000",
  "workspace": "00000000-0000-4000-8000-000000000000",
  "document": "00000000-0000-4000-8000-000000000000"
}

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

Used by

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.