Artifact (v1)

magick_mind.models.v1.artifact

Artifact models for Magick Mind SDK v1 API.

Provides Pydantic models for file upload and artifact management using presigned S3 URLs and webhook-based completion confirmation.

class ArtifactStatusEnum(str, Enum)

Lifecycle status values for an artifact.

class Artifact(BaseModel)

Canonical artifact model representing an uploaded file.

Artifacts are files (documents, images, etc.) uploaded to S3 and associated with a corpus or other container in the backend.

Allow additional fields from API responses

class PresignArtifactRequest(BaseModel)

Request for obtaining a presigned S3 upload URL.

class PresignArtifactResponse(BaseModel)

Response containing presigned upload URL and metadata.

class GetArtifactResponse(BaseModel)

Response for getting a single artifact by ID.

Matches the {"artifact": {...}} envelope returned by GET /v1/artifacts/{id}.

class ListArtifactsResponse(BaseModel)

Response for listing/querying artifacts.

Matches the {"data": [...]} envelope returned by GET /v1/artifacts.

class DownloadUrlResponse(BaseModel)

Response for retrieving a presigned artifact download URL.

Returned by GET /v1/artifacts/{id}/download.

class DeleteArtifactResponse(BaseModel)

Response for deleting an artifact.

class FinalizeArtifactRequest(BaseModel)

Client-driven finalize request (fallback when webhook is unavailable).

class FinalizeArtifactResponse(BaseModel)

Response for finalize operation.

class ArtifactWebhookPayload(BaseModel)

Webhook payload sent from S3 Lambda or client finalize.

This is the shape of data sent to the webhook endpoint after an artifact upload is complete.