Public API · v1

A small contract for
many conversations.

Build against stable Lumika resources while Connectors handles provider-specific credentials, delivery receipts, windows and retries.

Base URLhttps://api.connectors.dev.lumika.ai/v1

01 / Quickstart

Authenticate, install, connect.

Keys are created internally for now. Keep the plaintext in your secret manager—it is displayed only once. Send it as a bearer token and pin the reviewed API version.

curl "https://api.connectors.dev.lumika.ai/v1/connections" \
  -H "Authorization: Bearer $CONNECTORS_API_KEY" \
  -H "Connectors-Version: 2026-09-01"
  1. InstallationMap your client tenant to a Connectors installation.
  2. ConnectionAuthorize a provider account through the hosted flow.
  3. ConversationRead events and send through the normalized API.

02 / Resource model

Tenant boundaries are explicit.

App environmentYour isolated test or live API boundary.

InstallationOne client tenant using your product.

ConnectionOne authorized provider account or sender.

GrantThe exact scope an installation may use.

ConversationA normalized thread with participants.

EventOrdered, replayable change notification.

03 / Channels

Supported adapters.

ProviderConnection kindsOnboarding
MetaMessenger, Instagram, WhatsAppHosted OAuth / embedded signup
TelegramBot messagingBot token + verified webhook
TwilioSMS/MMS, voiceAccount credentials + sender
AWS SESDedicated emailVerified domain + sender identity

Availability is environment-specific. A listed adapter is not proof that its provider account has been activated in your environment.

04 / Reliability

Make ambiguity visible.

  • IdempotencyProvide an Idempotency-Key on every mutation that requires it.
  • Ordered eventsUse the event cursor and webhook delivery ledger instead of provider timestamps.
  • Policy at send timeChannel windows, consent, grants and control are rechecked before external I/O.
  • Unknown outcomesDo not blindly retry a provider timeout; reconcile the Message state first.

05 / Reference

The complete machine-readable contract.

The OpenAPI 3.1 document is the reviewed route reference. SDK types remain forward-compatible with additive enum values and fields.

Download OpenAPI