Skip to main content

@elizaos/core v1.0.6 / v2 / Task

Interface: Task

Represents a task to be performed, often in the background or at a later time. Tasks are managed by the AgentRuntime and processed by registered TaskWorkers. They can be associated with a room, world, and tagged for categorization and retrieval. The IDatabaseAdapter handles persistence of task data.

Properties​

id?​

optional id: `${string}-${string}-${string}-${string}-${string}`

Optional. A Universally Unique Identifier for the task. Generated if not provided.

Defined in​

packages/core/src/specs/v2/types.ts:1615

name​

name: string

The name of the task, which should correspond to a registered TaskWorker.name.

Defined in​

packages/core/src/specs/v2/types.ts:1617

updatedAt?​

optional updatedAt: number

Optional. Timestamp of the last update to this task.

Defined in​

packages/core/src/specs/v2/types.ts:1619

metadata?​

optional metadata: TaskMetadata

Optional. Metadata associated with the task, conforming to TaskMetadata.

Defined in​

packages/core/src/specs/v2/types.ts:1621

description​

description: string

A human-readable description of what the task does or its purpose.

Defined in​

packages/core/src/specs/v2/types.ts:1623

roomId?​

optional roomId: `${string}-${string}-${string}-${string}-${string}`

Optional. The UUID of the room this task is associated with.

Defined in​

packages/core/src/specs/v2/types.ts:1625

worldId?​

optional worldId: `${string}-${string}-${string}-${string}-${string}`

Optional. The UUID of the world this task is associated with.

Defined in​

packages/core/src/specs/v2/types.ts:1627