v1

latestOpenAPI 3.0.02026-07-26242779.3 KB

Get agent details

get/agents/{agentName}

Path parameters

agentNamestring required

Name of the agent to retrieve

Response

Agent details retrieved successfully

namestring

Name of the agent

regionstring

The region where the agent is deployed

readyboolean

Whether the latest deployment has passed validation and is ready. For scale-to-zero agents, this is true even when scaled down to zero replicas.

availableboolean

Whether the agent can accept new sessions. True when any pods are ready to handle traffic, or when scaled to zero but healthy (requests will queue and trigger scale-up). During rolling updates, this may be true even if ready is false, as old pods continue serving while new ones validate.

createdAtstring date-time

Creation timestamp of the agent

updatedAtstring date-time

Last update timestamp

desiredDeploymentIdstring

ID of the deployment that was requested. Use this to track which deployment should be running.

activeDeploymentIdstring

Deprecated: Use desiredDeploymentId instead. ID of the requested deployment.

reconciledDeploymentIdstring

ID of the deployment that the operator has actually reconciled. Compare with desiredDeploymentId to determine if a deployment update has been processed. When these match and ready is true, the deployment is fully complete.

activeDeploymentReadyboolean

Deprecated: Use ready instead. Whether the active deployment is ready. This field is redundant with ready and will be removed in a future version.

activeSessionCountinteger

Number of active sessions

agentProfilestring nullable

The agent profile used for resource allocation