Proficient AI Documentation home page

Request Access
GitHub
Request Access

Agents

List all agents

Admin API

Introduction
Authentication
Specification

Agents

GET
List all agents
POST
Create an agent
GET
Retrieve an agent
POST
Update an agent
DEL
Delete an agent
GET
Retrieve agent configuration
POST
Update agent configuration
POST
Activate an agent
POST
Deactivate an agent

Users

GET
List all users
POST
Create a user
GET
Retrieve a user
POST
Update a user
DEL
Delete a user

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

Key

string

Key

Required

string

Response

200 - application/json

data

object[]

required

data.id

string

required

The unique identifier of the agent

data.object

enum<string>

required

The type of the Agent object

Available options:

agent

data.active

boolean

required

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

data.description

string

required

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

data.display_description

string

required

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

data.display_name

string

required

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

data.name

string

required

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

data.created_at

integer

required

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

data.updated_at

integer

required

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

Specification Create an agent

discord github twitter linkedin