API Reference

Build with the Chatmefy API

Powerful REST API to integrate Chatmefy into your applications. Manage conversations, leads, and bots programmatically.

Get StartedView Examples

RESTful API

Standard REST conventions with JSON responses

API Key Auth

Simple Bearer token authentication

Official SDKs

Libraries for JavaScript, Python, and more

Base URL

Production
https://api.chatmefy.com

Authentication

Authenticate requests using a Bearer token in the Authorization header. Get your API key from the dashboard under Settings > API.

Request Header
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

API Endpoints

GET/v1/conversations
GET/v1/conversations/:id
POST/v1/conversations/:id/messages
GET/v1/leads
POST/v1/leads
GET/v1/bots
PATCH/v1/bots/:id
GET/v1/analytics
View Full API Documentation

Quick Example

List Conversations
curl -X GET "https://api.chatmefy.com/v1/conversations" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

# Response
{
  "data": [
    {
      "id": "conv_123",
      "visitorId": "vis_abc",
      "status": "active",
      "messageCount": 5,
      "createdAt": "2025-01-10T12:00:00Z"
    }
  ],
  "meta": {
    "total": 150,
    "page": 1,
    "limit": 20
  }
}

Official SDKs

JavaScript/TypeScript

Available
@chatmefy/sdk

Python

Available
chatmefy

PHP

Coming Soon
chatmefy/sdk

Ruby

Coming Soon
chatmefy

Rate Limits

Free

100 requests/min

Pro

1,000 requests/min

Enterprise

Unlimited

Rate limit headers are included in all API responses.