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.lumika.ai/v1

01 / Quickstart

Authenticate, install, connect.

Start at account setup: sign in securely, create a workspace, and receive $10 in starter credit once. In Balance & API keys, create a test or live key and keep its one-time plaintext in your secret manager. Send it as a bearer token and pin the reviewed API version.

curl "https://api.connectors.lumika.ai/v1/connections" \
  -H "Authorization: Bearer $CONNECTORS_API_KEY" \
  -H "Connectors-Version: 2026-09-01"
  1. ClientIn Clients & channels, add a client with a stable reference and confirm your authority to manage it. Its installation belongs only to your selected environment.
  2. ConnectionUse a live API key to launch hosted authorization for your provider account. Test clients use the sandbox API. The channel list shows which providers are activated.
  3. ConversationRead events and send through the normalized API.

Automated sending requires explicit client approval and a separate installation settings change; approval alone does not enable it. Register a signed webhook endpoint through the API or poll the ordered event feed. Review transaction prices and zero-balance behavior and credit terms before live traffic.

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