API Documentation

Welcome to the Aksita.ai API. We've built a robust platform that empowers developers to seamlessly integrate intelligent, context-aware AI agents into any digital ecosystem. Whether you are building a customer support bot for WhatsApp, an interactive assistant for your website, or a complex automation workflow, our API provides the building blocks you need.

Our RESTful API is designed with developer experience in mind—featuring predictable resource-oriented URLs, standard HTTP response codes, and simplified JSON-encoded responses.

High Performance

Engineered for speed. Our infrastructure is optimized to deliver ultra-low latency responses, ensuring your user interactions feel natural and instantaneous.

Enterprise Secure

Your data's safety is paramount. All interactions are protected by secure API keys, strict validation rules, and bank-grade encryption protocols.

Base URL

All API requests should be prefixed with the following base URL:

https://api.aksita.ai/api

Quick Start

Get started with the Aksita.ai API in 3 simple steps:

Create Your API Key

Navigate to your agent's dashboard, go to the API Keys tab, and create an API key. Choose a name and response format (Markdown, WhatsApp, Custom, etc.).

Create a Session

Make a POST request to /api/session to create a new conversation session.

Send Messages

Use the session ID to send messages and receive AI responses via /api/chat.

Complete Flow Example (cURL)

# Step 1: Create Session
curl -X POST https://api.aksita.ai/api/session \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json"

# Step 2: Send Message
curl -X POST https://api.aksita.ai/api/chat \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "session_id": "session_id_from_step_1",
    "message": "Hello, how can you help me?"
  }'

AI Response Formatting

Each API key has its own response format that controls how the AI formats its responses. This allows you to use the same agent across different platforms with platform-specific formatting.

Markdown

Standard markdown formatting - ideal for web apps and documentation.

Optimized for WhatsApp with appropriate formatting and line breaks.

Custom Platform

Specify a platform name (Discord, Telegram, Slack) for platform-specific formatting.

Custom Example

Provide example chat messages to guide the AI's response formatting.

Use Case Example

Create 3 API keys for the same agent: one with "WhatsApp" format for your WhatsApp bot, one with "markdown" for your website chat, and one with "Custom Platform: Discord" for your Discord server. Each integration gets optimally formatted responses!

API Response Structure

Aksita.ai uses a consistent JSON envelope for all API responses. Every response will contain a status field indicating success or failure.

Success Response

{
  "status": true,
  "data": {
    // Requested data object
  },
  "detail": "Operation successful"
}

Error Response

{
  "status": false,
  "reason": "Description of what went wrong"
}