Formation Resource Types

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

Each resource type that can be declared in a Formation template is listed below. Click a type to see its full properties reference.

Output

All resource types return the public ID of the created resource as their output. You can reference this ID in other resource properties with a ref expression:

resources:
  MyMemory:
    type: memory
    properties:
      name: My Memory

  MyEntry:
    type: memory_entry
    properties:
      memory_id:
        ref: MyMemory   # resolves to the public ID of MyMemory
      content: Hello, world

Types

Type	Description
ai_provider	Configures an LLM provider connection (API key, model, endpoint) that agents use to generate responses.
tool	Defines a tool (HTTP endpoint, MCP server, or SOAT action) that agents can invoke during a generation.
agent	Creates an AI agent backed by a provider. The agent handles requests, runs tools, and can be attached to actors.
actor	Creates a stateful conversation actor that wraps an agent or chat session and optionally links to a memory store.
api_key	Creates an API key scoped to the formation's project and optionally restricted by a set of policies. The key is owned by the project owner.
chat	Creates a chat connected to an AI provider within the formation's project.
conversation	Creates a conversation within the formation's project.
document	Stores a text document in a project, optionally indexing it for knowledge retrieval.
file	Registers a file record within the formation's project.
memory	Creates a named memory store that actors can read from and write to across conversations.
memory_entry	Adds a single text entry to a memory store.
policy	Creates an access-control policy within the formation's project.
secret	Creates an encrypted secret within the formation's project.
session	Creates a session attached to an agent within the formation's project.
webhook	Registers an HTTPS endpoint to receive SOAT platform event notifications.