Getting Started

Introduction

3 minutes integration Skill: beginner

Introduction to AISoule API

Welcome to the AISoule Developer API Documentation. The AISoule API is a robust, REST-first interface designed to let you send and receive WhatsApp messages, manage contacts, configure templates, and retrieve conversation analytics using the Official Meta WhatsApp Business API.

Core Principles

  • RESTful Design: Standard HTTP methods (GET, POST, DELETE) are utilized for intuitive resource interaction.
  • JSON Payloads: All request bodies and response payloads are formatted in standardized JSON.
  • Direct Meta Passthrough: AIsoule processes all official Meta conversation pricing at exactly cost, adding 0% markup.

Base API Endpoint

All REST requests must target the secure primary production endpoint:

https://api.aisoule.com/v1

!IMPORTANT Always enforce secure https connections. Cleartext http endpoints will be rejected automatically.

Standard JSON Error Format

All error conditions return standard HTTP status codes accompanied by descriptive JSON payloads to simplify troubleshooting:

{
  "success": false,
  "error": {
    "code": "unauthorized",
    "message": "The provided Bearer token is invalid or has expired."
  }
}

Related Doc Resources

Integration Playground
# Send a quick ping to verify your API status
curl -X GET "https://api.aisoule.com/v1/status" \
  -H "Authorization: Bearer YOUR_API_KEY"
Replace `YOUR_API_KEY` in the headers with your real dashboard secrets token!