HTTP endpoints

HTTP: templates

All 6 templates endpoints, with request fields and access notes.

On this page

GET /v1/templates
POST /v1/templates
DELETE /v1/templates/{id}
GET /v1/templates/{id}
PATCH /v1/templates/{id}
POST /v1/templates/{id}/apply

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/templates

List templates.

This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.

POST /v1/templates

Create template.

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
`template_id`	string	no	See operation notes.
`name`	string	yes	See operation notes.
`description`	string	no	See operation notes.
`tagline`	string	no	See operation notes.
`icon`	string	no	See operation notes.
`featured`	boolean	no	See operation notes.
`fields`	array	no	See operation notes.
`roles`	array	no	See operation notes.
`tasks`	array	no	See operation notes.
`room_name_pattern`	string	no	See operation notes.
`project_context_template`	string	no	See operation notes.
`room_purpose_template`	string	no	See operation notes.
`is_builtin`	boolean	no	See operation notes.

Other constraints may apply, including for fields marked optional.

DELETE /v1/templates/{id}

Delete template.

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.

This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.

GET /v1/templates/{id}

Get template.

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/templates/{id}

Patch template.

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.
`description`	string	no	See operation notes.
`tagline`	string	no	See operation notes.
`icon`	string	no	See operation notes.
`featured`	boolean	no	See operation notes.
`fields`	array	no	See operation notes.
`roles`	array	no	See operation notes.
`tasks`	array	no	See operation notes.
`room_name_pattern`	string	no	See operation notes.
`project_context_template`	string	no	See operation notes.
`room_purpose_template`	string	no	See operation notes.

Other constraints may apply, including for fields marked optional.

POST /v1/templates/{id}/apply

Apply template.

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
`project_id`	string	no	See operation notes.
`name_overrides`	object	no	See operation notes.
`field_values`	object	no	See operation notes.
`launch_preset`	boolean	no	See operation notes.
`seed_tasks`	boolean	no	See operation notes.
`crew`	array	no	See operation notes.
`project_description`	string	no	See operation notes.
`room_purpose`	string	no	See operation notes.
`roles`	array	no	See operation notes.

Other constraints may apply, including for fields marked optional.