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.
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" \ -H "Content-Type: application/json" \ -d '{ "kind": "markdown", "title": "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}List the AI artifacts in a workspace
Returns the workspace's artifacts newest first, optionally narrowed by `chatId`, `messageId`, `kind`, or `status`; archived artifacts are excluded unless `status` asks for them. Requires a workspace member with the `ai:read` permission, and an artifact whose referenced workspace item or file the caller cannot read is dropped from the page. Pass `limit` to cap the page size.
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.