Connectly Documentation
  • 👋Welcome to Connectly.ai
  • 🚀Quick Start
    • Prerequisites
    • Authentication
    • Send WhatsApp template message
    • Send WhatsApp session message
  • 📣Campaigns
    • Campaign Sendout
      • Send Campaigns
  • 🤖Sofia AI
    • How to use Sofia AI?
    • Sofia AI API
      • Reference
        • Core Concepts
        • sales_assistant_v2/invoke/v1
  • 📱Message API
    • Message Service API
      • MessageService
        • Send template message
        • Send session message
      • Error codes
    • Webhook API
      • WebhookService
        • Create a webhook registration by event topic
        • Update an existing webhook registration by event topic
        • Get webhook registrations for business
        • Delete a webhook registration for business
      • Webhook Payload
        • Delivery Status Error Codes
        • Payload Media Types
  • 🤖Business Management
    • Business Management API
      • Template Management
        • Create a template
        • Get templates
      • Quality Signals
  • 📱Integrations
    • Integrations
      • WebEngage Integration
      • Message your customers on Zendesk through Connectly
      • Message your customer on Intercom through Connectly
    • [Alpha] Moengage
      • MessageService
        • Send Campaign via API
  • 📊Analytics
    • Analytics
      • [Alpha] Campaign report
      • Reports API
        • Webhooks configuration
  • 👀FAQ
  • Migrating WhatsApp Accounts
  • How to use time delay?
Powered by GitBook
On this page
  • Agent Descriptor
  • Access Keys
  • Session ID
  • State ID
  1. Sofia AI
  2. Sofia AI API
  3. Reference

Core Concepts

Agent Descriptor

Builds the Agent. It contains configuration parameters (i.e.) language and available resources such as knowledge bases, product catalogs, etc...

We'll manually handle onboarding knowledge bases and product catalogs for initial API customers. We'll provide an agent_descriptor_id .

Access Keys

To access the API, you'll be given a business_id and api_key. These keys are restricted to only invoke Sofia and CANNOT be used to send WhatsApp messages or view campaign reports. It is safe to include the API Key in browser-side javascript.

Session ID

A session ID is unique to a conversation.

State ID

A State ID refers to a given state in a conversation. The State ID is helpful to continue a conversation from a given point in time. The most common use case for the State ID is to include in the request when invoking the Sales Assistant.

PreviousReferenceNextsales_assistant_v2/invoke/v1

Last updated 1 year ago

🤖