feat(ph-ai): agent artifacts API endpoint

Author: kappa90

ee/api/agent_artifact.py

@@ -0,0 +1,60 @@
+from rest_framework import serializers, status
+from rest_framework.mixins import DestroyModelMixin, ListModelMixin, RetrieveModelMixin
+from rest_framework.response import Response
+from rest_framework.viewsets import GenericViewSet
+
+from posthog.api.routing import TeamAndOrgViewSetMixin
+
+from ee.models.assistant import AgentArtifact
+
+
+class AgentArtifactSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = AgentArtifact
+        fields = ["id", "short_id", "name", "type", "content", "conversation", "team", "created_at"]
+        read_only_fields = ["id", "short_id", "name", "type", "content", "conversation", "team", "created_at"]
+
+
+class AgentArtifactMinimalSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = AgentArtifact
+        fields = ["short_id", "name", "type", "created_at"]
+
+
+class AgentArtifactViewSet(
+    TeamAndOrgViewSetMixin,
+    RetrieveModelMixin,
+    ListModelMixin,
+    DestroyModelMixin,
+    GenericViewSet,
+):
+    scope_object = "INTERNAL"
+    serializer_class = AgentArtifactSerializer
+    queryset = AgentArtifact.objects.all()
+    lookup_field = "short_id"
+    lookup_url_kwarg = "short_id"
+
+    def safely_get_queryset(self, queryset):
+        queryset = queryset.filter(conversation__user=self.request.user, conversation__team=self.team)
+
+        conversation_id = self.request.query_params.get("conversation")
+        if conversation_id:
+            queryset = queryset.filter(conversation_id=conversation_id)
+
+        return queryset.order_by("-created_at")
+
+    def get_serializer_class(self):
+        if self.action == "list":
+            return AgentArtifactMinimalSerializer
+        return AgentArtifactSerializer
+
+    def destroy(self, request, *args, **kwargs):
+        instance = self.get_object()
+
+        if instance.conversation.user != request.user:
+            return Response(
+                {"error": "Cannot delete other users' artifacts"},
+                status=status.HTTP_403_FORBIDDEN,
+            )
+
+        return super().destroy(request, *args, **kwargs)

ee/api/test/test_agent_artifact.py

