Developer

API Documentation

Build powerful integrations with Engium's RESTful API. Access all platform features programmatically with comprehensive documentation and code examples.

Get Started Browse Endpoints

REST

API Architecture

50+

Endpoints

99.9%

Uptime SLA

OAuth 2.0

Authentication

Quick Start

1. Get Your API Key

Generate an API key from your account settings dashboard. Keep it secure and never commit it to public repositories.

2. Make Your First Request

curl -X GET https://api.engium.app/v1/conversations \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

3. Handle the Response

{
  "data": [
    {
      "id": "conv_123",
      "customer": { ... },
      "messages": [ ... ],
      "status": "open"
    }
  ],
  "pagination": { ... }
}

API Endpoints

Authentication

POST/api/auth/login

Authenticate and receive access token

POST/api/auth/refresh

Refresh expired access token

POST/api/auth/logout

Invalidate current session

Conversations

GET/api/conversations

List all conversations with pagination

GET/api/conversations/:id

Get specific conversation details

POST/api/conversations/:id/messages

Send a message in a conversation

PATCH/api/conversations/:id

Update conversation status or tags

Bookings

GET/api/bookings

List all bookings

POST/api/bookings

Create a new booking

PATCH/api/bookings/:id

Update booking details

DELETE/api/bookings/:id

Cancel a booking

AI Services

POST/api/ai/analyze

Analyze message sentiment and intent

POST/api/ai/suggest

Get AI response suggestions

POST/api/ai/categorize

Auto-categorize conversation

Official SDKs

🐍

Python

Full-featured Python SDK with type hints

pip install engium

📦

Node.js

TypeScript-ready SDK for Node applications

npm i @engium/sdk

💎

Ruby

Idiomatic Ruby gem for Rails apps

gem install engium

Rate Limits

Free Plan

100 requests/hour

Starter & Pro

1,000 requests/hour

Enterprise

Custom limits

Ready to Build?

Get your API key and start integrating Engium into your applications today.

Get API Key View Full Docs

Quick Start

1. Get Your API Key

Generate an API key from your account settings dashboard. Keep it secure and never commit it to public repositories.

2. Make Your First Request

curl -X GET https://api.engium.app/v1/conversations \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

3. Handle the Response

{
  "data": [
    {
      "id": "conv_123",
      "customer": { ... },
      "messages": [ ... ],
      "status": "open"
    }
  ],
  "pagination": { ... }
}

API Endpoints

Authentication

POST/api/auth/login

Authenticate and receive access token

POST/api/auth/refresh

Refresh expired access token

POST/api/auth/logout

Invalidate current session

Conversations

GET/api/conversations

List all conversations with pagination

GET/api/conversations/:id

Get specific conversation details

POST/api/conversations/:id/messages

Send a message in a conversation

PATCH/api/conversations/:id

Update conversation status or tags

Bookings

GET/api/bookings

List all bookings

POST/api/bookings

Create a new booking

PATCH/api/bookings/:id

Update booking details

DELETE/api/bookings/:id

Cancel a booking

AI Services

POST/api/ai/analyze

Analyze message sentiment and intent

POST/api/ai/suggest

Get AI response suggestions

POST/api/ai/categorize

Auto-categorize conversation