@elizaos/core v1.0.6 / v1 / Character

Type Alias: Character

Character: object

Configuration for an agent character

Type declaration

id?

optional id: UUID

Optional unique identifier

name

name: string

Character name

username?

optional username: string

Optional username

email?

optional email: string

Optional email

system?

optional system: string

Optional system prompt

modelProvider

modelProvider: ModelProviderName

Model provider to use

imageModelProvider?

optional imageModelProvider: ModelProviderName

Image model provider to use, if different from modelProvider

imageVisionModelProvider?

optional imageVisionModelProvider: ModelProviderName

Image Vision model provider to use, if different from modelProvider

modelEndpointOverride?

optional modelEndpointOverride: string

Optional model endpoint override

templates?

optional templates: object

Optional prompt templates

templates.goalsTemplate?

optional goalsTemplate: TemplateType

templates.factsTemplate?

optional factsTemplate: TemplateType

templates.messageHandlerTemplate?

optional messageHandlerTemplate: TemplateType

templates.shouldRespondTemplate?

optional shouldRespondTemplate: TemplateType

templates.continueMessageHandlerTemplate?

optional continueMessageHandlerTemplate: TemplateType

templates.evaluationTemplate?

optional evaluationTemplate: TemplateType

templates.twitterSearchTemplate?

optional twitterSearchTemplate: TemplateType

templates.twitterActionTemplate?

optional twitterActionTemplate: TemplateType

templates.twitterPostTemplate?

optional twitterPostTemplate: TemplateType

templates.twitterMessageHandlerTemplate?

optional twitterMessageHandlerTemplate: TemplateType

templates.twitterShouldRespondTemplate?

optional twitterShouldRespondTemplate: TemplateType

templates.twitterVoiceHandlerTemplate?

optional twitterVoiceHandlerTemplate: TemplateType

templates.instagramPostTemplate?

optional instagramPostTemplate: TemplateType

templates.instagramMessageHandlerTemplate?

optional instagramMessageHandlerTemplate: TemplateType

templates.instagramShouldRespondTemplate?

optional instagramShouldRespondTemplate: TemplateType

templates.farcasterPostTemplate?

optional farcasterPostTemplate: TemplateType

templates.lensPostTemplate?

optional lensPostTemplate: TemplateType

templates.farcasterMessageHandlerTemplate?

optional farcasterMessageHandlerTemplate: TemplateType

templates.lensMessageHandlerTemplate?

optional lensMessageHandlerTemplate: TemplateType

templates.farcasterShouldRespondTemplate?

optional farcasterShouldRespondTemplate: TemplateType

templates.lensShouldRespondTemplate?

optional lensShouldRespondTemplate: TemplateType

templates.telegramMessageHandlerTemplate?

optional telegramMessageHandlerTemplate: TemplateType

templates.telegramShouldRespondTemplate?

optional telegramShouldRespondTemplate: TemplateType

templates.telegramAutoPostTemplate?

optional telegramAutoPostTemplate: string

templates.telegramPinnedMessageTemplate?

optional telegramPinnedMessageTemplate: string

templates.discordAutoPostTemplate?

optional discordAutoPostTemplate: string

templates.discordAnnouncementHypeTemplate?

optional discordAnnouncementHypeTemplate: string

templates.discordVoiceHandlerTemplate?

optional discordVoiceHandlerTemplate: TemplateType

templates.discordShouldRespondTemplate?

optional discordShouldRespondTemplate: TemplateType

templates.discordMessageHandlerTemplate?

optional discordMessageHandlerTemplate: TemplateType

templates.slackMessageHandlerTemplate?

optional slackMessageHandlerTemplate: TemplateType

templates.slackShouldRespondTemplate?

optional slackShouldRespondTemplate: TemplateType

templates.jeeterPostTemplate?

optional jeeterPostTemplate: string

templates.jeeterSearchTemplate?

optional jeeterSearchTemplate: string

templates.jeeterInteractionTemplate?

optional jeeterInteractionTemplate: string

