Skip to main content

Endpoint

Authentication

Requires JWT authentication via Authorization: Bearer <token> header.

Description

Retrieves complete information about a specific agent, including its current version configuration, tools, MCP integrations, and metadata. The agent must belong to the authenticated user.

Path Parameters

string
required
The unique identifier (UUID) of the agent to retrieve.

Response

Returns the agent object with full configuration including the current active version.
string
Unique identifier for the agent (UUID format)
string
Agent name
string
Agent description (if set)
string
Current system prompt from active version
string
AI model identifier (e.g., “kortix/basic”, “openai/gpt-4”)
string
Icon identifier from the icon library
string
Icon color in hex format
string
Icon background color in hex format
boolean
Whether this agent is the default for new threads
boolean
Whether this agent is publicly shared (enterprise feature)
array
Array of tag strings for categorization
string
UUID of the currently active version
integer
Total number of versions for this agent
object
Complete configuration of the active version
array
MCP integrations from current version (flattened for convenience)
array
Custom MCP servers from current version (flattened for convenience)
object
Tool configurations from current version (flattened for convenience)
object
Additional agent metadata (e.g., is_suna_default, restrictions)
string
ISO 8601 timestamp when agent was created
string
ISO 8601 timestamp of last update

Examples

Response Example

Error Responses

error
Agent does not exist or user does not have access
error
Missing or invalid authentication token
error
Server error retrieving agent

Use Cases

Inspect Agent Configuration

Retrieve complete configuration before starting a run or making updates:

Version History

Check how many versions exist:

Validate Agent Before Run

Ensure agent has required capabilities:

Notes

  • Full Configuration: This endpoint loads the complete agent configuration including the current version
  • Flattened Fields: The system_prompt, model, configured_mcps, custom_mcps, and agentpress_tools fields at the top level mirror the current version for convenience
  • Version Access: Only the current active version is returned; use the versions API to access historical versions
  • Metadata: The metadata field may contain special flags like is_suna_default or restrictions for system agents