canonical: https://jentic.com/apis/aidbase.ai/aidbase

# Aidbase API

Jentic publishes the only available OpenAPI specification for Aidbase API, keeping it validated and agent-ready. Aidbase is an AI-powered customer-support platform that combines a knowledge base, chatbots, ticket forms, tickets, and email inboxes. The API exposes CRUD endpoints for each of these resources plus a chat endpoint that sends a message to a chatbot and returns a response with sources. Authentication uses an API key with a Bearer prefix in the Authorization header.

## For AI agents

Manage Aidbase knowledge bases, chatbots, ticket forms, tickets, and email inboxes, and send messages to chatbots that answer from the knowledge base.

## Scope

Does not handle outbound marketing email, voice channels, or general CRM contact management - use for AI-powered customer support, knowledge bases, and ticketing only.

## Capabilities

- Build and edit knowledge bases and the articles, FAQs, and URLs they contain through the /v1/knowledge-bases endpoints
- Provision chatbots backed by a knowledge base and a system prompt via /v1/chatbots
- Send a user message to a chatbot and receive an AI response with cited sources through /v1/chatbots/{chatbot_id}/chat
- Create ticket forms with custom field definitions and route incoming submissions into /v1/tickets
- List, filter, and update support tickets by status using /v1/tickets and its query parameters
- Manage email inboxes that route customer email into the same ticketing pipeline

## Use cases

### AI Chatbot Backed by a Knowledge Base

Stand up an AI support chatbot for a SaaS product. Create a knowledge base, populate it with articles and FAQs through /v1/knowledge-bases/{kb_id}/items, create a chatbot bound to that knowledge base via /v1/chatbots, and route user messages through /v1/chatbots/{chatbot_id}/chat. Each chat response includes sources, which can be surfaced in the UI as citation links.

Example prompt: POST /v1/knowledge-bases, POST several items via /v1/knowledge-bases/{kb_id}/items, create a chatbot pointing at the kb, then POST /v1/chatbots/{chatbot_id}/chat with the user's message

### Ticket Intake from a Custom Form

Capture support requests via a structured ticket form. Create a /v1/ticket-forms record with the fields required for triage, then POST submissions to /v1/tickets referencing the form_id. Tickets can later be filtered by status and updated as agents work them.

Example prompt: POST a ticket form with the required fields, then create a ticket via POST /v1/tickets passing the form_id, the field values, and the customer's email

### Status-Based Ticket Reporting

Generate a daily report of open versus closed tickets to feed an internal dashboard. List tickets with /v1/tickets?status=open and /v1/tickets?status=closed, paginate via page and per_page, and aggregate by day. The endpoints return enough metadata for status, owner, and timing analysis without leaving the API.

Example prompt: GET /v1/tickets?status=open per_page=100 and iterate pages, then aggregate counts by day for a dashboard write-back

### Email-to-Ticket Routing

Connect a support email address to Aidbase by provisioning an email inbox via /v1/email-inboxes. Inbound mail becomes a ticket, the chatbot can draft a first reply from the knowledge base, and an agent can update the ticket once the customer is satisfied.

Example prompt: POST /v1/email-inboxes to create the inbox, then on each new ticket call /v1/chatbots/{chatbot_id}/chat with the ticket subject to draft a reply

### Agent-Driven Support Triage via Jentic

An AI agent handles triage end to end: read open tickets, query a chatbot for a candidate answer, and update the ticket with that draft. Through Jentic the agent searches for the right Aidbase operation, the API key is supplied from the vault, and Bearer auth is handled by the SDK.

Example prompt: Use Jentic search 'list open tickets', execute /v1/tickets?status=open, send each ticket subject to /v1/chatbots/{chatbot_id}/chat, and PUT the suggested reply onto the ticket

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /v1/knowledge-bases | Create a knowledge base |
| POST | /v1/knowledge-bases/{kb_id}/items | Add an article, FAQ, or URL to a knowledge base |
| POST | /v1/chatbots | Create a chatbot bound to a knowledge base |
| POST | /v1/chatbots/{chatbot_id}/chat | Send a message to a chatbot and receive an answer |
| POST | /v1/tickets | Create a ticket from a ticket form |
| GET | /v1/tickets | List tickets filtered by status |
| POST | /v1/ticket-forms | Create a ticket intake form |

## Key resources

- **Knowledge Bases** — Containers for articles, FAQs, and URLs that ground chatbot answers
- **Knowledge Base Items** — Individual article, FAQ, or URL entries inside a knowledge base
- **Chatbots** — AI bots bound to a knowledge base, configurable with model and system prompt
- **Chat** — Send a message to a chatbot and receive an answer with cited sources
- **Ticket Forms** — Custom-field intake forms that produce tickets
- **Tickets** — Support tickets filterable by status with paginated listing
- **Email Inboxes** — Inbound email routing into the ticket pipeline

## Why Jentic

- **Setup:** Wiring Aidbase by hand means handling its Bearer-prefixed key, chaining knowledge-base, chatbot, and ticket calls, and writing your own retry logic. Through Jentic you install once, import Aidbase from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Aidbase puts the chatbot and knowledge-base ids in the URL path (/chatbots/{chatbot_id}/chat, /knowledge-bases/{kb_id}/items), so a rule can pin your agent to one chatbot or knowledge base. You choose the operations it may call, so ticket creation is only included if you add it.
- **Credential handling:** Your Aidbase key 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 'send a message to a chatbot', and Jentic returns the Aidbase /chatbots/{chatbot_id}/chat operation with its message schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Intercom API** — Customer messaging platform with conversations, contacts, and support workflows
- **Zendesk API** — Established help-desk platform with tickets, users, and macros
- **Freshdesk API** — Help-desk platform with ticket management and automations

## FAQ

### Why is there no official OpenAPI spec for Aidbase API?

Aidbase does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call the Aidbase API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Aidbase API use?

An apiKey scheme that takes the Aidbase API key with a 'Bearer' prefix in the Authorization header. Through Jentic the key is held in the vault and never enters the agent's context.

### Can I send a message to a chatbot and get an answer with sources?

Yes. POST /v1/chatbots/{chatbot_id}/chat with a message string. The response contains the chatbot's reply, a conversation_id, and an array of sources from the knowledge base.

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

The spec does not declare explicit rate limits. List endpoints support page and per_page parameters; use them to keep request volume bounded and to handle large knowledge bases or ticket queues incrementally.

### How do I create and seed a knowledge base through Jentic?

Run pip install jentic, search 'create a knowledge base', execute /v1/knowledge-bases, then loop /v1/knowledge-bases/{kb_id}/items POSTs to add articles, FAQs, or URLs. Run it through Jentic One, the self-hosted execution layer.

### Can I filter tickets by status?

Yes. GET /v1/tickets accepts a status query parameter with values open, closed, or pending plus page and per_page for pagination.

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

Yes. Because you run Jentic One yourself, your own rules decide which Aidbase operations and credentials the agent may use. Aidbase puts the chatbot and knowledge-base identifiers in the URL path, such as /chatbots/{chatbot_id}/chat and /knowledge-bases/{kb_id}/items, so a rule can pin the agent to a single chatbot or knowledge base. You also choose the operations it may call, so ticket creation via /v1/tickets is included only if you add it.