Agents
Instructions
Create and manage instructions that guide agent behavior.
Create instruction
Creates an instruction that defines how an agent behaves, reasons, and responds. Instructions act as system-level guidelines that shape the agent's tone, style, constraints, and tool usage.
List instructions
Lists all instructions available to the authenticated user, with optional filtering and pagination. The response includes high-level information about each instruction: the name, status, and version details.
Get instruction
Returns the full definition of an instruction, including its template, metadata, enabled status, and version. Instruction templates may contain Velocity expressions that reference tools and metadata. If no version is specified, the platform returns the latest version.
Update instruction
Updates an existing instruction's template, metadata, and configuration. Updated templates may include Velocity variables such as `$tools` or metadata references. Each update creates a new version. Agents continue to use existing versions until you change them explicitly.
Delete instruction
Deletes an instruction and all its associated configuration permanently.
Test instruction
Tests an instruction template with supplied context and available tools. The endpoint evaluates Velocity expressions such as `$tools`, `${session.metadata.field}`, or `${agent.metadata.field}`, and returns the fully rendered template output. Use this operation to validate formatting, logic, or metadata-dependent behavior before you deploy instructions to agents.
Delete instruction version
Deletes the specified version of the instruction permanently. This action cannot be undone.