Quick Start

Get up and running with Jeem in under 10 minutes. This guide walks you through creating an account, getting your API key, and making your first API call.

Step 1: Create Your Account

Sign up at dashboard.jeem.ai to access the Jeem platform. You'll receive a confirmation email with your workspace URL.

Step 2: Get Your API Key

Navigate to Settings → API Keys in your dashboard. Create a new key and copy it — you'll need it for all API requests.

Step 3: Make Your First Request

Test your connection by listing your workspace tickets:

curl https://api.jeem.ai/v1/tickets \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Or using JavaScript:

const response = await fetch('https://api.jeem.ai/v1/tickets', {
  headers: {
    'Authorization': `Bearer ${process.env.JEEM_API_KEY}`,
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

Step 4: Explore the Products

Now that you're connected, dive deeper into each product:

Authentication

All Jeem API endpoints require authentication. Include your API key in the Authorization header of every request.

Bearer Token

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

Managing API Keys

You can create, rotate, and revoke API keys from your dashboard under Settings → API Keys. Each key can be scoped to specific products:

Rate Limits

API requests are rate-limited per API key. Limits vary by plan:

Jeem Desk

Jeem Desk is a unified agent workspace where your support team manages conversations, accesses knowledge, and resolves tickets — all from a single interface.

Key Features

Ecosystem Connections

• ← Jeem Ticket feeds work into Jeem Desk as prioritized tickets
• ← Jeem Bot escalates complex conversations that need human attention
• → Jeem Sentiment evaluates agent interactions and provides performance feedback

Quick Setup

import { JeemDesk } from '@jeem/desk-sdk';

const desk = new JeemDesk({
  apiKey: process.env.JEEM_API_KEY,
  workspace: 'your-workspace-id'
});

// List all open conversations
const conversations = await desk.conversations.list({
  status: 'open',
  limit: 25
});

// Assign a conversation to an agent
await desk.conversations.assign('conv_abc123', {
  agentId: 'agent_xyz',
  priority: 'high'
});

Jeem Bot

Jeem Bot is the AI automation layer that handles customer conversations autonomously. It resolves simple requests, escalates complex ones to Jeem Desk, and creates tickets in Jeem Ticket when needed.

Capabilities

• Automated responses to FAQs and common queries
• Multi-language support with Arabic dialect understanding
• Context-aware escalation to human agents
• Automatic ticket creation for follow-up items
• Customizable conversation flows and decision trees

Send a Message

curl -X POST https://api.jeem.ai/v1/bot/conversations/conv_123/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "I need help with my order",
    "context": {
      "customer_id": "cust_456",
      "channel": "web_chat"
    }
  }'

Jeem Ticket

Jeem Ticket is the workflow engine that tracks, organizes, and routes customer requests across teams and channels. It ensures no request falls through the cracks.

Create a Ticket

const ticket = await jeem.tickets.create({
  subject: 'Order delivery delayed',
  description: 'Customer reports 5-day delay on order #8821',
  priority: 'high',
  assignee_group: 'logistics',
  customer_id: 'cust_456',
  tags: ['delivery', 'escalation'],
  sla: '4h'
});

console.log(ticket.id); // tkt_abc123

Smart Routing

Jeem Ticket automatically routes tickets based on configurable rules: content analysis, customer tier, team availability, and SLA requirements. Configure routing rules in your dashboard or via the API.

Jeem Sentiment

Jeem Sentiment is the analytics layer that analyzes customer interactions across all channels to understand sentiment, satisfaction levels, and turn them into actionable steps.

Analyze a Conversation

const analysis = await jeem.sentiment.analyze({
  conversation_id: 'conv_123',
  include: ['sentiment', 'satisfaction', 'topics', 'agent_score']
});

// Response
{
  sentiment: 'negative',       // positive | neutral | negative
  confidence: 0.92,
  satisfaction: 2.1,           // 1-5 scale
  topics: ['billing', 'refund'],
  agent_score: 4.3,           // 1-5 scale
  recommendations: [
    'Offer proactive refund to prevent churn',
    'Escalate to retention team'
  ]
}

Ecosystem Connections

• Analyzes conversations handled by Jeem Bot to improve AI accuracy
• Extracts insights from tickets managed in Jeem Ticket
• Evaluates agent interactions in Jeem Desk
• Provides feedback that helps improve automation, workflows, and agent performance

API Reference

Complete reference for all Jeem API endpoints. All endpoints use JSON request/response bodies and require Bearer token authentication.

Desk Endpoints

Bot Endpoints

Ticket Endpoints

Sentiment Endpoints

Jeem Desk — Setup Guide

Setup guide content coming soon.

Jeem Desk — API Reference

Full API reference coming soon.

Jeem Bot — Setup Guide

Setup guide content coming soon.

Jeem Bot — API Reference

Full API reference coming soon.

Jeem Ticket — Setup Guide

Setup guide content coming soon.

Jeem Ticket — API Reference

Full API reference coming soon.

Jeem Sentiment — Setup Guide

Setup guide content coming soon.

Jeem Sentiment — API Reference

Full API reference coming soon.

Webhooks

Webhooks documentation coming soon.

Error Codes

Error codes reference coming soon.

SDKs & Libraries

SDK documentation coming soon.

Changelog

Changelog coming soon.

Support

Support page coming soon.