Base URL

Client API Reference

Admin API Reference

Community & Support

GitHub

Proficient AI Documentation

Request Access

The API to interact with Proficient AI from backend applications

Introduction

Add a conversational AI agent to your app in 3 minutes

Why Proficient AI?

Concepts

Installation

Creating my first agent

Overview

React SDK

JavaScript Client SDK

Node.js Admin SDK

The API to interact with Proficient AI from client applications

Authentication

Specification

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.

List all agents

Retrieve an agent

Returns a list of interactions associated with the user. The interactions are returned sorted by creation date, with the most recently created interactions appearing first.

List all interactions

Creates a new `Interaction` with an agent.

Create an interaction

Retrieves the interaction with the given ID.

Retrieve an interaction

Updates the properties of the specified interaction. Only the provided properties will be updated. Any properties not provided will be left unchanged.

Update an interaction

Permanently deletes the specified interaction and all the messages within it. This cannot be undone.

Delete an interaction

Returns a list of all messages in the specified interaction.

List all messages in an interaction

Creates a new `Message` in a given `Interaction`

Create a message in an interaction

Retrieve a message

Requests a reply from the `Agent` to a given `Message`.

Ask for a reply to a message

Retrieve a user

Updates the properties of the specified user. Only the provided properties will be updated. Any properties not provided will be left unchanged.

Update a user

Creates a new agent with the given properties.

Create an agent

Updates the properties of the specified agent. Only the provided properties will be updated. Any properties not provided will be left unchanged.

Update an agent

Permanently deletes the specified agent and all the interactions associated with it. This cannot be undone.

Delete an agent

Retrieves the current configuration of the specified agent.

Retrieve agent configuration

Updates the configuration of the specified agent. Only the provided properties will be updated. Any properties not provided will be left unchanged.

Update agent configuration

Activates the specified agent. New message or interaction requests sent to this agent will not be blocked while the agent is active. This request does not fail if the agent is already active.

Activate an agent

Deactivates the specified agent. Any new message or interaction requests sent to this agent will be blocked while the agent is disabled. This request does not fail if the agent is already deactivated.

Deactivate an agent

Returns a list of users that belong to the current project. The users are returned sorted by creation date, with the most recently created users appearing first.

List all users

Creates a new user with the given properties.

Create a user

Permanently deletes the specified user and all the interactions associated with it. This cannot be undone.

Admin API

Agents

Users

Introduction

Base URL

Admin API

Agents

Users

​Base URL

Base URL