Skip to main content

Type Alias: PluginSettingField

type PluginSettingField: components["schemas"]["PluginSettingField"];

Properties

PropertyTypeRequiredDescription
keystringYesUnique key for this setting (example: "apiKey")
type"text" | "number" | "email" | "select" | "boolean" | "password" | "chips"YesInput type (example: "password")
labelstringYesHuman-readable label (example: "OpenAI API Key")
descriptionstringNoHelp text (example: "Your API key from OpenAI dashboard")
requiredbooleanNoWhether this setting is required
defaultobjectNoDefault value
optionsstring[]NoOptions for select type
validationobjectNoValidation rules

Defined in

4Players/cortex-typescript-sdk/src/resources/plugins.ts:9