Sign in

v1

latestOpenAPI 3.1.02026-07-2691819.8 KB

Get Agent

Retrieve an agent.

get/api/v1/agents/{agent_name}

Path parameters

agent_namestring required
Example:customer-support-agent

Headers

Authorizationstring required
Example:Bearer 123

Response

Successful Response

agent_namestring required

Unique identifier for the agent.

descriptionstring nullable
agent_numberinteger required

Unique number assigned to the agent.

created_atstring date-time required
deprecated_atstring date-time nullable

Example response

{
  "agent_name": "customer-support-agent",
  "agent_number": 1,
  "created_at": "2023-01-01T00:00:00Z",
  "description": "An agent that helps customers with their inquiries."
}