Skip to main content
GET
Get a sub-agent

Authorizations

X-Api-Key
string
header
required

Headers

X-Api-Key
string
required

Api key to pass as a X-Api-Key request header.

Path Parameters

subAgentId
string
required

ID of the sub-agent.

Response

Success

Full configuration of a sub-agent. Workspace files, code execution and the per-message command are managed from the Starleads interface and are not exposed here.

id
string | null

Sub-agent identifier

name
string | null

Technical name, in snake_case. The agent delegates to it under the tool name subagent_{name}.

displayName
string | null

Human-readable name

description
string | null

Tells the agent when to delegate to this sub-agent

avatar
string | null

Avatar identifier (av_XXXX)

systemPrompt
string | null

Instructions the sub-agent follows

model
string | null

Model the sub-agent runs on

toolIds
string[] | null

Tools the sub-agent can call itself

params
object | null

Values injected into the system prompt

timeout
integer<int32>

Call timeout in seconds

maxDurationS
integer<int32>

Maximum processing time per message in seconds; past it the sub-agent answers with what it has. 0 means unlimited.

inactivityExpirationMin
integer<int32> | null

Minutes of inactivity after which the delegated conversation expires

hardDeadlineUtc
string<date-time> | null

Absolute end of the delegated conversation, UTC

tags
string[] | null

Free labels

createdAt
string<date-time>
updatedAt
string<date-time>