Skip to content

// Generated from the OpenAPI schema

REST API

The dashboard backend serves 384 endpoints across 47 groups. Everything below is read from the running application’s own schema.

Method Path Summary
POST /api/agent/cancel/{session_id} Cancel Session
POST /api/agent/confirm/{session_id} Confirm Action
POST /api/agent/diff/{session_id}/{diff_id}/apply Apply Diff
POST /api/agent/diff/{session_id}/{diff_id}/reject Reject Diff
GET /api/agent/health Health
POST /api/agent/intake Run Intake
POST /api/agent/message Send Message
POST /api/agent/message/{message_id}/redact Redact Message
GET /api/agent/metrics Get Metrics
GET /api/agent/metrics/sessions Get Recent Sessions
GET /api/agent/sessions List Sessions
GET /api/agent/state/{session_id} Get State
POST /api/agent/stop/{session_id} Stop Turn
GET /api/agent/thread/current Get Current Thread
DELETE /api/agent/thread/{thread_id}/recall/{recalled_thread_id} Retract Recall
GET /api/agent/timeline Get Timeline
Method Path Summary
GET /api/alerts/ Get Alerts
POST /api/alerts/check Check Alerts
GET /api/alerts/rules Get Rules
GET /api/alerts/stats Get Alert Stats
POST /api/alerts/{alert_id}/acknowledge Acknowledge Alert
POST /api/alerts/{alert_id}/resolve Resolve Alert
Method Path Summary
GET /api/approvals List Pending Approvals
GET /api/approvals/history Get Approval History
GET /api/approvals/proposals List Pending Proposals
GET /api/approvals/{request_id} Get Approval Details
POST /api/approvals/{request_id}/approve Approve Request
POST /api/approvals/{request_id}/reject Reject Request
Method Path Summary
GET /api/audio/config Get Audio Config
POST /api/audio/config Update Audio Config
GET /api/audio/ingress/status Get Ingress Status
GET /api/audio/speakers List Speakers
POST /api/audio/speakers/enroll Enroll Speaker
DELETE /api/audio/speakers/{speaker_id} Delete Speaker
POST /api/audio/speakers/{speaker_id}/test Test Speaker
GET /api/audio/status Get Audio Status
Method Path Summary
GET /auth/enter Enter
POST /auth/logout Logout
GET /auth/status Auth Status
Method Path Summary
GET /api/backup/config Backup Config
GET /api/backup/history Backup History
POST /api/backup/inspect Backup Inspect
POST /api/backup/now Backup Now
POST /api/backup/restore Restore
Method Path Summary
GET /api/being/events Being Events
GET /api/being/events/recent Recent Events
POST /api/being/events/{event_id}/dismiss Dismiss Event
POST /api/being/events/{event_id}/snooze Snooze Event
GET /api/being/presence/held Presence Held
GET /api/being/presence/preview Presence Preview
GET /api/being/presence/rungs Presence Rungs
Method Path Summary
GET /api/compression/backends List Backends
POST /api/compression/compress Compress Text
GET /api/compression/config Get Config
POST /api/compression/config Update Config
GET /api/compression/status Get Status
POST /api/compression/test Test Compression
Method Path Summary
POST /api/compute/v1/chat/completions Peer Compute Chat
GET /api/compute/v1/health Peer Compute Health
GET /api/compute/v1/models Peer Compute Models
POST /compute/endpoint-probe Endpoint Probe
POST /compute/peer-probe Peer Probe
Method Path Summary
GET /api/containers/info Get Containers Data
GET /api/containers/{container_id}/logs Get Container Logs
POST /api/containers/{container_id}/remove Remove Container
POST /api/containers/{container_id}/restart Restart Container
POST /api/containers/{container_id}/start Start Container
POST /api/containers/{container_id}/stop Stop Container
Method Path Summary
GET /api/conversations/health Peer Conversation Health
POST /api/conversations/invoke Peer Conversation Invoke
Method Path Summary
GET /api/development/info Get Development Data
GET /api/development/languages Get Languages
GET /api/development/projects Get Projects
GET /api/development/tools Get Tools
Method Path Summary
GET /api/devices List Devices
PUT /api/devices/body-name Set Body Name
PUT /api/devices/entity-mode Set Entity Mode
PUT /api/devices/peer-token Set Peer Token
DELETE /api/devices/{node_id} Remove Device
PUT /api/devices/{node_id}/capabilities Set Device Capabilities
POST /api/devices/{node_id}/discover Discover Device Capabilities
PUT /api/devices/{node_id}/wol Toggle Device Wol
Method Path Summary
GET /api/discoveries/ List Discoveries
GET /api/discoveries/backup/statuses Get All Backup Statuses
GET /api/discoveries/backup/{backup_name}/history Get Backup History
GET /api/discoveries/backup/{backup_name}/logs Get Backup Logs
GET /api/discoveries/icon Get App Icon
GET /api/discoveries/learned/classifications Get Learned Classifications
DELETE /api/discoveries/learned/classifications/{name} Delete Learned Classification
POST /api/discoveries/learned/classify Save Learned Classification
POST /api/discoveries/learned/identify Identify Unknown Component
GET /api/discoveries/mentionables Get Mentionables
POST /api/discoveries/overview/{overview_type} Generate Overview
POST /api/discoveries/scan Trigger Scan
GET /api/discoveries/search Search Discoveries
GET /api/discoveries/stats Get Stats
GET /api/discoveries/{discovery_id} Get Discovery
Method Path Summary
GET /api/downloads/datasets List Datasets
DELETE /api/downloads/datasets/{dataset_id} Delete Dataset
GET /api/downloads/datasets/{dataset_id} Get Dataset
POST /api/downloads/datasets/{dataset_id}/cancel Cancel Download
POST /api/downloads/datasets/{dataset_id}/download Start Download
GET /api/downloads/datasets/{dataset_id}/status Get Download Status
Method Path Summary
POST /api/editor/backup Create Backup
POST /api/editor/backup/restore Restore Backup
GET /api/editor/backup/{backup_id}/content Get Backup Content
GET /api/editor/backups List Backups
GET /api/editor/file Read File
POST /api/editor/file Write File
DELETE /api/editor/session Delete Session
GET /api/editor/session Get Session
POST /api/editor/session Save Session
GET /api/editor/sessions/pending Get Pending Sessions
Method Path Summary
GET /api/entity/status Entity Status
Method Path Summary
GET /api/files/stat Stat Path
GET /api/files/surfaces Surfaces
GET /api/files/tree Tree
Method Path Summary
GET /api/findings List Findings
GET /api/findings/{finding_id} Get Finding
POST /api/findings/{finding_id}/propose Propose Fix
Method Path Summary
GET /api/fleet/nodes List Fleet Nodes
GET /api/fleet/{node_id}/discoveries Get Node Discoveries
GET /api/fleet/{node_id}/info Get Node Info
POST /api/fleet/{node_id}/inspect Inspect Node
GET /api/fleet/{node_id}/logs Stream Node Logs
GET /api/fleet/{node_id}/telemetry Get Node Telemetry
Method Path Summary
GET /api/frigate/cameras List Cameras
GET /api/frigate/config Get Frigate Config
POST /api/frigate/config Save Frigate Config Route
GET /api/frigate/events Get Events
GET /api/frigate/latest/{camera} Get Latest Frame
GET /api/frigate/reviews Get Reviews
GET /api/frigate/snapshot/{event_id} Get Snapshot
GET /api/frigate/status Frigate Status
Method Path Summary
GET /api/gpu/accelerators Get Accelerators
GET /api/gpu/analysis-cache Get Cached Analysis
POST /api/gpu/analyze Analyze Gpu Setup
GET /api/gpu/deep-context Get Deep Context
GET /api/gpu/info Get Gpu Data
GET /api/gpu/nvidia-smi Get Nvidia Smi
PUT /api/gpu/role/{pci_id} Update Gpu Role
Method Path Summary
GET /api/guest Guest Status
GET /api/guest/available Available Personas
POST /api/guest/become Become
POST /api/guest/end End Session
POST /api/guest/forget Forget Session
POST /api/guest/heartbeat Heartbeat
DELETE /api/guest/homes Forget Home
GET /api/guest/homes List Homes
POST /api/guest/homes Add Home
POST /api/guest/offer Offer Persona
POST /api/guest/private/assign Assign Private Source
POST /api/guest/private/release Release Private Source
GET /api/guest/private/sources List Private Sources
POST /api/guest/pull Pull Persona
POST /api/guest/withdraw Withdraw Persona
Method Path Summary
GET /api/health Health
Method Path Summary
GET /api/home/archetypes Get Archetypes
GET /api/home/areas Get Areas
GET /api/home/config Get Config
POST /api/home/config Save Config
GET /api/home/entities Get Entities
GET /api/home/entity/{entity_id} Get Entity
GET /api/home/hacs/info Get Hacs Info
POST /api/home/service Call Service
GET /api/home/status Home Status
POST /api/home/voice/speak Proactive Speak Api
GET /api/home/voice/status Get Voice Status
Method Path Summary
GET /api/identity Get Host Identity
Method Path Summary
GET /api/instance/info Get Instance Info
Method Path Summary
GET /api/jobs List Jobs
GET /api/jobs/{job_id} Get Job Details
POST /api/jobs/{job_id}/cancel Cancel Job
Method Path Summary
GET /api/legal/cloud-disclosure Get Cloud Disclosure
GET /api/legal/disclaimer Get Disclaimer
POST /api/legal/disclaimer/accept Accept Disclaimer
GET /api/legal/notices Get Notices
Method Path Summary
GET /api/llm/discover Discover Local Engines
POST /api/llm/proxy/models Proxy Models
POST /api/llm/proxy/test Proxy Test
POST /api/llm/proxy/test-model Proxy Test Model
GET /llm/config Get Llm Config
PUT /llm/config Update Llm Config
GET /llm/config/effective Get Effective Llm Config
Method Path Summary
POST /api/mcp/servers Mcp Add Server
DELETE /api/mcp/servers/{name} Mcp Remove Server
PUT /api/mcp/servers/{name}/risk Mcp Set Risk
GET /api/mcp/status Mcp Status
Method Path Summary
GET /api/memory/about-you About You
GET /api/memory/about-you/noticed About You Noticed
POST /api/memory/about-you/{memory_id}/forget About You Forget
POST /api/memory/about-you/{memory_id}/not-interested About You Not Interested
POST /api/memory/about-you/{memory_id}/remember-again About You Remember Again
POST /api/memory/about-you/{memory_id}/remember-this About You Remember This
POST /api/memory/about-you/{memory_id}/stop-using About You Stop Using
POST /api/memory/add Peer Memory Add
GET /api/memory/collections List Memory Collections
POST /api/memory/collections/{collection}/clear Clear Memory Collection
POST /api/memory/collections/{collection}/delete Delete Memory Entries
GET /api/memory/collections/{collection}/entries List Memory Entries
DELETE /api/memory/collections/{collection}/entries/{entry_id} Delete Memory Entry
GET /api/memory/collections/{collection}/entries/{entry_id} Get Memory Entry
DELETE /api/memory/delete/{memory_id} Peer Memory Delete
GET /api/memory/get/{memory_id} Peer Memory Get
GET /api/memory/index/stats Get Index Stats
POST /api/memory/query Query Memory Index
GET /api/memory/search Peer Memory Search
Method Path Summary
GET /api/modules List Modules
GET /api/modules/{module_name}/data Get Module Data
Method Path Summary
POST /api/peers/compute-peer Link Compute Peer
GET /api/peers/discovered List Discovered Peers
GET /api/peers/list List Peers
POST /api/peers/pair Request Pairing
GET /api/peers/pending List Pending Pairings
DELETE /api/peers/pending/{request_id} Reject Pairing
POST /api/peers/pending/{request_id}/approve Approve Pairing
POST /api/peers/register-canonical Register Canonical
POST /api/peers/sync-replica Receive Replica
POST /api/peers/verify Verify Pairing
DELETE /api/peers/{node_id} Revoke Peer
PUT /api/peers/{node_id}/wol Update Wol
Method Path Summary
POST /api/persona Create Persona
GET /api/persona/list List Personas
POST /api/persona/memory/purge Purge Memory
GET /api/persona/status Get Persona Status
POST /api/persona/switch Switch Persona
DELETE /api/persona/{persona_id} Delete Persona
GET /api/persona/{persona_id} Get Persona
POST /api/persona/{persona_id}/activate Activate Persona
Method Path Summary
POST /api/rag/add Add Knowledge Source
GET /api/rag/data/freshness Get Data Freshness Stats
GET /api/rag/data/version Get Data Version
GET /api/rag/documents List Documents
DELETE /api/rag/documents/{url} Delete Document
GET /api/rag/indexes Get Rag Indexes
POST /api/rag/merge Merge Corpus
GET /api/rag/stats Get Rag Stats
GET /api/rag/suggestions Get Doc Suggestions
POST /api/rag/suggestions/reset Reset Dismissed Suggestions
POST /api/rag/suggestions/{doc_key}/add Add Suggested Doc
POST /api/rag/suggestions/{doc_key}/dismiss Dismiss Suggestion
GET /api/rag/trending Get Trending Suggestions
GET /api/rag/trending/enhanced Get Enhanced Trending
GET /api/rag/trending/stack Get Detected Stack
POST /api/rag/trending/{repo_name}/analyze Analyze Single Repo
POST /api/rag/trending/{repo_name}/dismiss Dismiss Trending Repo
POST /api/rag/trending/{repo_name}/watch Watch Trending Repo
Method Path Summary
POST /api/replica/promote Promote
GET /api/replica/status Replica Status
Method Path Summary
POST /api/services/services/{service_name}/control Control Service
POST /api/services/{service_name}/diagnose Diagnose Service
POST /api/services/{service_name}/explain Explain Service
Method Path Summary
GET /api/settings/ai-rules Get Ai Rules
POST /api/settings/ai-rules Add Ai Rule
DELETE /api/settings/ai-rules/{rule_id} Delete Ai Rule
PUT /api/settings/ai-rules/{rule_id} Update Ai Rule
POST /api/settings/anomaly/check Run Anomaly Check
GET /api/settings/anomaly/status Get Anomaly Status
GET /api/settings/approvals/history Get Approval History
GET /api/settings/approvals/pending Get Pending Approvals
POST /api/settings/approvals/test/create Create Test Approval
POST /api/settings/approvals/{request_id}/decide Decide Approval
GET /api/settings/being Get Being Config
POST /api/settings/being Update Being Config
POST /api/settings/computer-name Update Computer Name
POST /api/settings/docs/index Index Documents
GET /api/settings/docs/query Query Documents
POST /api/settings/docs/reset Reset Indexing
GET /api/settings/docs/stats Get Docs Stats
POST /api/settings/guardrails/safe-mode/enter Enter Safe Mode
POST /api/settings/guardrails/safe-mode/exit Exit Safe Mode
GET /api/settings/guardrails/status Get Guardrails Status
POST /api/settings/ingestion/start Start Ingestion
GET /api/settings/ingestion/status Get Ingestion Status
POST /api/settings/ingestion/stop Stop Ingestion
GET /api/settings/knowledge/all Get All Knowledge
POST /api/settings/knowledge/assign-role Assign Role
POST /api/settings/knowledge/bootstrap Bootstrap System Identity
POST /api/settings/knowledge/explain-config Explain Config
GET /api/settings/knowledge/graph/dependencies/{node_id} Get Dependencies
GET /api/settings/knowledge/graph/dependents/{node_id} Get Dependents
GET /api/settings/knowledge/graph/impact/{node_id} Get Impact Analysis
GET /api/settings/knowledge/graph/node/{node_id} Get Node Relations
POST /api/settings/knowledge/graph/relation Add Relation
DELETE /api/settings/knowledge/graph/relation/{rel_id} Delete Relation
GET /api/settings/knowledge/graph/relations Get All Relations
GET /api/settings/knowledge/graph/stats Get Graph Stats
POST /api/settings/knowledge/hierarchical/build Build Hierarchy
GET /api/settings/knowledge/hierarchical/category/{category} Get Category Documents
GET /api/settings/knowledge/hierarchical/retrieve Retrieve Hierarchical
GET /api/settings/knowledge/hierarchical/stats Get Hierarchical Stats
GET /api/settings/knowledge/hierarchical/tier/{tier} Get Tier Documents
GET /api/settings/knowledge/identity Get System Identity
POST /api/settings/knowledge/reflect Reflect On Query
GET /api/settings/knowledge/reflect/context Get Reflection Context
GET /api/settings/knowledge/search Search Knowledge
GET /api/settings/knowledge/stats Get Knowledge Stats
POST /api/settings/knowledge/teach Teach System
DELETE /api/settings/knowledge/{entry_id} Delete Knowledge
GET /api/settings/machine-roles Get Machine Roles
POST /api/settings/machine-roles Set Machine Roles
GET /api/settings/metrics Get System Metrics
POST /api/settings/model/apply-recommended Apply Recommended Config
POST /api/settings/model/install Install Model
GET /api/settings/model/loaded Get Loaded Model Status
GET /api/settings/model/status Get Model Status
POST /api/settings/onboarding/complete Complete Onboarding
GET /api/settings/onboarding/probe Probe Onboarding
GET /api/settings/onboarding/status Get Onboarding Status
GET /api/settings/personality/archetypes List Personality Archetypes
GET /api/settings/personality/archetypes/{archetype_id} Get Personality Archetype
POST /api/settings/personality/blend Blend Archetypes
POST /api/settings/personality/preview Preview Personality Section
GET /api/settings/personality/styles List Communication Styles
GET /api/settings/policy Get Policy
POST /api/settings/policy Update Policy
POST /api/settings/policy/tool Set Tool Policy
DELETE /api/settings/policy/tool/{tool_name} Delete Tool Policy
GET /api/settings/prompts Get Prompt Settings
POST /api/settings/recovery/alert Execute Alert
POST /api/settings/recovery/restart-service Execute Restart Service
POST /api/settings/recovery/rollback Execute Rollback
GET /api/settings/recovery/status Get Recovery Status
GET /api/settings/scheduler/jobs List Scheduler Jobs
POST /api/settings/scheduler/jobs/{job_id}/cancel Cancel Scheduler Job
GET /api/settings/scheduler/status Get Scheduler Status
GET /api/settings/security/telemetry Get Security Telemetry
POST /api/settings/simulate/command Simulate Command
POST /api/settings/simulate/file-write Simulate File Write
POST /api/settings/simulate/service-restart Simulate Service Restart
POST /api/settings/simulate/tool Simulate Tool Call
GET /api/settings/system-profile Get System Profile
POST /api/settings/system-profile/quick-scan Quick Scan System
POST /api/settings/system-profile/scan Scan System Profile
POST /api/settings/system-profile/scan-category/{category} Scan Category
GET /api/settings/system-profile/scan/status Get Scan Status
GET /api/settings/system-profile/summary Get System Profile Summary
GET /api/settings/web-search Get Web Search Setting
PUT /api/settings/web-search Update Web Search Setting
Method Path Summary
GET /api/state/by-request By Request
POST /api/state/forget Forget
GET /api/state/history History
GET /api/state/why Why
Method Path Summary
GET /api/status Get System Status
Method Path Summary
GET /api/storage/chromadb Get Chromadb Metrics
POST /api/storage/chromadb/cleanup Start Cleanup
GET /api/storage/chromadb/cleanup/{job_id} Get Cleanup Status
GET /api/storage/chromadb/collections List Collections
POST /api/storage/chromadb/migrate Start Migration
DELETE /api/storage/chromadb/migrate/old Delete Old Location
GET /api/storage/chromadb/migrate/{job_id} Get Migration Status
GET /api/storage/chromadb/orphans List Orphans
GET /api/storage/chromadb/tips Get Performance Tips
Method Path Summary
GET /api/system/display Get Display State
POST /api/system/display Post Display State
Method Path Summary
POST /api/terminal/check-safety Check Safety
POST /api/terminal/exec Execute Command
GET /api/terminal/sessions List Sessions
POST /api/terminal/sessions Spawn Session
DELETE /api/terminal/sessions/{session_id} Kill Session
POST /api/terminal/sessions/{session_id}/input Send Input
POST /api/terminal/sessions/{session_id}/resize Resize Session
POST /api/terminal/sessions/{session_id}/stage Stage Into Shell
GET /api/terminal/sessions/{session_id}/stream Stream Session
POST /api/terminal/sessions/{session_id}/watched Set Watched
POST /api/terminal/validate Validate Command
Method Path Summary
GET /api/vision/config Get Vision Config
PUT /api/vision/config Update Vision Config
GET /api/vision/screenshot Capture Screenshot
GET /api/vision/status Vision Status
GET /api/vision/webcam Capture Webcam
Method Path Summary
POST /api/web-search/cache/clear Clear Cache
GET /api/web-search/cache/stats Get Cache Stats
DELETE /api/web-search/instances Remove Instance
GET /api/web-search/instances Get Instances
POST /api/web-search/instances/add Add Instance
POST /api/web-search/instances/check Check Instances
GET /api/web-search/search Search Get
POST /api/web-search/search Search
POST /api/web-search/search-for-rag Search For Rag
Method Path Summary
DELETE /api/why Delete Rationale
GET /api/why Get Rationale
POST /api/why Save Rationale
GET /api/why/by-type Get Rationales By Type