canonical: https://jentic.com/apis/backend.experteaseai.com/experteaseai

# Backend Experteaseai Expertease apis

ExpertEase is a chatbot platform that lets teams build, train, and deploy domain-specific bots powered by Azure OpenAI models. The API exposes 193 endpoints for bot lifecycle management, conversation history, embedding ingestion from files and URLs, integrations with messaging channels, and per-user analytics. Admin operations cover bot transfers, feature requests, support queries, and model availability. Conversations are tracked for analytics including activity, leaderboards, realtime metrics, and per-endpoint usage.

## For AI agents

Create and configure AI chatbots, ingest knowledge sources as embeddings, and retrieve conversation analytics for users and bots through the ExpertEase backend.

## Scope

Does not handle voice calls, SMS, or generic LLM completions outside of bot context - use for chatbot lifecycle, embedding ingestion, and conversation analytics only.

## Capabilities

- Create bots and update their system prompts, model selection, and integration settings
- Ingest documents, URLs, and bot files as vector embeddings for retrieval-augmented chat responses
- Retrieve conversation transcripts and per-bot conversation statistics over time
- Trigger embedding maintenance jobs to refresh a bot's knowledge base
- Pull realtime analytics covering active users, endpoint usage, and per-user activity
- Submit and track feature requests and support queries against admin workflows
- Transfer bot ownership between users and audit the transfer history

## Use cases

### Internal Knowledge Bot

Build a chatbot trained on internal company documents that answers employee questions about HR policies, engineering runbooks, or product specs. ExpertEase ingests files via the bot-files endpoints and embeds them into the bot's vector store, so the bot can cite source material in its replies. Setup typically takes under an hour for a single source folder and scales to thousands of documents per bot.

Example prompt: Create a bot named 'HR Helper', upload a PDF policy document via `/api/v1/bot-files`/, and trigger embedding maintenance on the bot.

### Customer Support Deflection

Deploy a customer-facing chatbot that handles tier-1 questions and escalates only when the bot's confidence is low. ExpertEase tracks each conversation, surfaces analytics on resolution rates via the analytics endpoints, and lets admins review transcripts. Conversation stats give product teams a feedback loop on which questions the bot fails to answer.

Example prompt: List all conversations for bot {bot_id} from the last 7 days and pull conversation stats to identify the most common unresolved queries.

### Multi-Tenant Bot Operations

Run ExpertEase as a multi-team platform where admins manage bot ownership, transfer bots between users, and monitor usage across the workspace. Admin endpoints expose bot transfers, support queries, feature requests, and the full non-superuser directory. This makes it suitable for agencies and internal platform teams managing many bots on behalf of business units.

Example prompt: Transfer bot {bot_id} from user A to user B via `/api/v1/admin/transfer-bot`/ and verify the transfer appears in the bot-transfers history.

### AI Agent Integration via Jentic

An agent built on Jentic can use ExpertEase to spin up a purpose-built sub-bot for a domain task, embed the relevant context, and run conversational queries against it without exposing JWT credentials to the agent runtime. Jentic stores the bearer token in your Jentic One instance and exposes only scoped operations the agent needs, like create-bot and post-message.

