Update an Artifact
update_artifactChange an Artifact you own or edit. Pass content to publish a new Version of the page at the same URL (the whole document, not a diff; earlier Versions stay in the history). Pass title, description, icon, or icon_image to change those, and, in a call without content, expires_in_days or expires_at (null keeps it) to set when an Artifact you own is deleted. Any combination in one call. With content the call waits for the new Version to be live before returning. The new Version keeps the base Version's capabilities and state rules unless you pass capabilities or state.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"artifact_id": "<artifact_id>"
},
"name": "update_artifact"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| icon | No | null clears it. | |
| state | No | Who may read and write which paths of the page's data, by the minimum role: viewer (can open), contributor (a data grant, separate from editing the page), owner. Absent means: everyone who can open reads, contributors and the owner write. Example poll: [{path:'votes',read:'viewer',write:'owner'},{path:'votes/{self}',write:'viewer'}]. | |
| title | No | ||
| content | No | The complete new document, same type as before. | |
| expires_at | No | The same as expires_in_days, as an RFC 3339 moment. Pass one or the other. null cancels the expiry, so the Artifact is kept. | |
| icon_image | No | The page's own icon: the favicon in the browser tab and the icon a phone puts on its Home Screen. A data URL: an SVG (data:image/svg+xml,<svg …>) or a base64 PNG, JPEG, WebP, or GIF, at most 512 KB, cropped to a square. An SVG must be self-contained (no links to other files, fonts, or stylesheets); draw shapes rather than text. Without one the page shows the Bisque icon. null goes back to the Bisque icon. | |
| artifact_id | Yes | The Artifact id (art_…): the last part of its link, as in bisque.cloud/documents/art_…, /pages/art_… or /artifacts/art_…. | |
| description | No | null clears it. | |
| capabilities | No | What the page may do at run time. state.read and state.write give it JSON documents at window.bisque.state (get, patch, list, subscribe); viewer.identity tells it who is viewing (window.bisque.viewer); events.emit lets it record typed Events. Omit for a page that only shows things. | |
| expires_in_days | No | Delete the Artifact this many days from now, as delete_artifact would: it sits in the owner's Trash for 30 days, then its files go. Only when the user asks for it to go away (a scratch page, a one-week poll); leave it out and the Artifact is kept. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The viewer page. | |
| icon | No | ||
| type | Yes | ||
| title | Yes | ||
| group_id | No | ||
| created_at | No | ||
| expires_at | No | When it is deleted, as its owner asked; absent when it is kept. | |
| updated_at | No | ||
| version_id | No | The Version this call authored. | |
| artifact_id | Yes | ||
| description | No | ||
| audience_mode | Yes | Who can open it: owner, users, org, or public. | |
| icon_image_url | No | The page icon set with icon_image; null for the Bisque icon. | |
| version_number | No | ||
| discoverability | Yes | ||
| organization_id | No | ||
| latest_version_id | No | ||
| publication_error | No | ||
| publication_status | No | ready means the URL serves this content now. queued or processing means it is still being prepared; call get_artifact to check. failed carries publication_error. | |
| viewer_version_mode | No | ||
| published_version_id | Yes | The Version viewers see; null until a publication is ready. |