API Reference

Overview

The AxonBOS API gives you programmatic access to your business data, Digital Employees, and connected systems. One API. 222 connectors. Enterprise intelligence.

Key Features

Unified Access: Write once. Access all your connected systems — accounting, banking, e-commerce, HR, CRM, and more.

AI-Powered Insights: Query your data using natural language. Get intelligent responses from your Digital Employee.

Enterprise Grade: Built for scale. Multi-tenant. Fully audited. Compliant with Indian data residency requirements.

Developer Friendly: REST API. JSON. Standard HTTP methods. Webhook support for real-time events.

Authentication

All API requests require authentication via phone OTP. Once authenticated, use your access token in request headers.

Authentication Flow

1. Send OTP to user's phone

POST /api/v1/auth/otp/send
Content-Type: application/json

{
  "phone": "+919019922652"
}
                

2. Verify OTP and get access token

POST /api/v1/auth/otp/verify
Content-Type: application/json

{
  "phone": "+919019922652",
  "otp": "123456"
}

// Response:
{
  "success": true,
  "data": {
    "access_token": "eyJ0eXAiOiJKV1QiL...",
    "token_type": "bearer",
    "expires_in": 86400
  }
}
                

3. Use token in Authorization header for all subsequent requests

GET /api/v1/my-day
Authorization: Bearer eyJ0eXAiOiJKV1QiL...
Accept: application/json
                

Core Endpoints

The main endpoints you'll use to interact with your Digital Employee and business data.

POST

/api/v1/chat

Chat API

Send messages to your Digital Employee. Get intelligent responses based on your connected data, memory, and business context.

GET POST

/api/v1/tasks

Tasks API

Create, read, update, and delete tasks managed by your AI Secretary. Automatic reminders and follow-ups.

GET POST

/api/v1/follow-ups

Follow-ups API

Manage follow-up reminders and tracking. Never miss a deadline or callback again.

GET

/api/v1/memory/search

Memory API

Search your Digital Employee's memory and learned patterns. Retrieve insights from past conversations.

GET

/api/v1/connectors

Connectors API

List, configure, and manage connected systems. Discover available data sources and their schemas.

GET

/api/v1/my-day

My Day API

Get your daily briefing — tasks, follow-ups, calendar, weather, and AI-prioritized priorities.

Response Format

Every API response follows a standard envelope format for consistency and error handling.

Standard Response Envelope

{
  "success": true,
  "data": {
    "tasks": [
      {
        "id": "task_001",
        "title": "Follow up with ABC Traders",
        "due_date": "2026-03-26",
        "priority": "high"
      }
    ]
  },
  "error": null,
  "meta": {
    "request_id": "uuid-4a9c-8f2e-1b3d",
    "timestamp": "2026-03-25T10:30:00Z",
    "page": 1,
    "total": 42,
    "limit": 20
  }
}
                

Fields:

success — Boolean indicating if the request succeeded
data — The response payload (varies by endpoint)
error — Error details if request failed (null on success)
meta — Metadata including request ID, timestamp, pagination info

Rate Limits

API requests are rate-limited based on your plan to ensure fair usage and platform stability.

Self-Service

60

requests / minute

Managed

300

requests / minute

Enterprise

Custom

custom limits

Rate Limit Headers

All responses include rate limit information in headers:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1648195200
X-RateLimit-Retry-After: 30
                

Webhooks

Get notified when events happen — new transactions, payment settlements, compliance deadlines, task completions.

📩

Real-Time Events

Receive instant notifications when business events occur — no polling required.

🔄

Automatic Retries

Failed webhook deliveries are automatically retried with exponential backoff.

🔐

Signed Payloads

All webhooks are cryptographically signed so you can verify authenticity.

Supported Events

task.created — New task assigned to you
task.completed — Task marked complete
transaction.settled — Payment received or sent
reminder.triggered — Follow-up reminder due
compliance.alert — GST, accounting, or regulatory deadline
connector.disconnected — Connected system authentication expired

SDKs & Libraries

Official SDKs for popular languages. Join the waitlist to be notified when new SDKs are available.

🐍

Python SDK

Native Python library with async support, type hints, and automatic retries.

📦

Node.js SDK

TypeScript-first Node.js package for seamless integration with your JavaScript apps.

☕

Java SDK

Enterprise-grade Java library with Spring Boot autoconfiguration support.