Skip to main content

Documentation

Getting Started

Run the Syntra platform locally, create an API key, and send your first message through Kong.

Eleven API products sit behind Kong: Engage, Flow, Route, Verify, Inbox, AI, CRM, Voice, Insights, Identity, and Billing. Use REST at /v1/*, GraphQL at /v1/graphql for cross-product queries, the developer console for configuration, or SDKs and MCP for programmatic access.

Base URLs

  • Production API: https://api-syntra.apptray.cc
  • Local gateway (Docker): http://localhost:8000
  • Developer Console: https://syntra-console.apptray.cc

Local quick start

  • Clone syntra-platform and run make up from the platform root
  • Open the console at https://syntra-console.apptray.cc and sign in with your API key
  • Use the demo key sk_test_syntra_dev_key for local development
Send your first messagecURL
curl -X POST http://localhost:8000/v1/route/messages \
  -H "X-API-Key: sk_test_syntra_dev_key" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "whatsapp",
    "to": "+233241234567",
    "body": "Hello from Syntra"
  }'
All /v1/* requests through Kong are authenticated. Kong introspects your API key via Identity and forwards X-Syntra-* context headers to upstream services.