export type AgentConfig = {
model?: string
/**
* Default model variant for this agent (applies only when using the agent's configured model).
*/
variant?: string
temperature?: number
top_p?: number
prompt?: string
/**
* @deprecated Use 'permission' field instead
*/
tools?: {
[key: string]: boolean
}
disable?: boolean
/**
* Description of when to use the agent
*/
description?: string
mode?: "subagent" | "primary" | "all"
/**
* Hide this subagent from the @ autocomplete menu (default: false, only applies to mode: subagent)
*/
hidden?: boolean
options?: {
[key: string]: unknown
}
/**
* Hex color code (e.g., #FF5733) or theme color (e.g., primary)
*/
color?: string | "primary" | "secondary" | "accent" | "success" | "warning" | "error" | "info"
/**
* Maximum number of agentic iterations before forcing text-only response
*/
steps?: number
/**
* @deprecated Use 'steps' field instead.
*/
maxSteps?: number
permission?: PermissionConfig
[key: string]:
| unknown
| string
| number
| {
[key: string]: boolean
}
| boolean
| "subagent"
| "primary"
| "all"
| {
[key: string]: unknown
}
| string
| "primary"
| "secondary"
| "accent"
| "success"
| "warning"
| "error"
| "info"
| number
| PermissionConfig
| undefined
}
Protocol types
AgentConfig
Exact type definition referenced by the public SDK.
This definition is generated from the same source as the SDK. Protocol types describe the runtime HTTP API; prefer the high-level SDK for session ownership and callbacks.
Related types: PermissionConfig.