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.
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
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/workspaces/string/ai-artifacts/string"{ "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}Create an AI artifact
Stores a new artifact of the given kind with its text or JSON content and any source references, optionally attached to a chat and message. Requires a workspace member with the `ai:write` permission; the title and content are validated, and a referenced workspace item or file the caller cannot reach is refused. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.
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.