Skip to content
UltimateTeam.ai Docs

Get agent detail

GET
/api/v1/agents/{role}
curl --request GET \
  --url https://api.ultimateteam.ai/api/v1/agents/example \
  --header 'X-API-Key: <X-API-Key>'

Return full configuration for a specific agent role.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
role
required
Role

The agent role identifier

string

The agent role identifier

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
AgentDetailResponse

Wrapper response for GET /agents/{role}.

Attributes: data: The agent detail payload.

object
data
required
AgentDetailData

Detail payload for GET /agents/{role}.

Attributes: config: The full agent configuration.

object
config
required
AgentConfigData

Full agent config returned by GET /agents/{role}.

Attributes: id: Unique agent config identifier. role: Agent role identifier. display_name: Human-readable name. agent_name: Optional persona name. status: Lifecycle status. model_tier: The LLM tier. autonomy_overrides: Per-agent autonomy level overrides. tools_enabled: List of enabled tool names. color: Optional hex color. forged: Whether this is a custom-forged agent. character_profile: Optional personality traits dict.

object
agent_name
required
Any of:
string
autonomy_overrides
required
Autonomy Overrides
object
key
additional properties
any
character_profile
Any of:
object
key
additional properties
any
color
required
Any of:
string
display_name
required
Display Name
string
forged
required
Forged
boolean
id
required
Id
string format: uuid
model_tier
required
Model Tier
string
role
required
Role
string
status
required
Status
string
tools_enabled
required
Tools Enabled
Array<string>
Examplegenerated
{
  "data": {
    "config": {
      "agent_name": "example",
      "autonomy_overrides": {},
      "character_profile": {},
      "color": "example",
      "display_name": "example",
      "forged": true,
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "model_tier": "example",
      "role": "example",
      "status": "example",
      "tools_enabled": [
        "example"
      ]
    }
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}