API Overview

AIChatVault exposes a REST API under /api/v1 for programmatic access to your leads, conversations, and webhooks. All endpoints require an API key and return JSON.

Base URL

https://aichatvault.com/api/v1

Authentication

Pass your API key in the Authorization header as a Bearer token:

Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

Alternatively, you can send it in the X-API-Key header:

X-API-Key: sk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Available endpoints

Response format

All responses follow the same envelope structure:

{
  "success": true,
  "data": { ... }        // object or array
  "meta": { ... }        // pagination info (list endpoints only)
  "links": { ... }       // pagination URLs (list endpoints only)
}

Error responses

Verify authentication

Use the GET /api/v1/auth/test endpoint to confirm your key is valid before building further:

curl -X GET https://aichatvault.com/api/v1/auth/test \
  -H "Authorization: Bearer sk_live_your_key_here"

# Response
{
  "success": true,
  "message": "Authentication successful",
  "data": {
    "user_id": 42,
    "organization_id": 7,
    "email": "you@example.com"
  }
}