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.