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

Relationship snapshots are built from stakeholder graph resources and related interaction artifacts. Persisted maps use the stakeholder_maps catalog and stakeholder_map patch kind on /v1/resources/.... The dashboard module path may still use /stakeholders for UI routes; HTTP for live graphs is on the spine.
Stakeholder routes are workspace-scoped and brain-scoped. Send X-Brain-Id or configure a default brain.

​
Live stakeholders graph

GET /v1/resources/stakeholder_maps/live
Optional query parameters:
  • stakeholder_limit
  • interaction_limit
Response includes:
  • stakeholders
  • interactions
  • edges
  • risks
  • summary

​
Diff two states (live or version)

GET /v1/resources/stakeholder_maps/diff?from=live&to=3
  • from and to: each is live or a positive integer version string.
  • Optional resource_id (UUID): scope stored versions to that stakeholder_map head; when omitted, the server resolves versions against the default map head for the brain.
Optional: stakeholder_limit, interaction_limit.

​
Saved maps (resource spine)

  • List / create heads: GET / POST /v1/resources/stakeholder_maps
  • Read head: GET /v1/resources/stakeholder_maps/:resourceId
  • History metadata: GET /v1/resources/stakeholder_maps/:resourceId/history
  • Body at version N: GET /v1/resources/stakeholder_maps/:resourceId/versions/:version
  • Record a new version from the live graph or DSL: POST /v1/resources/stakeholder_map/:resourceId/patch with patch_mode: stakeholder_map_record_version

​
Get a stakeholder briefing

GET /v1/stakeholders/briefing/:id
Returns one stakeholder, recent interactions, alliances, tensions, and suggested discussion points. id is the stakeholder document UUID.

​
Example

const map = await auvy.synapse.resources.stakeholderMaps.live()
const diff = await auvy.synapse.resources.stakeholderMaps.diff({
  from: 'live',
  to: '2',
  resource_id: '…uuid…',
})
const briefing = await auvy.stakeholders.getBriefing('stakeholder-uuid')
getMap() on AUVYPrivateClient.stakeholders is a typed alias for GET /v1/resources/stakeholder_maps/live.