List all 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
    }
  ]
}

{
  "error": {
    "message": "<string>"
  }
}

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
    }
  ]
}

{
  "error": {
    "message": "<string>"
  }
}

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();

Authorizations

Key

string

header

required

Response

data

Agent · object[]

required

Show child attributes

Client API

Agents

Interactions

Messages

Users

Authorizations

Response