Actor

This page is auto-generated from the formations OpenAPI spec. Do not edit manually — run pnpm generate-formations-resource-docs to regenerate.

Creates a stateful conversation actor that wraps an agent or chat session and optionally links to a memory store.

Syntax

type: actor
properties:
  name: String
  external_id: String
  instructions: String
  agent_id: String
  chat_id: String
  memory_id: String
  auto_create_memory: Boolean

Output

The physical resource ID is the public ID of the created resource. Reference it from other resources with a ref expression:

      some_field:
        ref: MyActor

Properties

name

Actor display name

Required: Yes Type: String

---

external_id

External identifier for idempotent actor creation

Required: No Type: String Nullable: Yes

---

instructions

Persona-specific instructions

Required: No Type: String Nullable: Yes

---

agent_id

Linked agent ID (mutually exclusive with chat_id)

Required: No Type: String Nullable: Yes

---

chat_id

Linked chat ID (mutually exclusive with agent_id)

Required: No Type: String Nullable: Yes

---

memory_id

Linked memory ID

Required: No Type: String Nullable: Yes

---

auto_create_memory

Whether to auto-create memory when actor is created

Required: No Type: Boolean

---