Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.auvy.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Stakeholders API

Stakeholder graphs live on the stakeholder_map structured-object resource kind (resource_versions + resource_content = timeline; resource_chunks = full snapshot text per version). People and edges are embedded in the versioned body (snapshot.stakeholders[], snapshot.edges[]) — not separate document-lane vault rows.
Stakeholder routes are workspace-scoped and brain-scoped. Send X-Brain-Id or configure a default brain.

​
Latest map (head alias)

GET /v1/resources/stakeholder_maps/live
Optional query parameters:
  • resource_id — scope to a specific map head; otherwise the default map for the brain
Returns the same payload as reading the catalog head or the latest stored version body.

​
Diff two states (live or version)

GET /v1/resources/stakeholder_maps/diff?from=live&to=3
  • from and to: each is live (latest head) or a positive integer version number.
  • Optional resource_id (UUID): scope stored versions to that stakeholder_map head.

​
Saved maps (resource spine)

  • List / create heads: GET / POST /v1/resources/stakeholder_maps
  • Read head: GET /v1/resources/stakeholder_maps/:resourceId
  • History: GET /v1/resources/stakeholder_maps/:resourceId/history
  • Body at version N: GET /v1/resources/stakeholder_maps/:resourceId/versions/:version
  • Record a new version (delta required): POST /v1/resources/stakeholder_map/:resourceId/patch with:
{
  "patch_mode": "stakeholder_map_record_version",
  "delta": {
    "add_nodes": { "nodes": [{ "id": "jane", "label": "Jane Sponsor" }] },
    "add_edges": {
      "edges": [{ "source": "jane", "target": "alex", "edge_type": "sponsors" }]
    }
  },
  "change_summary": "Brought Jane on as executive sponsor and clarified her backing for Alex on the program."
}
Each patch appends resource_versions row N+1, updates the head, and rewrites resource_chunks for that version_id (full snapshot text, split for grep/RAG).

​
Per-node briefing

GET /v1/stakeholders/briefing/:id
  • id — short node id from the map snapshot (e.g. jane), not a vault resource UUID.
  • Optional resource_id — map head to read (default: brain’s default map).
Returns the node, recent interactions linked in the snapshot, alliances/tensions from snapshot edges, and suggested discussion points.

​
Example

const map = await auvy.synapse.resources.stakeholderMaps.get(resourceId)
const live = await auvy.synapse.resources.stakeholderMaps.live({ resource_id: resourceId })
const diff = await auvy.synapse.resources.stakeholderMaps.diff({
  from: 'live',
  to: '2',
  resource_id: resourceId,
})
const briefing = await auvyPrivateClient.stakeholders.getBriefing('jane', {
  resource_id: resourceId,
})