Get Agent API Definition
The Get Agent API enables you to retrieve the complete configuration and operational details of a specific AI agent, providing comprehensive visibility into agent capabilities, tool integrations, behavioral instructions, and metadata. This API is essential for agent debugging, configuration auditing, and understanding agent behavior during development and production operations.
Development teams and administrators use this API to inspect agent configurations before creating sessions, troubleshoot agent behavior issues, clone agent configurations for new deployments, and maintain documentation of agent capabilities across their enterprise AI infrastructure.
Get Agent Request and Response
To retrieve an agent, send a GET request to /v2/agents/{agent_key}. You specify the following parameter in the URL path:
agent_key(string, required): Unique agent identifier following the patternagt_[0-9a-zA-Z_-]+$
The response includes the complete agent configuration with all tools, instructions, model parameters, and metadata as originally configured during agent creation or subsequent updates.
Example Request
GET /v2/agents/agt_customer_support_001
Example Response
1
Error Responses
The API returns standard HTTP error codes with detailed error information:
| HTTP Code | Error Code | Description |
|---|---|---|
| 400 | invalid_request | Invalid agent_key format or malformed request |
| 401 | unauthorized | Invalid or missing API key |
| 403 | forbidden | Insufficient permissions for accessing this agent |
| 404 | agent_not_found | Agent with the specified ID does not exist |
| 429 | rate_limit_exceeded | Request rate limit exceeded |