HTTP endpoints
HTTP: projects
All 10 projects endpoints, with request fields and access notes.
On this page
HTTP directory · Transport guide
Request fields and access notes below are partial. Additional constraints and permissions may apply. Prefer the corresponding MCP tool and schema where available.
GET /v1/projects
List projects.
Query field names (types and requiredness not specified here): include_archived, include_system.
POST /v1/projects
Create project.
Access: LAN writes require an active session token. Local loopback requests are exempt from this requirement by default; other permissions still apply.
Request body fields (partial)
| Field | Type | Required | Constraints |
|---|---|---|---|
name | string | yes | See operation notes. |
glyph | string | no | See operation notes. |
description | string | no | See operation notes. |
metadata | object | no | See operation notes. |
default_folder_path | string | no | See operation notes. |
Other constraints may apply, including for fields marked optional.
DELETE /v1/projects/{id}
Delete project.
Path parameters: id.
Access: This action may require confirmation. Follow the confirmation details returned for your request. LAN writes require an active session token. Local loopback requests are exempt from this requirement by default; other permissions still apply.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
GET /v1/projects/{id}
Get project.
Path parameters: id.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
PATCH /v1/projects/{id}
Patch project.
Path parameters: id.
Access: LAN writes require an active session token. Local loopback requests are exempt from this requirement by default; other permissions still apply.
Request body fields (partial)
| Field | Type | Required | Constraints |
|---|---|---|---|
name | string | no | See operation notes. |
glyph | string | no | See operation notes. |
description | string | no | See operation notes. |
archived | boolean | no | See operation notes. |
metadata | object | no | See operation notes. |
default_room_id | string | no | See operation notes. |
default_folder_path | string | no | See operation notes. |
Other constraints may apply, including for fields marked optional.
POST /v1/projects/{id}/capsules/export
Export a confirmed portable project capsule to a new .arcpack path.
Path parameters: id.
Access: This action may require confirmation. Follow the confirmation details returned for your request. LAN writes require an active session token. Local loopback requests are exempt from this requirement by default; other permissions still apply.
Request body fields (partial)
| Field | Type | Required | Constraints |
|---|---|---|---|
path | string | yes | A nonempty absolute local file path. |
scope | string | no | See operation notes. |
privacy_mode | string | no | See operation notes. |
selected_room_ids | array | no | See operation notes. |
include_git_mirror | boolean | no | See operation notes. |
redact_emails | boolean | no | See operation notes. |
Other constraints may apply, including for fields marked optional.
POST /v1/projects/{id}/capsules/preflight
Preview portable capsule scope, privacy and export effects.
Path parameters: id.
Access: LAN writes require an active session token. Local loopback requests are exempt from this requirement by default; other permissions still apply.
Request body fields (partial)
| Field | Type | Required | Constraints |
|---|---|---|---|
scope | string | no | See operation notes. |
privacy_mode | string | no | See operation notes. |
selected_room_ids | array | no | See operation notes. |
redact_emails | boolean | no | See operation notes. |
Other constraints may apply, including for fields marked optional.
POST /v1/projects/{id}/export
Export a project’s full project snapshot bundle.
Path parameters: id.
Access: This action may require confirmation. Follow the confirmation details returned for your request. LAN writes require an active session token. Local loopback requests are exempt from this requirement by default; other permissions still apply.
Request body fields (partial)
| Field | Type | Required | Constraints |
|---|---|---|---|
out_dir | string | no | When nonempty, an absolute path writable by the daemon. Omit or leave empty to use the default export directory. |
include_audit | boolean | no | See operation notes. |
Other constraints may apply, including for fields marked optional.
GET /v1/projects/{id}/skill-exposures
Read skill exposures.
Path parameters: id.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
GET /v1/projects/{id}/skill-fitness-report
Read skill report.
Path parameters: id.
Query field names (types and requiredness not specified here): limit.