Agent

Field Type Behavior Description
name string OUTPUT_ONLY Resource name (agents/{id})
title string   Human-readable title for the agent
description string   Description of what this agent does
prompt string   Initial prompt used to start agent sessions
connections AgentConnection[]   Connections and their enabled tools for this agent
state AgentState   The operational state of the agent
plan_session string   The session that planned this agent, if created by an agent session (agents/{agent}/sessions/{session})
system boolean OUTPUT_ONLY Whether this is a system agent (auto-created, not user-managed)
created_by string OUTPUT_ONLY The ID of the user who created this agent
create_time timestamp OUTPUT_ONLY When the agent was created
update_time timestamp OUTPUT_ONLY When the agent was last modified
delete_time timestamp OUTPUT_ONLY When the agent was soft-deleted (null if active)

Example

{
  "name": "agents/error-rate-monitor",
  "title": "Error Rate Monitor",
  "description": "Monitors services for abnormal error rates and escalation patterns.",
  "prompt": "You are a monitoring agent for production services. Your job is to detect abnormal errors...",
  "connections": [
    {
      "name": "connections/prod-postgres",
      "enabledTools": ["TOOL_POSTGRES_QUERY"]
    },
    {
      "name": "connections/prod-prometheus",
      "enabledTools": ["TOOL_PROMQL_QUERY", "TOOL_PROMQL_QUERY_RANGE"]
    }
  ],
  "state": "AGENT_STATE_ON",
  "system": false,
  "createTime": "2026-02-21T20:37:33.623697Z",
  "updateTime": "2026-02-21T20:40:06.610686Z"
}

Agent State

Value Description
AGENT_STATE_UNSPECIFIED Default value, not used
AGENT_STATE_ON Agent is active and running
AGENT_STATE_OFF Agent is disabled
AGENT_STATE_REVIEW_REQUIRED Agent requires human review before activation
AGENT_STATE_RECOMMENDED Agent is recommended but not yet activated

Agent Connection

Field Type Description
name string Resource name of the connection (connections/{connection})
enabled_tools Tool[] List of tools enabled for this agent from this connection. If empty, all tools configured on the connection are enabled.

This site uses Just the Docs, a documentation theme for Jekyll.