GET
/
agents
/
{agent_id}

Path Parameters

agent_id
string
required

The unique identifier of the agent

Response

200 - application/json
<p>An _agent_ is an AI entity that exists to serve your project's users. Agents are intelligent, configurable and context-aware and can interact with your users via a messaging system enabled by the Proficient API.</p>
id
string
required

The unique identifier of the agent

object
enum<string>
required

The type of the Agent object

Available options:
agent
active
boolean
required

Whether the agent is currently active. If not, users will not be able to interact with the agent.

description
string
required

The description of the agent, intended for developers' reference.

display_description
string
required

The agent's public-facing description, meant to be visible to your users.

display_name
string
required

The agent's display name, intended to serve as the public-facing name visible to your users.

name
string
required

The name of the agent, designed to be visible to developers for internal reference purposes.

created_at
integer
required

The time at which the object was created, measured in milliseconds since the Unix epoch

updated_at
integer
required

The time at which the object was last updated, measured in milliseconds since the Unix epoch

List all agentsList all interactions