# Proficient AI Documentation

## Docs

- [Introduction](https://docs.proficientai.com/intro.md): Add a conversational AI agent to your app in 3 minutes
- [Why Proficient AI?](https://docs.proficientai.com/why-proficient.md)
- [Concepts](https://docs.proficientai.com/concepts.md)
- [Installation](https://docs.proficientai.com/installation.md)
- [Creating my first agent](https://docs.proficientai.com/create-agent.md)
- [Overview](https://docs.proficientai.com/sdks/overview.md)
- [React SDK](https://docs.proficientai.com/sdks/react.md)
- [JavaScript Client SDK](https://docs.proficientai.com/sdks/js-client.md)
- [Node.js Admin SDK](https://docs.proficientai.com/sdks/node-admin.md)
- [Introduction](https://docs.proficientai.com/client-api/intro.md): The API to interact with Proficient AI from client applications
- [Authentication](https://docs.proficientai.com/client-api/auth.md): Use request headers for authentication
- [Specification](https://docs.proficientai.com/client-api/spec.md)
- [List all agents](https://docs.proficientai.com/client-api/agents/list.md): 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.
- [Retrieve an agent](https://docs.proficientai.com/client-api/agents/get.md): Retrieves the agent with the given ID.
- [List all interactions](https://docs.proficientai.com/client-api/interactions/list.md): 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.
- [Create an interaction](https://docs.proficientai.com/client-api/interactions/create.md): Creates a new `Interaction` with an agent.
- [Retrieve an interaction](https://docs.proficientai.com/client-api/interactions/get.md): Retrieves the interaction with the given ID.
- [Update an interaction](https://docs.proficientai.com/client-api/interactions/update.md): Updates the properties of the specified interaction. Only the provided properties will be updated. Any properties not provided will be left unchanged.
- [Delete an interaction](https://docs.proficientai.com/client-api/interactions/delete.md): Permanently deletes the specified interaction and all the messages within it. This cannot be undone.
- [List all messages in an interaction](https://docs.proficientai.com/client-api/messages/list.md): Returns a list of all messages in the specified interaction.
- [Create a message in an interaction](https://docs.proficientai.com/client-api/messages/create.md): Creates a new `Message` in a given `Interaction`
- [Retrieve a message](https://docs.proficientai.com/client-api/messages/get.md): Retrieves the message with the given ID.
- [Ask for a reply to a message](https://docs.proficientai.com/client-api/messages/ask.md): Requests a reply from the `Agent` to a given `Message`.
- [Retrieve a user](https://docs.proficientai.com/client-api/users/get.md): Retrieves the user with the given ID.
- [Update a user](https://docs.proficientai.com/client-api/users/update.md): Updates the properties of the specified user. Only the provided properties will be updated. Any properties not provided will be left unchanged.
- [Introduction](https://docs.proficientai.com/admin-api/intro.md): The API to interact with Proficient AI from backend applications
- [Authentication](https://docs.proficientai.com/admin-api/auth.md): Use Bearer Authentication scheme
- [Specification](https://docs.proficientai.com/admin-api/spec.md)
- [List all agents](https://docs.proficientai.com/admin-api/agents/list.md): 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.
- [Create an agent](https://docs.proficientai.com/admin-api/agents/create.md): Creates a new agent with the given properties.
- [Retrieve an agent](https://docs.proficientai.com/admin-api/agents/get.md): Retrieves the agent with the given ID.
- [Update an agent](https://docs.proficientai.com/admin-api/agents/update.md): Updates the properties of the specified agent. Only the provided properties will be updated. Any properties not provided will be left unchanged.
- [Delete an agent](https://docs.proficientai.com/admin-api/agents/delete.md): Permanently deletes the specified agent and all the interactions associated with it. This cannot be undone.
- [Retrieve agent configuration](https://docs.proficientai.com/admin-api/agents/get_config.md): Retrieves the current configuration of the specified agent.
- [Update agent configuration](https://docs.proficientai.com/admin-api/agents/update_config.md): Updates the configuration of the specified agent. Only the provided properties will be updated. Any properties not provided will be left unchanged.
- [Activate an agent](https://docs.proficientai.com/admin-api/agents/activate.md): 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.
- [Deactivate an agent](https://docs.proficientai.com/admin-api/agents/deactivate.md): 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.
- [List all users](https://docs.proficientai.com/admin-api/users/list.md): 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.
- [Create a user](https://docs.proficientai.com/admin-api/users/create.md): Creates a new user with the given properties.
- [Retrieve a user](https://docs.proficientai.com/admin-api/users/get.md): Retrieves the user with the given ID.
- [Update a user](https://docs.proficientai.com/admin-api/users/update.md): Updates the properties of the specified user. Only the provided properties will be updated. Any properties not provided will be left unchanged.
- [Delete a user](https://docs.proficientai.com/admin-api/users/delete.md): Permanently deletes the specified user and all the interactions associated with it. This cannot be undone.

## OpenAPI Specs

- [client-openapi](https://docs.proficientai.com/client-openapi.yml)
- [admin-openapi](https://docs.proficientai.com/admin-openapi.yml)

## Optional

- [Community & Support](https://discord.gg/DVbwTM8erb)
- [GitHub](https://github.com/proficientai/js)