Archive an AI artifact
Moves the artifact to `archived`, which hides it from the default listing and blocks further edits, and returns the updated artifact. Requires a workspace member with the `ai:write` permission; archiving an already-archived artifact is a no-op, 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.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/workspaces/string/ai-artifacts/string/archive" \ -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" }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}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.
Link an AI artifact to a workspace item
Attaches the artifact to an existing workspace item so the two reference each other, and returns the updated artifact. Requires a workspace member with the `ai:write` permission who can also write both the artifact's current reference and the target item; an archived artifact cannot be linked. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.