CreateElementBody

Request body for creating an Element.

Definition

TypeScript
interface CreateElementBody {
  workspaceId: string;
  name: string;
  description?: string | undefined;
  visibility?: "private" | "public" | undefined;
  files?: Array<{ path: string; content: string }> | undefined;
}

Fields

FieldTypeNotes
workspaceIdstringrequired — Workspace that will own the new element.
namestringrequired — Element name
descriptionstring | undefinedoptional — Element description
visibility"private" | "public" | undefinedoptional — Visibility: private (default) or public
filesArray<{ path: string; content: string; }> | undefinedoptional — File path relative to the element source root (e.g. src/element.tsx).