Skip to content
Rafiq

Concepts

Flow

One conversation your bot can have: what it asks, which of your APIs it calls, and what it confirms before it acts. Apps start a flow by its key. A flow can be archived: it starts no new conversation, and its versions, conversations and audit are kept.

Step

A flow is a list of steps, and each names the step that comes next:

  • Ask collects slots, each asked by its own prompt.
  • Call an API runs one of your connectors’ operations, and can save the answer for later steps.
  • Choose lets the user pick from a list a call saved.
  • Confirm shows what is about to happen and waits for a yes. Its words are rendered from the next call’s real arguments, never from what the model said.
  • Say, Hand off (to a person on your team) and End.

Slot

A value an ask step collects: text, a whole number, or one of a list. Each is checked in code against its type before it is used. A user can type it in their own words, or with Arabic-Indic digits.

Connector and operation

A connector is one of your APIs: its address, how it signs in, and its operations, the only calls a flow can make. A call that changes data needs a confirm right before it and a signed-in user. What an API returns can’t widen what the model may do.

Version

Every save of a flow is a version. Publishing one puts it live for new conversations; conversations already running keep theirs. You can roll back to an older one.

Chat key

The publishable key an app starts chat sessions with. It is shown once, when issued. Revoking it stops that app from starting a chat, and can’t be undone.

Signed-in user

Your servers sign a short-lived token for the user (see the SDK guide). Without one, a flow can talk and let the user choose, but it runs no step that changes anything for them.

Handoff

When a flow hands a conversation to your team, the user keeps writing in the same chat, and the team’s replies arrive there, labelled as the team’s.

Transcript and analytics

Transcripts hold every conversation: how it ended, where, and every call it made to your APIs. Analytics shows outcomes, handoffs, conversations, and the steps where people drop off. Test chats are never counted.