Artifacts

Update an artifact

Updates an artifact you can edit: one you own, or one shared with you with write permission. Changed content creates a new version; the other fields change in place. Omitted fields are left unchanged. Unknown body fields are rejected.

patch/api/v1/artifacts/{id}

Request

  • Base URL: https://your-deployment.example.com
  • URL: https://your-deployment.example.com/api/v1/artifacts/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

idstring required

Request body

titlestring
descriptionstring
contentstring

Changed content creates a new version.

tagsstring[]

Example request

{
  "content": "graph TD; A[Sign up] --> B[Verify email] --> C[Done]"
}

Response

The updated artifact and its current content. content is null for a caller who may edit but not read the artifact, unless the request sent content.

idstring required
type'mermaid' | 'recharts' | 'chess' | 'python' | 'react' | 'html' | 'svg' | 'code' | 'quest' | 'file' | 'questmaster' | 'lattice' | 'blog-draft' required
titlestring required
descriptionstring nullable required
versioninteger required

The current version. Starts at 1; each content change adds one.

version_tagstring nullable required
status'draft' | 'review' | 'published' | 'archived' required
tagsstring[] required
session_idstring nullable required
project_idstring nullable required
visibility'private' | 'project' | 'organization' | 'public' required
created_atstring required

ISO 8601 timestamp.

updated_atstring required

ISO 8601 timestamp.

contentstring nullable required

The current version's content. null in a list (fetch the artifact by id for it), and in an update response to a caller who may edit the artifact but not read it, unless that update sent content.

Changes

No recorded changes to this operation across all 1 revision of this API.