CreateFileResponse

Response payload for a File endpoint.

Definition

TypeScript
interface CreateFileResponse {
  file: {
    id: string;
    workspaceId: string;
    directoryId: string;
    name: string;
    mime: string | null;
    size: number | null;
    status: "error" | "ready" | "uploading";
    errorMessage: string | null;
    metadata: any;
    createdBy: string | null;
    createdAt: string;
    updatedAt: string;
    finalizedAt: string | null;
    expiresAt: string | null;
  };
  parts: Array<{ partNumber: number; signedUrl: string }>;
}

Fields

FieldTypeNotes
file{ id: string; workspaceId: string; directoryId: string; name: string; mime: string | null; size: number | null; status: "error" | "ready" | "uploading"; errorMessage: string | null; metadata: any; createdBy: string | null; createdAt: string; updatedAt: string; finalizedAt: string | null; expiresAt: string | null; }required — Newly-created file row in 'uploading' state.
partsArray<{ partNumber: number; signedUrl: string; }>required — Pre-signed URLs for each part of the multipart upload.