Generated by API Evangelist
Written by API Evangelist tooling for Salesforce Service Cloud APIs's API. It is a proposal applied on top of the contract, not a document Salesforce Service Cloud APIs publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Einstein Bots API (BETA) Bot API
version: 1.0.0
extends: openapi/service-cloud-bot-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/v5.3.0/bots/{bot-id}/sessions'].post
update:
x-apievangelist-phrasing:
intent: Start a conversation with an Einstein Bot
effect: write
questions:
- How do I open a new chat session with an Einstein Bot from my own app?
- Can I pass context variables and the customer's timezone when a bot conversation begins?
- What do I need to supply to kick off a fresh conversation with a Salesforce bot?
instructions:
- text: Start a new session with bot {bot_id} in org {org_id}.
slots:
bot_id: path.bot-id
org_id: header.X-Org-Id
- text: Open a conversation with bot {bot_id} using session key {session_key}.
slots:
bot_id: path.bot-id
session_key: requestBody.externalSessionKey
- text: Begin a chat with bot {bot_id} and pass the variables {variables} at startup.
slots:
bot_id: path.bot-id
variables: requestBody.variables
method: generated
generated: '2026-09-26'
- target: $.paths['/v5.3.0/sessions/{session-id}/messages'].post
update:
x-apievangelist-phrasing:
intent: Send a message in an active bot session
effect: write
questions:
- How do I send the customer's next reply to a bot conversation that's already running?
- Can I keep talking to the bot on an existing session instead of starting over?
- What does the bot answer when I post a follow-up message to its session?
instructions:
- text: Send the message {message} to bot session {session_id}.
slots:
message: requestBody.message
session_id: path.session-id
- text: Reply {message} in the ongoing bot conversation {session_id} for org {org_id}.
slots:
message: requestBody.message
session_id: path.session-id
org_id: header.X-Org-Id
method: generated
generated: '2026-09-26'
- target: $.paths['/v5.3.0/sessions/{session-id}'].delete
update:
x-apievangelist-phrasing:
intent: End an active bot session
effect: destructive
questions:
- How do I close out a bot conversation when the customer leaves?
- Can I record why a bot session ended when I terminate it?
instructions:
- text: End bot session {session_id} with reason {reason}.
slots:
session_id: path.session-id
reason: header.X-Session-End-Reason
- text: Terminate the bot conversation {session_id} in org {org_id} because {reason}.
slots:
session_id: path.session-id
org_id: header.X-Org-Id
reason: header.X-Session-End-Reason
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.