templates.jeeterMessageHandlerTemplate?

optional jeeterMessageHandlerTemplate: string

templates.jeeterShouldRespondTemplate?

optional jeeterShouldRespondTemplate: string

templates.devaPostTemplate?

optional devaPostTemplate: string

bio

bio: string | string[]

Character biography

lore

lore: string[]

Character background lore

messageExamples

messageExamples: MessageExample[][]

Example messages

postExamples

postExamples: string[]

Example posts

topics

topics: string[]

Known topics

adjectives

adjectives: string[]

Character traits

knowledge?

optional knowledge: (string | object | object)[]

Optional knowledge base

plugins

plugins: Plugin[]

Available plugins

postProcessors?

optional postProcessors: Pick<Plugin, "name" | "description" | "handlePostCharacterLoaded">[]

Character Processor Plugins

settings?

optional settings: object

Optional configuration

settings.secrets?

optional secrets: object

Index Signature

[key: string]: string

settings.intiface?

optional intiface: boolean

settings.imageSettings?

optional imageSettings: object

settings.imageSettings.steps?

optional steps: number

settings.imageSettings.width?

optional width: number

settings.imageSettings.height?

optional height: number

settings.imageSettings.cfgScale?

optional cfgScale: number

settings.imageSettings.negativePrompt?

optional negativePrompt: string

settings.imageSettings.numIterations?

optional numIterations: number

settings.imageSettings.guidanceScale?

optional guidanceScale: number

settings.imageSettings.seed?

optional seed: number

settings.imageSettings.modelId?

optional modelId: string

settings.imageSettings.jobId?

optional jobId: string

settings.imageSettings.count?

optional count: number

settings.imageSettings.stylePreset?

optional stylePreset: string

settings.imageSettings.hideWatermark?

optional hideWatermark: boolean

settings.imageSettings.safeMode?

optional safeMode: boolean

settings.voice?

optional voice: object

settings.voice.model?

optional model: string

settings.voice.url?

optional url: string

settings.voice.elevenlabs?

optional elevenlabs: object

settings.voice.elevenlabs.voiceId

voiceId: string

settings.voice.elevenlabs.model?

optional model: string

settings.voice.elevenlabs.stability?

optional stability: string

settings.voice.elevenlabs.similarityBoost?

optional similarityBoost: string

settings.voice.elevenlabs.style?

optional style: string

settings.voice.elevenlabs.useSpeakerBoost?

optional useSpeakerBoost: string

settings.model?

optional model: string

settings.modelConfig?

optional modelConfig: ModelConfiguration

settings.embeddingModel?

optional embeddingModel: string

settings.chains?

optional chains: object

Index Signature

[key: string]: string | any[]

settings.chains.evm?

optional evm: any[]

settings.chains.solana?

optional solana: any[]

settings.transcription?

optional transcription: TranscriptionProvider

settings.ragKnowledge?

optional ragKnowledge: boolean

clientConfig?

optional clientConfig: object

Optional client-specific config

clientConfig.discord?

optional discord: object

clientConfig.discord.shouldIgnoreBotMessages?

optional shouldIgnoreBotMessages: boolean

clientConfig.discord.shouldIgnoreDirectMessages?

optional shouldIgnoreDirectMessages: boolean

clientConfig.discord.shouldRespondOnlyToMentions?

optional shouldRespondOnlyToMentions: boolean

clientConfig.discord.messageSimilarityThreshold?

optional messageSimilarityThreshold: number

clientConfig.discord.isPartOfTeam?

optional isPartOfTeam: boolean

clientConfig.discord.teamAgentIds?

optional teamAgentIds: string[]

clientConfig.discord.teamLeaderId?

optional teamLeaderId: string

clientConfig.discord.teamMemberInterestKeywords?

optional teamMemberInterestKeywords: string[]

clientConfig.discord.allowedChannelIds?

optional allowedChannelIds: string[]

clientConfig.discord.autoPost?

optional autoPost: object

clientConfig.discord.autoPost.enabled?

