SnozeDevelopers
API referenceAi Artifacts

Update an AI artifact

Applies a partial edit to an artifact's title, summary, content, status, or references. Requires a workspace member with the `ai:write` permission; an archived artifact cannot be updated, and an unknown artifact is reported as not found. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.

PATCH
/v1/workspaces/{workspaceId}/ai-artifacts/{artifactId}

Authorization

apiKey
AuthorizationBearer <token>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

In: header

Path Parameters

workspaceId*string
artifactId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/workspaces/string/ai-artifacts/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "id": "string",    "workspaceId": "string",    "chatId": "string",    "messageId": "string",    "creator": {      "userId": "string",      "principalType": "user",      "principalId": "string",      "displayName": "string"    },    "kind": "markdown",    "status": "draft",    "title": "string",    "summary": "string",    "textContent": "string",    "jsonContent": null,    "mimeType": "string",    "language": "string",    "sourceRefs": [      {        "type": "chat_message",        "chatId": "string",        "messageId": "string"      }    ],    "workspaceItemId": "string",    "fileId": "string",    "createdAt": "string",    "updatedAt": "string",    "archivedAt": "string",    "deletedAt": "string"  }}

Read one AI artifact

Returns a single artifact with its content, status, and source references. Requires a workspace member with the `ai:read` permission who can also read whatever workspace item or file the artifact references; an unknown artifact is reported as not found.

Delete an AI artifact

Soft-deletes the artifact and returns its id. Requires a workspace member with the `ai:write` permission; deleting an already-deleted artifact is a no-op rather than an error. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.