API Documentation ⏱️ 8 min read

YogaBot Live API Overview

Build powerful integrations with YogaBot Live's REST API. Access chat conversations, manage bookings, sync customer data, and automate your yoga studio operations programmatically.

API Playground Get Started →

What is the YogaBot Live API?

The YogaBot Live API is a comprehensive REST API that allows you to integrate our AI-powered yoga studio assistant with your existing systems, applications, and workflows. Whether you're building a custom mobile app, integrating with your CRM, or creating automated workflows, our API provides the flexibility you need.

Chat & Conversations

Access chat histories, send messages, and manage conversations programmatically.

Booking Management

Create, modify, and cancel bookings through the API with real-time sync.

Customer Data

Sync customer profiles, preferences, and interaction history across systems.

Analytics & Insights

Extract detailed analytics and performance metrics for reporting and optimization.

Base URL and Versioning

All API endpoints are accessed via HTTPS and use the following base URL:

https://api.yogabot.live/v1/

We use semantic versioning for our API. The current version is v1. We maintain backward compatibility within major versions and will announce any breaking changes well in advance.

💡 API Versioning: Always specify the version in your API calls. When we release v2, v1 will continue to work for existing integrations.

Authentication

YogaBot Live API uses API keys for authentication. All requests must include your API key in the Authorization header:

Authentication Header

Authorization: Bearer YOUR_API_KEY

🔑 Studio API Key

Full access to your studio's data and settings. Use for server-side applications.

  • Manage conversations and bookings
  • Access customer data
  • Modify studio settings
  • View analytics

🌐 Public API Key

Limited access for client-side applications. Safe to expose in frontend code.

  • Send chat messages
  • View public class schedules
  • Create bookings (with customer consent)

→ Learn more about API authentication

Request and Response Format

The API accepts and returns JSON data. All requests should include the appropriate content type header:

Required Headers

Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
User-Agent: YourApp/1.0

Standard Response Structure

All API responses follow a consistent structure:

Success Response

{
  "success": true,
  "data": {
    // Response data here
  },
  "meta": {
    "timestamp": "2025-01-20T10:30:00Z",
    "request_id": "req_1234567890"
  }
}

Error Response

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid email format",
    "details": {
      "field": "email",
      "received": "invalid-email"
    }
  },
  "meta": {
    "timestamp": "2025-01-20T10:30:00Z",
    "request_id": "req_1234567890"
  }
}

HTTP Status Codes

We use standard HTTP status codes to indicate success or failure:

Code Meaning Description
200 OK Request successful
201 Created Resource created successfully
400 Bad Request Invalid request parameters
401 Unauthorized Invalid or missing API key
403 Forbidden Insufficient permissions
404 Not Found Resource not found
429 Too Many Requests Rate limit exceeded
500 Internal Server Error Server-side error

Core API Resources

The YogaBot Live API is organized around the following core resources:

Conversations

/conversations

Manage chat conversations between customers and your YogaBot.

GET POST PUT
  • Retrieve conversation history
  • Send messages programmatically
  • Update conversation status
  • Export chat transcripts

Bookings

/bookings

Handle class bookings, cancellations, and waitlist management.

GET POST DELETE
  • Create and manage bookings
  • Handle cancellations and refunds
  • Manage waitlists
  • Send booking confirmations

Customers

/customers

Manage customer profiles, preferences, and interaction history.

GET POST PUT
  • Customer profile management
  • Preference tracking
  • Interaction history
  • Segmentation and tagging

Classes

/classes

Manage your studio's class schedules, instructors, and capacities.

GET POST PUT
  • Class schedule management
  • Instructor assignments
  • Capacity and availability
  • Recurring class patterns

Analytics

/analytics

Access detailed analytics and performance metrics for your studio.

GET
  • Conversation metrics
  • Booking conversion rates
  • Customer satisfaction scores
  • Popular questions and topics

Webhooks

/webhooks

Set up real-time notifications for events in your studio.

GET POST DELETE
  • Real-time event notifications
  • Booking confirmations
  • New conversation alerts
  • System status updates

Rate Limiting

To ensure fair usage and optimal performance for all users, our API implements rate limiting:

Plan Requests per Minute Requests per Hour Concurrent Requests
Starter 60 1,800 5
Professional 300 10,800 15