Client API
Interactions
Messages
Agents
List all agents
Returns a list of agents that belong to the current project. The agents are returned sorted by creation date, with the most recently created agents appearing first.
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
The response is of type object
.
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
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.