Resource
ai_agent
A reusable AI agent persona definition for LLM-driven workflow tasks
Configuration
nameString!RequiredDisplay name
descriptionStringOptionalOptional description
roleString!RequiredShort role title
goalString!RequiredWhat this agent is trying to achieve
backstoryString!RequiredRich context about expertise and perspective
adapterIdAIAdapterID!RequiredWhich AI adapter to use
References ai_adapter
modelStringOptionalModel override
temperatureFloatOptionalTemperature override
maxTokensIntOptionalMax response tokens override
systemPromptTemplateStringOptionalAdditional system prompt template
responseFormatAgentResponseFormat!OptionalExpected output format
Allowed values
TEXT — Free-form text response
JSON — Structured JSON response
TASK_OUTCOME — Task outcome response with outcome and outcomeData
maxIterationsInt!OptionalMax tool-calling iterations
tools[AgentToolRef!]!OptionalTools this agent can use
allowedGraphQLOperations[String!]OptionalAllowlist of GraphQL operations
maxExecutionTimeSecondsIntOptionalTimeout for a single invocation
Input types
Fields for the structured values used in this resource’s configuration.
AgentToolRefInput
Input for an agent tool reference
typeAgentToolType!RequiredTool type
Allowed values
GRAPHQL — Execute GraphQL queries/mutations
SCRIPT — Execute a Lua script by ID
HTTP_REQUEST — Make HTTP requests
DATA_LOOKUP — Query domain data (read-only GraphQL)
configStringOptionalTool-specific configuration as JSON string
Read-only values
Lifecycle
The CLI can create this resource. The platform assigns its id.
When replacement is needed, the existing resource is removed before its replacement is created.