← All resources

Resource

ai_agent

A reusable AI agent persona definition for LLM-driven workflow tasks

GraphQL reference →

Configuration

nameString!Required

Display name

descriptionStringOptional

Optional description

roleString!Required

Short role title

goalString!Required

What this agent is trying to achieve

backstoryString!Required

Rich context about expertise and perspective

adapterIdAIAdapterID!Required

Which AI adapter to use

References ai_adapter

modelStringOptional

Model override

temperatureFloatOptional

Temperature override

maxTokensIntOptional

Max response tokens override

systemPromptTemplateStringOptional

Additional system prompt template

responseFormatAgentResponseFormat!Optional

Expected output format

Allowed values

TEXT — Free-form text response

JSON — Structured JSON response

TASK_OUTCOME — Task outcome response with outcome and outcomeData

maxIterationsInt!Optional

Max tool-calling iterations

tools[AgentToolRef!]!Optional

Tools this agent can use

View AgentToolRefInput fields →

allowedGraphQLOperations[String!]Optional

Allowlist of GraphQL operations

maxExecutionTimeSecondsIntOptional

Timeout 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!Required

Tool 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)

configStringOptional

Tool-specific configuration as JSON string

Read-only values

Show values
idAIAgentID!Read only

Unique identifier

computed by the platform

createdAtString!Read only

Creation timestamp (ISO8601)

computed by the platform

updatedAtString!Read only

Last update timestamp (ISO8601)

computed by the platform

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.