Edit artifact details
artifact_patchPatch artifact details, visibility, folder or workspace audience without creating a version; name at least one. Workspace artifacts need why (except a patch of visibility alone), and expectedWorkspaceRevision when description or metadata is sent (the patch was composed from what you read); with only title, alias, folder, audience or visibility it is optional and refuses (CONFLICT) if the artifact changed since. visibility on a workspace artifact is private or link (anyone with the URL reads it, without signing in), set by internal editors: link on an internal artifact makes it shared too, and audience internal turns link off. folder moves it (an id, or a slug in its workspace, else in team, else your personal folders; null unfiles); alias null clears it. Sharing exposes full artifact history. metadata replaces the stored object, except a table keeps its schema and strict unless they are sent; a sent table schema must be valid (types, enum values, at most one unique column, and each new column name 1 to 256 characters with no leading or trailing space, comma or square bracket) but may keep its stored column names. A schema that declares or moves the key re-keys the rows: repeated values in the new key column are STATE_CONFLICT, and an object or array value or a value over 1024 bytes is INVALID_INPUT, changing nothing. Returns a bounded receipt.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| why | No | Required for workspace items: one sentence on what the person is trying to accomplish, in their terms, not a description of this edit. Every workspace write takes one; sessions and summaries record themselves from it. Not needed to change only visibility; recorded when sent. At most 300 characters. | |
| team | No | With a folder slug: the team the folder belongs to. | |
| alias | No | A new URL alias, or null to clear it. | |
| title | No | ||
| folder | No | Move it: a folder id, or a slug (in its workspace, else in team, else your personal folders); null unfiles it. | |
| audience | No | Workspace audience: internal (the default for internal members) or shared (external members see it too; the only choice for external editors). | |
| metadata | No | Replaces the stored metadata (null clears it); a table keeps its schema and strict unless they are sent. | |
| artifactId | Yes | The artifact: its id, its alias (bare, ~agent/alias or _team/alias), or its page URL. | |
| visibility | No | Who beyond its home reads it. Standalone: private, link or public (listed). Workspace: private or link (anyone with the URL), set by internal editors; link on an internal artifact makes it shared, and audience internal turns link off. A patch of visibility alone needs no why. | |
| description | No | ||
| expectedWorkspaceRevision | No | The artifact's workspaceRevision as you read it: required with description or metadata on a workspace artifact, else optional (a stale one is CONFLICT). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| artifact | Yes |