Skip to content
Ishvana Ishvana Docs

Get detailed agent information

GET
/api/agents/architecture/agent/{agent_id}

Return the full declarative definition for a single agent.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
agent_id
required
Agent Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

AgentDetailsResponse

Detailed agent information response model.

Provides comprehensive information about a specific agent including capabilities, configuration, status, and metadata. Used for agent detail endpoints to retrieve complete agent information for discovery and monitoring.

Fields:

  • id: Unique agent identifier
  • name: Human-readable agent display name
  • description: Agent purpose and capabilities description
  • type: Agent type (background/active/hybrid)
  • category: Functional category classification
  • priority: System priority level
  • status: Current operational status
  • auto_start: Automatic startup configuration flag
  • user_visible: UI visibility flag
  • requires_user_permission: Permission requirements flag
  • can_modify_system: System modification capability flag
  • resource_requirements: Dictionary of resource needs
  • dependencies: Dictionary of agent dependencies
  • metadata: Dictionary containing version and timestamp information

Usage: GET /api/agent-communication/agents/{agent_id} returns this response model.

JSON Example:

{
  "id": "hawken",
  "name": "HAWKEN",
  "description": "Creative writing and storytelling",
  "type": "active",
  "category": "creative_writing",
  "priority": "HIGH",
  "status": "online",
  "autoStart": true,
  "userVisible": true,
  "requiresUserPermission": false,
  "canModifySystem": true,
  "resourceRequirements": {"cpu": "high", "memory": "medium"},
  "dependencies": {"etherforce": "required"},
  "metadata": {"version": "2.0.0", "lastUpdated": "2025-01-31T10:30:00Z"}
}
object
id
required
Id

Agent unique identifier

string
name
required
Name

Agent display name

string
description
required
Description

Agent purpose and capabilities

string
type
required
Type

Agent type (background/active/hybrid)

string
category
required
Category

Functional category

string
priority
required
Priority

System priority level

string
status
required
Status

Current operational status

string
autoStart
required
Autostart

Automatic startup configuration

boolean
userVisible
required
Uservisible

UI visibility flag

boolean
requiresUserPermission
required
Requiresuserpermission

Permission requirements

boolean
canModifySystem
required
Canmodifysystem

System modification capability

boolean
resourceRequirements
required

Resource needs

object
key
additional properties
any
dependencies
required

Agent dependencies

object
key
additional properties
any
metadata
required

Version and timestamp

object
key
additional properties
any

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object