optional enabled: boolean

clientConfig.discord.autoPost.monitorTime?

optional monitorTime: number

clientConfig.discord.autoPost.inactivityThreshold?

optional inactivityThreshold: number

clientConfig.discord.autoPost.mainChannelId?

optional mainChannelId: string

clientConfig.discord.autoPost.announcementChannelIds?

optional announcementChannelIds: string[]

clientConfig.discord.autoPost.minTimeBetweenPosts?

optional minTimeBetweenPosts: number

clientConfig.telegram?

optional telegram: object

clientConfig.telegram.shouldIgnoreBotMessages?

optional shouldIgnoreBotMessages: boolean

clientConfig.telegram.shouldIgnoreDirectMessages?

optional shouldIgnoreDirectMessages: boolean

clientConfig.telegram.shouldRespondOnlyToMentions?

optional shouldRespondOnlyToMentions: boolean

clientConfig.telegram.shouldOnlyJoinInAllowedGroups?

optional shouldOnlyJoinInAllowedGroups: boolean

clientConfig.telegram.allowedGroupIds?

optional allowedGroupIds: string[]

clientConfig.telegram.messageSimilarityThreshold?

optional messageSimilarityThreshold: number

clientConfig.telegram.isPartOfTeam?

optional isPartOfTeam: boolean

clientConfig.telegram.teamAgentIds?

optional teamAgentIds: string[]

clientConfig.telegram.teamLeaderId?

optional teamLeaderId: string

clientConfig.telegram.teamMemberInterestKeywords?

optional teamMemberInterestKeywords: string[]

clientConfig.telegram.autoPost?

optional autoPost: object

clientConfig.telegram.autoPost.enabled?

optional enabled: boolean

clientConfig.telegram.autoPost.monitorTime?

optional monitorTime: number

clientConfig.telegram.autoPost.inactivityThreshold?

optional inactivityThreshold: number

clientConfig.telegram.autoPost.mainChannelId?

optional mainChannelId: string

clientConfig.telegram.autoPost.pinnedMessagesGroups?

optional pinnedMessagesGroups: string[]

clientConfig.telegram.autoPost.minTimeBetweenPosts?

optional minTimeBetweenPosts: number

clientConfig.slack?

optional slack: object

clientConfig.slack.shouldIgnoreBotMessages?

optional shouldIgnoreBotMessages: boolean

clientConfig.slack.shouldIgnoreDirectMessages?

optional shouldIgnoreDirectMessages: boolean

clientConfig.gitbook?

optional gitbook: object

clientConfig.gitbook.keywords?

optional keywords: object

clientConfig.gitbook.keywords.projectTerms?

optional projectTerms: string[]

clientConfig.gitbook.keywords.generalQueries?

optional generalQueries: string[]

clientConfig.gitbook.documentTriggers?

optional documentTriggers: string[]

style

style: object

Writing style guides

style.all

all: string[]

style.chat

chat: string[]

style.post

post: string[]

twitterProfile?

optional twitterProfile: object

Optional Twitter profile

twitterProfile.id

id: string

twitterProfile.username

username: string

twitterProfile.screenName

screenName: string

twitterProfile.bio

bio: string

twitterProfile.nicknames?

optional nicknames: string[]

instagramProfile?

optional instagramProfile: object

Optional Instagram profile

instagramProfile.id

id: string

instagramProfile.username

username: string

instagramProfile.bio

bio: string

instagramProfile.nicknames?

optional nicknames: string[]

simsaiProfile?

optional simsaiProfile: object

Optional SimsAI profile

simsaiProfile.id

id: string

simsaiProfile.username

username: string

simsaiProfile.screenName

screenName: string

simsaiProfile.bio

bio: string

nft?

optional nft: object

Optional NFT prompt

nft.prompt

prompt: string

extends?

optional extends: string[]

Optinal Parent characters to inherit information from

twitterSpaces?

optional twitterSpaces: TwitterSpaceDecisionOptions

Defined in

packages/core/src/specs/v1/types.ts:739