Example prompt: Search Jentic for 'create an expertease chatbot', load the create-bot operation schema, and execute it with a custom system prompt.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/v1/bots/` | Retrieve a list of bots |
| POST | `/api/v1/bots/` | Create a new bot |
| POST | `/api/v1/bot-files/` | Upload a knowledge file for a bot |
| POST | `/api/v1/admin/bots/{bot_id}/trigger-maintenance/` | Trigger bot embedding maintenance |
| GET | `/api/v1/bots/{bot_id}/conversations/` | List conversations for a bot |
| GET | `/api/v1/analytics/realtime/` | Retrieve realtime usage analytics |
| POST | `/api/v1/admin/transfer-bot/` | Transfer a bot to another user |

## Key resources

- **Bots** — Create, list, update, and delete chatbots configured with model and prompt
- **Bot Files** — Upload and manage knowledge files used as embedding sources for a bot
- **Conversations** — Retrieve conversation transcripts and per-bot statistics
- **Embedding Items** — Manage individual embedded chunks attached to a bot's knowledge base
- **Analytics** — Activity, endpoint, leaderboard, realtime, system, and per-user analytics
- **Admin** — Bot transfers, available models, feature requests, and support queries
- **Integrations** — Configure and retrieve third-party integrations attached to a bot

## Why Jentic

- **Setup:** Wiring ExpertEase by hand means handling its JWT bearer auth, attaching the Authorization header on every call, and finding the right operation among 193 paths for bot creation, file upload, embedding refresh, and analytics. Through Jentic you install once, import the ExpertEase API from the API Directory, store the JWT once, and your agent calls it.
- **Permission scoping:** ExpertEase puts the bot id in the URL path (`/api/v1/bots/{bot_id}/conversations`/, `/api/v1/admin/bots/{bot_id}/trigger-maintenance`/), so a rule can pin your agent to one bot: it can read that bot's conversations and refresh its embeddings and nothing else. You choose the operations it may call, so admin actions like `/api/v1/admin/transfer-bot`/ are not included unless you add them.
- **Credential handling:** Your ExpertEase JWT is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a chatbot with a custom system prompt' or 'upload a knowledge file to a bot', and Jentic returns the matching ExpertEase operation with its input schema so the agent calls the right endpoint without crawling all 193 paths.

## Related APIs

- **GenPage** — Another AI content generation backend with similar JWT-authenticated patterns
- **Bandsintown** — Event data API that a support chatbot could query for venue and tour information
- **Bacon Ipsum** — Placeholder text generator useful for seeding bot test conversations

## FAQ

### What authentication does the ExpertEase API use?

The API uses HTTP Bearer authentication with JWTs (the jwtAuth scheme). Every request must include an Authorization header containing a JWT issued by the ExpertEase backend. When called through Jentic, the JWT is held in the encrypted vault and never exposed to the agent's context.

### Can I upload my own knowledge documents to a bot via the API?

Yes. POST to `/api/v1/bot-files`/ to upload a file, then the file is embedded into the bot's vector store. After uploading, call `/api/v1/admin/bots/{bot_id}/trigger-maintenance`/ to refresh embeddings. Per-bot embedding items can be listed or selectively deleted via `/api/v1/bots/{bot_id}/embedding-items/.`

### What are the rate limits for the ExpertEase API?

The OpenAPI spec does not publish explicit rate limits. Limits are enforced by the ExpertEase backend per JWT and tier; check the redoc page at https://backend.experteaseai.com/api/redoc/ for current quotas before high-volume use.

### How do I create a new chatbot through Jentic?

Search Jentic for 'create an expertease chatbot', load the schema for POST `/api/v1/bots`/, then execute with the bot name, system prompt, and selected model. Jentic injects the JWT at execution time so your agent never handles the credential.

### Can I get analytics on which endpoints my bots use most?

Yes. GET `/api/v1/analytics/endpoints`/ returns per-endpoint usage, `/api/v1/analytics/realtime`/ returns live activity, and `/api/v1/analytics/user/{user_id}`/ scopes the data to a single user. Export the dataset via `/api/v1/analytics/export`/ for offline reporting.

### How do I transfer a bot to another user?

Admin users can call POST `/api/v1/admin/transfer-bot`/ with the bot ID and target user ID. The transfer is recorded and visible via GET `/api/v1/admin/bot-transfers`/ for audit.

### Can I limit what my agent is allowed to do with the Expertease API?

Yes. Because you run Jentic One yourself, your own rules decide which of the 193 ExpertEase operations and which stored credential the agent may use. Since the bot id sits in the URL path, such as `/api/v1/bots/{bot_id}/conversations`/ and `/api/v1/admin/bots/{bot_id}/trigger-maintenance`/, you can pin the agent to a single bot so it only reads that bot's conversations and refreshes its embeddings. Admin operations like `/api/v1/admin/transfer-bot`/ stay off limits unless you explicitly grant them.