@@ -0,0 +1,274 @@
+from posthog.test.base import APIBaseTest
+from unittest.mock import patch
+
+from rest_framework import status
+
+from ee.models.assistant import AgentArtifact, Conversation
+
+
+class TestAgentArtifactModel(APIBaseTest):
+    def test_create_artifact(self):
+        conversation = Conversation.objects.create(
+            user=self.user, team=self.team, title="Test Conversation", type=Conversation.Type.ASSISTANT
+        )
+
+        artifact = AgentArtifact.objects.create(
+            name="Test Visualization",
+            type=AgentArtifact.Type.VISUALIZATION,
+            content={"query": {"kind": "TrendsQuery"}},
+            conversation=conversation,
+            team=self.team,
+        )
+
+        self.assertIsNotNone(artifact.id)
+        self.assertEqual(len(artifact.short_id), 6)
+        self.assertEqual(artifact.name, "Test Visualization")
+        self.assertEqual(artifact.type, AgentArtifact.Type.VISUALIZATION)
+        self.assertEqual(artifact.content, {"query": {"kind": "TrendsQuery"}})
+        self.assertEqual(artifact.conversation, conversation)
+        self.assertIsNotNone(artifact.created_at)
+
+    def test_short_id_unique(self):
+        conversation = Conversation.objects.create(
+            user=self.user, team=self.team, title="Test Conversation", type=Conversation.Type.ASSISTANT
+        )
+
+        artifact1 = AgentArtifact.objects.create(
+            name="Artifact 1",
+            type=AgentArtifact.Type.VISUALIZATION,
+            content={},
+            conversation=conversation,
+            team=self.team,
+        )
+
+        artifact2 = AgentArtifact.objects.create(
+            name="Artifact 2",
+            type=AgentArtifact.Type.DOCUMENT,
+            content={},
+            conversation=conversation,
+            team=self.team,
+        )
+
+        self.assertNotEqual(artifact1.short_id, artifact2.short_id)
+
+    def test_cascade_delete_with_conversation(self):
+        conversation = Conversation.objects.create(
+            user=self.user, team=self.team, title="Test Conversation", type=Conversation.Type.ASSISTANT
+        )
+
+        artifact = AgentArtifact.objects.create(
+            name="Test Artifact",
+            type=AgentArtifact.Type.VISUALIZATION,
+            content={},
+            conversation=conversation,
+            team=self.team,
+        )
+
+        artifact_id = artifact.id
+        conversation.delete()
+
+        self.assertFalse(AgentArtifact.objects.filter(id=artifact_id).exists())
+
+    def test_short_id_collision_retry(self):
+        conversation = Conversation.objects.create(
+            user=self.user, team=self.team, title="Test Conversation", type=Conversation.Type.ASSISTANT
+        )
+
+        artifact1 = AgentArtifact.objects.create(
+            name="Artifact 1",
+            type=AgentArtifact.Type.VISUALIZATION,
+            content={},
+            conversation=conversation,
+            team=self.team,
+        )
+
+        original_short_id = artifact1.short_id
+
+        with patch("ee.models.assistant.generate_short_id_6", return_value="unique"):
+            artifact2 = AgentArtifact(
+                name="Artifact 2",
+                type=AgentArtifact.Type.DOCUMENT,
+                content={},
+                conversation=conversation,
+                team=self.team,
+                short_id=original_short_id,  # Start with duplicate
+            )
+            artifact2.save()
+
+        self.assertEqual(artifact2.short_id, "unique")
+
+
+class TestAgentArtifactAPI(APIBaseTest):
+    def setUp(self):
+        super().setUp()
+        self.conversation = Conversation.objects.create(
+            user=self.user, team=self.team, title="Test Conversation", type=Conversation.Type.ASSISTANT
+        )
+
+    def test_list_artifacts(self):
+        AgentArtifact.objects.create(
+            name="Artifact 1",
+            type=AgentArtifact.Type.VISUALIZATION,
+            content={"query": {}},
+            conversation=self.conversation,
+            team=self.team,
+        )
+
+        AgentArtifact.objects.create(
+            name="Artifact 2",
+            type=AgentArtifact.Type.DOCUMENT,
+            content={"blocks": []},
+            conversation=self.conversation,
+            team=self.team,
+        )
+
+        response = self.client.get(f"/api/environments/{self.team.id}/agent-artifacts/")
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(len(response.json()["results"]), 2)
+
+        # Check that list returns minimal serializer fields
+        result = response.json()["results"][0]
+        self.assertIn("short_id", result)
+        self.assertIn("name", result)
+        self.assertIn("type", result)
+        self.assertIn("created_at", result)
+        self.assertNotIn("content", result)
+        self.assertNotIn("id", result)
+
+    def test_list_artifacts_filter_by_conversation(self):
+        other_conversation = Conversation.objects.create(
+            user=self.user, team=self.team, title="Other Conversation", type=Conversation.Type.ASSISTANT
+        )
+
+        AgentArtifact.objects.create(
+            name="Artifact 1",
+            type=AgentArtifact.Type.VISUALIZATION,
+            content={},
+            conversation=self.conversation,
+            team=self.team,
+        )
+
+        AgentArtifact.objects.create(
+            name="Artifact 2",
+            type=AgentArtifact.Type.DOCUMENT,
+            content={},
+            conversation=other_conversation,
+            team=self.team,
+        )
+
+        response = self.client.get(
+            f"/api/environments/{self.team.id}/agent-artifacts/",
+            {"conversation": str(self.conversation.id)},
+        )
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(len(response.json()["results"]), 1)
+        self.assertEqual(response.json()["results"][0]["name"], "Artifact 1")
+
+    def test_retrieve_artifact(self):
+        artifact = AgentArtifact.objects.create(
+            name="Test Artifact",
+            type=AgentArtifact.Type.VISUALIZATION,
+            content={"query": {"kind": "TrendsQuery"}},
+            conversation=self.conversation,
+            team=self.team,
+        )
+
+        response = self.client.get(f"/api/environments/{self.team.id}/agent-artifacts/{artifact.short_id}/")
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        data = response.json()
+        self.assertEqual(data["short_id"], artifact.short_id)
+        self.assertEqual(data["name"], "Test Artifact")
+        self.assertEqual(data["type"], "visualization")
+        self.assertEqual(data["content"], {"query": {"kind": "TrendsQuery"}})
+        self.assertIn("id", data)
+        self.assertIn("created_at", data)
+
+    def test_create_artifact_not_allowed(self):
+        response = self.client.post(
+            f"/api/environments/{self.team.id}/agent-artifacts/",
+            {
+                "name": "New Artifact",
+                "type": "visualization",
+                "content": {"query": {"kind": "FunnelsQuery"}},
+                "conversation": str(self.conversation.id),
+            },
+            format="json",
+        )
+
+        self.assertEqual(response.status_code, status.HTTP_405_METHOD_NOT_ALLOWED)
+
+    def test_delete_artifact(self):
+        artifact = AgentArtifact.objects.create(
+            name="To Delete",
+            type=AgentArtifact.Type.VISUALIZATION,
+            content={},
+            conversation=self.conversation,
+            team=self.team,
+        )
+
+        response = self.client.delete(f"/api/environments/{self.team.id}/agent-artifacts/{artifact.short_id}/")
+
+        self.assertEqual(response.status_code, status.HTTP_204_NO_CONTENT)
+        self.assertFalse(AgentArtifact.objects.filter(short_id=artifact.short_id).exists())
+
+    def test_cannot_access_other_user_artifacts(self):
+        other_user = self._create_user("[email protected]")
+        other_conversation = Conversation.objects.create(
+            user=other_user, team=self.team, title="Other Conversation", type=Conversation.Type.ASSISTANT
+        )
+
+        artifact = AgentArtifact.objects.create(
+            name="Other User Artifact",
+            type=AgentArtifact.Type.VISUALIZATION,
+            content={},
+            conversation=other_conversation,
+            team=self.team,
+        )
+
+        response = self.client.get(f"/api/environments/{self.team.id}/agent-artifacts/{artifact.short_id}/")
+        self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
+
+    def test_cannot_access_other_team_artifacts(self):
+        other_team = self.organization.teams.create(name="Other Team")
+
+        other_team_conversation = Conversation.objects.create(
+            user=self.user, team=other_team, title="Other Team Conversation", type=Conversation.Type.ASSISTANT
+        )
+
+        artifact = AgentArtifact.objects.create(
+            name="Other Team Artifact",
+            type=AgentArtifact.Type.VISUALIZATION,
+            content={},
+            conversation=other_team_conversation,
+            team=other_team,
+        )
+
+        response = self.client.get(f"/api/environments/{self.team.id}/agent-artifacts/{artifact.short_id}/")
+        self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
+
+    def test_list_artifacts_ordered_by_created_at_desc(self):
+        AgentArtifact.objects.create(
+            name="First",
+            type=AgentArtifact.Type.VISUALIZATION,
+            content={},
+            conversation=self.conversation,
+            team=self.team,
+        )
+
+        AgentArtifact.objects.create(
+            name="Second",
+            type=AgentArtifact.Type.DOCUMENT,
+            content={},
+            conversation=self.conversation,
+            team=self.team,
+        )
+
+        response = self.client.get(f"/api/environments/{self.team.id}/agent-artifacts/")
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        results = response.json()["results"]
+        self.assertEqual(results[0]["name"], "Second")
+        self.assertEqual(results[1]["name"], "First")

