SDKs

import { VorelClient } from '@vorel/sdk';

const client = new VorelClient({
  apiKey: process.env.VOREL_API_KEY!,
});

client.conversations; // List, get, create, update, send
client.leads; // List (with stale_for_days filter), get, create, update, handoff
client.appointments; // List, get, create, update
client.offerings; // List, get, create, update
client.analytics; // weeklyRollup
client.crm; // createRecord

// Single page
const page = await client.conversations.list({ limit: 50 });
console.log(page.data, page.next_cursor, page.has_more);

// Auto-paginated iteration, stops when has_more=false
for await (const conv of client.conversations.iterate()) {
  console.log(conv.id, conv.channel, conv.status);
}

// Auto-paginated with a filter
for await (const lead of client.leads.iterate({ stale_for_days: 3 })) {
  await reEngage(lead);
}

// Pre-create a conversation from your CRM webhook
const conv = await client.conversations.create({
  channel: 'whatsapp',
  customer_identifier: '+9715xxxxxxxx',
  customer_name: 'John Smith',
  customer_language: 'en',
});

// Attach a lead to it
const lead = await client.leads.create({
  conversation_id: conv.id,
  name: 'John Smith',
  phone: '+9715xxxxxxxx',
  intent: 'looking to buy',
  status: 'qualified', // emits both lead.created and lead.qualified webhooks
  attributes: {
    bedrooms: 2,
    budget_max: 2_500_000,
    preferred_areas: ['Dubai Marina', 'JLT'],
  },
});

// Schedule a viewing
const appt = await client.appointments.create({
  conversation_id: conv.id,
  lead_id: lead.id,
  customer_name: 'John Smith',
  customer_phone: '+9715xxxxxxxx',
  scheduled_start: '2026-05-15T14:00:00+04:00',
  scheduled_end: '2026-05-15T14:30:00+04:00',
  location_text: 'Marina Heights Tower 1, Apt 1502',
});

// Patch slots later as you learn more
await client.leads.update(lead.id, {
  attributes: { financing_needed: true },
});

// Push to the tenant's configured CRM
const crmResult = await client.crm.createRecord({
  object: 'lead',
  fields: {
    name: 'John Smith',
    phone: '+9715xxxxxxxx',
    budget_max: 2_500_000,
  },
  idempotency_key: `${conv.id}:lead-create-1`,
});
if (crmResult.ok) {
  console.log('CRM external_id:', crmResult.external_id);
} else {
  console.warn('CRM soft-fail:', crmResult.error, crmResult.detail);
}

import {
  VorelApiError,
  VorelUnauthorizedError,
  VorelForbiddenError,
  VorelRateLimitedError,
  VorelTransportError,
} from '@vorel/sdk';

try {
  const lead = await client.leads.create({
    /* ... */
  });
} catch (err) {
  if (err instanceof VorelRateLimitedError) {
    // 429: honour Retry-After
    await sleep((err.retryAfterSeconds ?? 60) * 1000);
    // ...retry with jitter
  } else if (err instanceof VorelUnauthorizedError) {
    // 401: bad / revoked key
    throw new Error('Vorel API key is invalid; rotate it');
  } else if (err instanceof VorelForbiddenError) {
    // 403: scope insufficient
    throw new Error(`Key needs the right scope: ${err.message}`);
  } else if (err instanceof VorelTransportError) {
    // 5xx, network errors, timeouts: transient. Retry with backoff.
  } else if (err instanceof VorelApiError) {
    // 4xx other than 401/403/429: permanent. Inspect err.code + err.message.
    console.error('API error:', err.status, err.code, err.message);
  } else {
    throw err; // unexpected
  }
}

// Daily nurture cadence: find stale-qualified leads, send a re-engagement template
import { VorelClient } from '@vorel/sdk';

const client = new VorelClient({ apiKey: process.env.VOREL_API_KEY! });

for await (const lead of client.leads.iterate({ stale_for_days: 3 })) {
  if (!lead.conversation_id) continue;
  await client.conversations.send(lead.conversation_id, {
    text: `Hi ${lead.name ?? 'there'}, just checking in. Still interested?`,
    language: 'en',
  });
}

https://app.vorel.ai/api/v1/openapi.json

# Python
openapi-python-client generate --url https://app.vorel.ai/api/v1/openapi.json

# Go
oapi-codegen -package vorel openapi.json > vorel.go

# Postman / Insomnia / Bruno
# Import the URL directly: most tools support pulling the spec live.