Get agent details
Learn more about get agent details.
Use the Get agent details to get the details of an agent. This lets you confirm an agent's configuration before you schedule or invoke it.
HTTP method and endpoint
Use the following HTTP method and endpoint path to get agent details.
GET {TenantURL}/ai/agentflow/api/v202605/{tenant_id}/agents/{agent_id}The following table describes the endpoint path parameters.
| Parameter | Type | Required | Description |
|---|---|---|---|
TenantURL | String | Yes | The base URL for your tenant. |
tenant_id | String | Yes | The unique identifier of your tenant. |
agent_id | String | Yes | The unique identifier of the agent. |
Request headers
The following request headers must be included.
| Header | Value | Required |
|---|---|---|
Authorization | <access_token> | Yes |
Request body
This operation does not require a request body.
Example request
Use the following example to see how a complete request is structured, with headers.
GET {TenantURL}/ai/agentflow/api/v202605/tenant-xyz/agents/example-id
Authorization: <access_token>Response body
The following table describes the fields returned in the response body.
| Parameter | Type | Description |
|---|---|---|
agent_id | String | The unique identifier of the agent. Use this when you create a schedule or invoke the agent. |
name | String | The display name of the agent. |
description | String | The description of what the agent does. |
tags | Array | The tags assigned to the agent for categorization. |
status | String | The status of the agent: active or archived. |
version | Integer | The latest published version number of the agent. |
updated_at | String | The date and time when the record was last updated. |
created_at | String | The date and time when the agent was created. Empty for agents that are built in. |
Example response
The following example shows a response with successful response.
{
"agent_id": "my-support-agent",
"name": "Customer Support Bot",
"description": "Handles customer support queries and escalations",
"tags": [
"support",
"customer-facing"
],
"status": "active",
"version": 3,
"updated_at": "2025-05-13T10:30:00Z",
"created_at": "2025-04-01T08:00:00Z"
}Error codes and recommended actions
The following table lists the possible error responses returned by this API.
| HTTP status | Description | Recommended action |
|---|---|---|
422 Unprocessable Entity | Validation Error | Review the request parameters or body, correct the invalid values, and resend the request. |