Generate experiences with Puck AI
Read docs
API ReferenceData ModelAiFieldType

AiFieldType

A definition describing how Puck AI should handle a user-defined field type.

Params

ParamExampleTypeStatus
defaultValuedefaultValue: { label: "Countdown" }Any | Function-
descriptiondescription: "Renders a branded CTA"String-
schemaschema: { type: "string" }JSON Schema-

defaultValue

The value to use when adding this field.

Can be any value, or a function that receives some information about the instance:

{
  defaultValue: ({ componentName, fieldName }) => fieldName;
}

description

A description of this field for the model.

schema

The schema Puck AI should use to generate this field.