HTTP API reference¶
The desktop shell talks to the logic-loom-api sidecar over these routes. The
port is random per launch (see Architecture),
and a running sidecar also serves the full interactive schema at /docs.
Route groups that need an optional extra appear only when it is installed. The
AKMS batch picker is a mounted sub-app at /api/picker. A running sidecar lists
its routes in /openapi.json under the akms-picker tag; they are not listed
here. See the
AKMS batch picker HTTP API.
Generated from API version 0.3.4.
/api/akms¶
| Method | Path | Summary |
|---|---|---|
GET |
/api/akms/claude-assets/file |
Read File |
PUT |
/api/akms/claude-assets/file |
Write File |
GET |
/api/akms/claude-assets/folder |
Folder |
POST |
/api/akms/claude-assets/install |
Install |
POST |
/api/akms/claude-assets/materialize-runtime |
Materialize Runtime |
POST |
/api/akms/claude-assets/reset |
Reset |
GET |
/api/akms/claude-assets/status |
Status |
POST |
/api/akms/node-generation/preflight |
Preflight |
POST |
/api/akms/node-generation/runs |
Create Run |
GET |
/api/akms/node-generation/runs/{run_id} |
Get Run |
POST |
/api/akms/node-generation/runs/{run_id}/cancel |
Cancel Run |
GET |
/api/akms/node-generation/runs/{run_id}/stream |
Stream Run |
/api/app¶
| Method | Path | Summary |
|---|---|---|
GET |
/api/app/akms-status |
Akms Status |
GET |
/api/app/assistant/test-connection/{provider} |
Assistant Test Connection |
GET |
/api/app/config |
Config Get |
POST |
/api/app/config |
Config Post |
GET |
/api/app/config/first-run |
Config First Run |
POST |
/api/app/config/first-run |
Config First Run Save |
POST |
/api/app/config/reload |
Config Reload |
GET |
/api/app/health |
Health |
GET |
/api/app/path-exists |
Path Exists |
GET |
/api/app/version |
Version |
/api/assistant¶
| Method | Path | Summary |
|---|---|---|
GET |
/api/assistant/batches |
List Batches |
POST |
/api/assistant/batches |
Create Batch |
DELETE |
/api/assistant/batches/{batch_id} |
Delete Batch |
GET |
/api/assistant/batches/{batch_id} |
Get Batch |
PATCH |
/api/assistant/batches/{batch_id} |
Patch Batch |
POST |
/api/assistant/batches/{batch_id}/archive |
Archive Batch |
POST |
/api/assistant/batches/{batch_id}/duplicate |
Duplicate Batch |
POST |
/api/assistant/batches/{batch_id}/send-to-akms |
Send To Akms |
POST |
/api/assistant/batches/{batch_id}/sources/add |
Add Sources |
POST |
/api/assistant/batches/{batch_id}/sources/remove |
Remove Sources |
POST |
/api/assistant/batches/{batch_id}/sources/reorder |
Reorder Sources |
DELETE |
/api/assistant/discover/cache |
Discover Cache Clear |
GET |
/api/assistant/discover/cache/stats |
Discover Cache Stats |
POST |
/api/assistant/discover/crossref-zotero |
Discover Crossref Zotero |
POST |
/api/assistant/discover/merge |
Discover Merge |
POST |
/api/assistant/discover/related |
Discover Related |
DELETE |
/api/assistant/discover/related-cache |
Discover Related Cache Clear |
POST |
/api/assistant/discover/search |
Discover Search |
POST |
/api/assistant/index/rebuild |
Rebuild Index |
POST |
/api/assistant/index/search |
Search Index |
GET |
/api/assistant/index/status |
Index Status |
GET |
/api/assistant/outputs |
List Assistant Outputs |
GET |
/api/assistant/outputs/ |
List Assistant Outputs |
POST |
/api/assistant/outputs/{run_id}/export |
Export Run |
POST |
/api/assistant/outputs/{run_id}/open-folder |
Open Run Folder |
GET |
/api/assistant/outputs/{run_id}/primary |
Get Primary Output |
GET |
/api/assistant/workflows |
List Assistant Workflows |
GET |
/api/assistant/workflows/ |
List Assistant Workflows |
DELETE |
/api/assistant/workflows/{workflow_id} |
Delete Assistant Workflow |
GET |
/api/assistant/workflows/{workflow_id} |
Get Assistant Workflow |
POST |
/api/assistant/workflows/{workflow_id}/archive |
Archive Assistant Workflow |
POST |
/api/assistant/workflows/{workflow_id}/duplicate |
Duplicate Assistant Workflow |
GET |
/api/assistant/zotero/preview/{citekey} |
Get Preview |
POST |
/api/assistant/zotero/reindex |
Reindex Library |
GET |
/api/assistant/zotero/search |
Search Picker |
/api/batches¶
| Method | Path | Summary |
|---|---|---|
GET |
/api/batches |
List Batches |
POST |
/api/batches |
Create Batch |
GET |
/api/batches/export-plan |
Export Plan |
POST |
/api/batches/import-plan |
Import Plan |
DELETE |
/api/batches/{batch_id} |
Delete Batch |
GET |
/api/batches/{batch_id} |
Get Batch |
PATCH |
/api/batches/{batch_id} |
Patch Batch |
POST |
/api/batches/{batch_id}/archive |
Archive Batch |
POST |
/api/batches/{batch_id}/bulk-add |
Bulk Add |
POST |
/api/batches/{batch_id}/duplicate |
Duplicate Batch |
GET |
/api/batches/{batch_id}/effective-prompts |
Get Effective Prompts |
POST |
/api/batches/{batch_id}/nodes |
Add Node |
DELETE |
/api/batches/{batch_id}/nodes/{node_id} |
Delete Node |
PATCH |
/api/batches/{batch_id}/nodes/{node_id} |
Patch Node |
POST |
/api/batches/{batch_id}/papers/add |
Papers Add |
POST |
/api/batches/{batch_id}/papers/move |
Papers Move |
POST |
/api/batches/{batch_id}/papers/remove |
Papers Remove |
GET |
/api/batches/{batch_id}/prompts |
Get Prompts |
PUT |
/api/batches/{batch_id}/prompts |
Put Prompts |
POST |
/api/batches/{batch_id}/prompts/reset |
Reset Prompts |
/api/failure-memory¶
| Method | Path | Summary |
|---|---|---|
GET |
/api/failure-memory/jobs |
Failure Memory Jobs |
GET |
/api/failure-memory/jobs/{job_id} |
Failure Memory Job |
GET |
/api/failure-memory/projects |
Failure Memory Projects |
POST |
/api/failure-memory/{project}/check |
Failure Memory Check |
POST |
/api/failure-memory/{project}/compile |
Failure Memory Compile |
GET |
/api/failure-memory/{project}/lessons |
Failure Memory Lessons |
GET |
/api/failure-memory/{project}/lessons/{lesson_id} |
Failure Memory Lesson |
POST |
/api/failure-memory/{project}/record |
Failure Memory Record |
POST |
/api/failure-memory/{project}/refresh |
Failure Memory Refresh |
POST |
/api/failure-memory/{project}/resolve |
Failure Memory Resolve |
GET |
/api/failure-memory/{project}/routes |
Failure Memory Routes |
GET |
/api/failure-memory/{project}/status |
Failure Memory Status |
GET |
/api/failure-memory/{project}/write-diagnostics |
Failure Memory Write Diagnostics |
/api/graph¶
| Method | Path | Summary |
|---|---|---|
GET |
/api/graph/cluster |
Graph Cluster |
GET |
/api/graph/edges |
Graph Edges |
GET |
/api/graph/ego |
Graph Ego |
GET |
/api/graph/issues |
Graph Issue Log |
POST |
/api/graph/issues/ignore |
Graph Issue Ignore |
POST |
/api/graph/issues/scan |
Graph Issue Scan |
GET |
/api/graph/nodes |
Graph Nodes |
POST |
/api/graph/refresh |
Graph Refresh |
POST |
/api/graph/refresh/stream |
Graph Refresh Stream |
GET |
/api/graph/status |
Graph Status |
/api/learn¶
| Method | Path | Summary |
|---|---|---|
GET |
/api/learn/artifacts/{artifact_id}/{path} |
Learn Artifact File |
POST |
/api/learn/compile |
Learn Compile |
GET |
/api/learn/exporters |
Learn Exporters |
GET |
/api/learn/profiles |
Learn Profiles |
GET |
/api/learn/providers |
Learn Providers |
POST |
/api/learn/providers/reload |
Learn Providers Reload |
GET |
/api/learn/status |
Learn Status |
/api/llm¶
| Method | Path | Summary |
|---|---|---|
GET |
/api/llm/providers |
Llm Providers |
POST |
/api/llm/providers/reload |
Llm Providers Reload |
/api/mechdsl¶
| Method | Path | Summary |
|---|---|---|
GET |
/api/mechdsl/artifacts/{artifact_id} |
Mechdsl Artifact |
POST |
/api/mechdsl/compile |
Mechdsl Compile |
GET |
/api/mechdsl/runtime |
Mechdsl Runtime |
POST |
/api/mechdsl/runtime/install-taichi |
Mechdsl Install Taichi |
GET |
/api/mechdsl/status |
Mechdsl Status |
/api/nlm¶
| Method | Path | Summary |
|---|---|---|
POST |
/api/nlm/generate |
Generate Nodes |
POST |
/api/nlm/nlm-batch |
Nlm Batch |
POST |
/api/nlm/notebook |
Create Notebook |
GET |
/api/nlm/runs |
List Runs |
GET |
/api/nlm/runs/{run_id} |
Get Run |
POST |
/api/nlm/runs/{run_id}/cancel |
Cancel Run |
GET |
/api/nlm/runs/{run_id}/stream |
Stream Run |
POST |
/api/nlm/validate |
Validate Nodes |
/api/nodes¶
| Method | Path | Summary |
|---|---|---|
POST |
/api/nodes/copy-to-vault |
Copy To Vault |
GET |
/api/nodes/file |
Read File |
GET |
/api/nodes/files |
List Files |
POST |
/api/nodes/open |
Open In Editor |
GET |
/api/nodes/promote/stream |
Promote Stream |
/api/prompts¶
| Method | Path | Summary |
|---|---|---|
GET |
/api/prompts/export/{export_id} |
Export Bundle |
POST |
/api/prompts/import |
Import Bundle |
POST |
/api/prompts/import-akms-claude-assets |
Import Akms Claude Assets |
POST |
/api/prompts/import-zsum-prompts |
Import Zsum Prompts |
GET |
/api/prompts/profiles |
List Profiles |
POST |
/api/prompts/profiles |
Create Profile |
PUT |
/api/prompts/profiles/{profile_id} |
Update Profile |
POST |
/api/prompts/resolve |
Resolve Effective Prompts |
GET |
/api/prompts/schemas |
List Schemas |
POST |
/api/prompts/schemas |
Create Schema |
DELETE |
/api/prompts/schemas/{schema_id} |
Delete Schema |
GET |
/api/prompts/schemas/{schema_id} |
Get Schema |
PUT |
/api/prompts/schemas/{schema_id} |
Update Schema |
POST |
/api/prompts/slot/{slot}/activate |
Activate Slot |
GET |
/api/prompts/slots |
List Slots |
POST |
/api/prompts/validate |
Validate Variant |
POST |
/api/prompts/variant |
Create Variant |
DELETE |
/api/prompts/variant/{variant_id} |
Delete Variant |
GET |
/api/prompts/variant/{variant_id} |
Get Variant |
PUT |
/api/prompts/variant/{variant_id} |
Update Variant |
POST |
/api/prompts/variant/{variant_id}/duplicate |
Duplicate Variant |
GET |
/api/prompts/variants |
List Variants |
/api/records¶
| Method | Path | Summary |
|---|---|---|
GET |
/api/records/status |
Records Status |
GET |
/api/records/stores/{store_id}/graph |
Records Graph |
GET |
/api/records/stores/{store_id}/records |
Records List |
GET |
/api/records/stores/{store_id}/records/{record_id} |
Records Get |
GET |
/api/records/stores/{store_id}/schemas |
Records Schemas |
/api/runs¶
| Method | Path | Summary |
|---|---|---|
GET |
/api/runs |
List Runs |
POST |
/api/runs/clear |
Clear Runs |
POST |
/api/runs/workflow |
Run Workflow |
DELETE |
/api/runs/{run_id} |
Delete Run |
GET |
/api/runs/{run_id} |
Get Run |
POST |
/api/runs/{run_id}/cancel |
Cancel Run |
GET |
/api/runs/{run_id}/effective-prompts |
Get Effective Prompts |
POST |
/api/runs/{run_id}/rerun |
Rerun |
GET |
/api/runs/{run_id}/stream |
Stream Run |
/api/vault¶
| Method | Path | Summary |
|---|---|---|
GET |
/api/vault/collections |
List Vault Collections |
GET |
/api/vault/file |
Get File |
GET |
/api/vault/resolve |
Resolve |
GET |
/api/vault/search |
Search |
GET |
/api/vault/tree |
Get Tree |
/api/workflows¶
| Method | Path | Summary |
|---|---|---|
GET |
/api/workflows |
List Workflows |
POST |
/api/workflows |
Create Workflow |
GET |
/api/workflows/ |
List Workflows |
POST |
/api/workflows/ |
Create Workflow |
DELETE |
/api/workflows/{workflow_id} |
Delete Workflow |
GET |
/api/workflows/{workflow_id} |
Get Workflow |
PUT |
/api/workflows/{workflow_id} |
Update Workflow |
POST |
/api/workflows/{workflow_id}/archive |
Archive Workflow |
POST |
/api/workflows/{workflow_id}/duplicate |
Duplicate Workflow |
/api/workspace¶
| Method | Path | Summary |
|---|---|---|
POST |
/api/workspace/import-akms-repo |
Import Akms Repo |
/api/zsum¶
| Method | Path | Summary |
|---|---|---|
GET |
/api/zsum/bbt-status |
Get Bbt Status |
GET |
/api/zsum/config-doc |
Get Config Doc |
POST |
/api/zsum/config-doc |
Post Config Doc |
GET |
/api/zsum/effective-config |
Effective Config |
GET |
/api/zsum/index |
Get Index |
GET |
/api/zsum/local-models |
Get Local Models |
POST |
/api/zsum/local-models/install |
Install Local Model |
GET |
/api/zsum/runs |
List Runs |
POST |
/api/zsum/runs |
Submit Run |
GET |
/api/zsum/runs/{run_id} |
Get Run |
POST |
/api/zsum/runs/{run_id}/cancel |
Cancel Run |
GET |
/api/zsum/runs/{run_id}/stream |
Stream Run |
GET |
/api/zsum/status |
Status |
POST |
/api/zsum/test |
Test Environment |