Artifacts API
7 endpoints. Artifacts are documents the AI can produce or edit during a chat — code, markdown, JSON — that live as first-class documents alongside the conversation. They have version history; think of them as "the AI's draft pad that you can co-edit".
All paths scoped to a room. Auth: power_level ≥ 0 to read,
default power_level ≥ 10 to write (configurable per room).
| Method | Path | Purpose |
|---|---|---|
GET |
/v1/rooms/{room_id}/artifacts |
List artifacts in this room. |
GET |
/v1/rooms/{room_id}/artifacts/{artifact_id} |
Read latest version. |
PUT |
/v1/rooms/{room_id}/artifacts/{artifact_id} |
Update (creates new version). |
DELETE |
/v1/rooms/{room_id}/artifacts/{artifact_id} |
Soft-delete. |
POST |
/v1/rooms/{room_id}/artifacts/{artifact_id}/revert |
Revert to a specific version. |
GET |
/v1/rooms/{room_id}/artifacts/{artifact_id}/versions |
List versions with change_description. |
GET |
/v1/rooms/{room_id}/artifacts/{artifact_id}/versions/{version} |
Read a specific version. |
PUT body#
1 2 3 4 5 | |
Each PUT creates a new version. change_description is what you see
in the version history panel.
Creation#
There's no POST /artifacts — artifacts are created by the AI
calling the create_artifact plugin tool, or by the client's
canvas panel which uses an internal mechanism. From outside,
artifacts come into existence when the AI decides they should.
Versions#
1 2 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
Revert#
1 2 3 | |
Creates a new version with content from version 2; doesn't delete versions 3+ from history.