ee/migrations/0031_agentartifact.py

@@ -0,0 +1,57 @@
+# Generated by Django 4.2.26 on 2025-11-20 14:41
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+import posthog.models.utils
+
+import ee.models.assistant
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("posthog", "0909_survey_add_linked_insight_id"),
+        ("ee", "0030_singlesessionsummary_distinct_id_and_more"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="AgentArtifact",
+            fields=[
+                (
+                    "id",
+                    models.UUIDField(
+                        default=posthog.models.utils.uuid7, editable=False, primary_key=True, serialize=False
+                    ),
+                ),
+                (
+                    "short_id",
+                    models.CharField(
+                        db_index=True, default=ee.models.assistant.generate_short_id_6, max_length=6, unique=True
+                    ),
+                ),
+                ("name", models.CharField(max_length=400)),
+                (
+                    "type",
+                    models.CharField(
+                        choices=[("visualization", "Visualization"), ("document", "Document")], max_length=50
+                    ),
+                ),
+                ("content", models.JSONField()),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                (
+                    "conversation",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE, related_name="artifacts", to="ee.conversation"
+                    ),
+                ),
+                ("team", models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to="posthog.team")),
+            ],
+            options={
+                "indexes": [
+                    models.Index(fields=["conversation", "created_at"], name="ee_agentart_convers_550347_idx"),
+                    models.Index(fields=["team", "created_at"], name="ee_agentart_team_id_3789b3_idx"),
+                ],
+            },
+        ),
+    ]

ee/migrations/max_migration.txt

@@ -1 +1 @@
-0030_singlesessionsummary_distinct_id_and_more
+0031_agentartifact