GET
/
agents
import { ProficientClient } from "@proficient/client";

const proficient = new ProficientClient({
  apiKey: process.env.PROFICIENT_AI_PUBLISHABLE_KEY,
  userExternalId: "...", // The user's unique ID in your system
});

const { data: agents } = await proficient.agents.list();

{
  "data": [
    {
      "id": "<string>",
      "object": "agent",
      "active": true,
      "description": "<string>",
      "display_description": "<string>",
      "display_name": "<string>",
      "name": "<string>",
      "created_at": 123,
      "updated_at": 123
    }
  ]
}
import { ProficientClient } from "@proficient/client";

const proficient = new ProficientClient({
  apiKey: process.env.PROFICIENT_AI_PUBLISHABLE_KEY,
  userExternalId: "...", // The user's unique ID in your system
});

const { data: agents } = await proficient.agents.list();

Response

200
application/json
​
data
object[]
required
<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>
SpecificationRetrieve an agent