HTTP endpoints
HTTP: artifacts
All 7 artifacts 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/artifacts
List artifacts.
Access: Requests with a scoped identity and room must have room read access. Additional permissions may apply.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.
POST /v1/artifacts
Create artifact.
Access: Archived rooms reject content writes. Check the error for a replacement room. 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 |
|---|---|---|---|
room_id | string | yes | See operation notes. |
title | string | yes | See operation notes. |
kind | string | yes | See operation notes. |
by_agent_id | string | no | See operation notes. |
metadata | object | no | See operation notes. |
tags | array | no | See operation notes. |
Other constraints may apply, including for fields marked optional.
Additional body field names (types and requiredness not specified here): body.
GET /v1/artifacts/{id}
Get artifact.
Path parameters: id.
Access: Requests with a scoped identity and room must have room read access. Additional permissions may apply.
Query field names (types and requiredness not specified here): include_image.
PATCH /v1/artifacts/{id}
Patch artifact.
Path parameters: id.
Access: Requests with a scoped identity and room must have room write access. Additional permissions may apply. Archived rooms reject content writes. Check the error for a replacement room. 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 |
|---|---|---|---|
title | string | no | See operation notes. |
metadata | object | no | See operation notes. |
tags | array | no | See operation notes. |
by_agent_id | string | no | See operation notes. |
expected_revision | integer | no | See operation notes. |
keep_history | boolean | no | See operation notes. |
append | boolean | no | See operation notes. |
archived | boolean | no | See operation notes. |
force | boolean | no | See operation notes. |
Other constraints may apply, including for fields marked optional.
Additional body field names (types and requiredness not specified here): body.
POST /v1/artifacts/{id}/copy
Copy artifact.
Path parameters: id.
Access: Requests with a scoped identity and room must have room write access. Additional permissions may apply. Archived rooms reject content writes. Check the error for a replacement room. 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 |
|---|---|---|---|
room_id | string | yes | See operation notes. |
by_agent_id | string | no | See operation notes. |
force | boolean | no | See operation notes. |
Other constraints may apply, including for fields marked optional.
POST /v1/artifacts/{id}/move
Move artifact.
Path parameters: id.
Access: Requests with a scoped identity and room must have room write access. Additional permissions may apply. Archived rooms reject content writes. Check the error for a replacement room. 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 |
|---|---|---|---|
room_id | string | yes | See operation notes. |
by_agent_id | string | no | See operation notes. |
force | boolean | no | See operation notes. |
Other constraints may apply, including for fields marked optional.
GET /v1/artifacts/{id}/render
Render a readable HTML or SVG artifact as a static page without scripts or forms.
Path parameters: id.
Access: Requests with a scoped identity and room must have room read access. Additional permissions may apply.
This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.