## Get Agent by Name

`agents.retrieve_by_name(stragent_name)  -> Agent`

**get** `/agents/name/{agent_name}`

Get an agent by its unique name.

### Parameters

- `agent_name: str`

### Returns

- `class Agent: …`

  - `id: str`

    The unique identifier of the agent.

  - `acp_type: AcpType`

    The type of the ACP Server (Either sync or async)

    - `"sync"`

    - `"async"`

    - `"agentic"`

  - `created_at: datetime`

    The timestamp when the agent was created

  - `description: str`

    The description of the action.

  - `name: str`

    The unique name of the agent.

  - `updated_at: datetime`

    The timestamp when the agent was last updated

  - `agent_input_type: Optional[Literal["text", "json"]]`

    The type of input the agent expects.

    - `"text"`

    - `"json"`

  - `production_deployment_id: Optional[str]`

    ID of the current production deployment.

  - `registered_at: Optional[datetime]`

    The timestamp when the agent was last registered

  - `registration_metadata: Optional[Dict[str, object]]`

    The metadata for the agent's registration.

  - `status: Optional[Literal["Ready", "Failed", "Unknown", 3 more]]`

    The status of the action, indicating if it's building, ready, failed, etc.

    - `"Ready"`

    - `"Failed"`

    - `"Unknown"`

    - `"Deleted"`

    - `"Unhealthy"`

    - `"BuildOnly"`

  - `status_reason: Optional[str]`

    The reason for the status of the action.

### Example

```python
import os
from agentex import Agentex

client = Agentex(
    api_key=os.environ.get("AGENTEX_SDK_API_KEY"),  # This is the default and can be omitted
)
agent = client.agents.retrieve_by_name(
    "agent_name",
)
print(agent.id)
```

#### Response

```json
{
  "id": "id",
  "acp_type": "sync",
  "created_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "name": "name",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "agent_input_type": "text",
  "production_deployment_id": "production_deployment_id",
  "registered_at": "2019-12-27T18:11:19.117Z",
  "registration_metadata": {
    "foo": "bar"
  },
  "status": "Ready",
  "status_reason": "status_reason"
}
```