How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Salesforce Service Cloud APIs

Salesforce Service Cloud APIs Bot API

The bot API from Salesforce Service Cloud APIs — 3 operation(s) for bot.

Provider Profile APIs.io OpenAPI GitHub

Salesforce Service Cloud APIs Bot API is one of 12 APIs that Salesforce Service Cloud APIs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Bot. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 48 schemas. It is described by OpenAPI 3.2.0, at version v5.3.0.

Requests are made against 6 base URLs: https://runtime-api-na-west.prod.chatbots.sfdc.sh, https://runtime-api-na-east.prod.chatbots.sfdc.sh, https://runtime-api-eu-west.prod.chatbots.sfdc.sh, https://runtime-api-eu-east.prod.chatbots.sfdc.sh, https://runtime-api-ap-west.prod.chatbots.sfdc.sh, https://runtime-api-ap-east.prod.chatbots.sfdc.sh.

3 operations 3 paths 48 schemas 1 DELETE2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v5.3.0
Servers
https://runtime-api-na-west.prod.chatbots.sfdc.sh
https://runtime-api-na-east.prod.chatbots.sfdc.sh
https://runtime-api-eu-west.prod.chatbots.sfdc.sh
https://runtime-api-eu-east.prod.chatbots.sfdc.sh
https://runtime-api-ap-west.prod.chatbots.sfdc.sh
https://runtime-api-ap-east.prod.chatbots.sfdc.sh
Authentication
OAuth 2.0, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Salesforce Service Cloud APIs Bot API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (chatbotAuth) using the authorizationCode and implicit flows, exposing 1 scope. It accepts HTTP bearer tokens (jwtBearer).

  • chatbotAuth — chatbotAuth supports authorization code and implicit Oauth flows.
  • jwtBearer — Salesforce OAuth access token obtained using the JWT Bearer flow. Use the chatbotapi scope with this flow to enable access to the Einstein Bots services.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 1 DELETE, 2 POST. Each is listed below with its method, path, parameters, and response codes.

bot 3
POST
/v5.3.0/bots/{bot-id}/sessions
Start a session
startSession 3 params body → 200400401403404422423429
POST
/v5.3.0/sessions/{session-id}/messages
Continue an active session
continueSession 4 params body → 200400401403404422423429
DELETE
/v5.3.0/sessions/{session-id}
End an active session
endSession 5 params → 200400401403404422423429

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are ResponseEnvelope (9 properties), ChatMessageResponseEnvelope (8 properties), InitMessageEnvelope (7 properties), ChoicesResponseMessage (6 properties). Each schema is shown below with its type and property counts.

ResponseEnvelope
object
9 properties 5 required
TransferFailedRequestMessage
object
5 properties 3 required
MoneyVariable
object
3 properties 3 required
NormalizedEntity
object
4 properties 3 required
TextResponseMessage
object
5 properties 3 required
ChatMessageEnvelope
object
2 properties 1 required
SetVariablesMessage
object
Update existing session variables
3 properties 3 required
FeedbackId
string
unique ID to identify the generation, used to submit feedback
Links
object
List of Einstein Bots API endpoints for HATEOS compliancy.
3 properties 1 required
ObjectVariable
object
3 properties 3 required
ListVariable
object
3 properties 3 required
TextMessage
object
4 properties 3 required
ExternalSessionKey
string
UUID in string format for the conversation. You can use this parameter to trace the conversation in your bot's event logs.
ChatMessageResponseEnvelope
object
8 properties 4 required
EntityType
string
System or custom entity Type ([What’s an Entity?](https://help.salesforce.com/s/articleView?id=sf.botsservicewhatsanentity.htm&type=5)).
TextInitMessage
object
1 property
SequenceId
integer
Client-generated sequence number of the message in a session. Increase this number for each subsequent message.
Error
object
6 properties 6 required
ResponseOptionsVariables
object
Variables returned in the response.
3 properties 2 required
SessionEndedResponseMessage
object
5 properties 3 required
HyperLink
object
Hyperlink object included in the Links schema
1 property
ResponseSessionId
string
Bot runtime session ID.
BotVersion
stringnull
Bot configuration version.
EntitySource
string
"Prediction system that detects the entity. The Bot API can call NLPs or it can figure out the entity by itself." BOTSERVICE—Bot detects entity without Natural…
DateVariable
object
3 properties 3 required
IntentSource
string
Prediction system that detects the intent. DIRECT—Utterance search or an exact match CORENLP—Third-party Natural Language Processing (NLP) EINSTEINNLP—Einstein…
RefVariable
object
3 properties 3 required
InitMessageEnvelope
object
7 properties 2 required
Intents
array
Array of the intents detected by the bot when processing the request. For a bot, "intent" refers to the goal the customer (see [Use Intents to Understand Your…
Schedule
object
1 property 1 required
TransferSucceededRequestMessage
object
3 properties 2 required
EscalateResponseMessage
object
5 properties 3 required
RedirectMessage
object
3 properties 3 required
NumberVariable
object
3 properties 3 required
ResponseOptions
object
Configuration of additional information returned in the response payload.
4 properties
BooleanVariable
object
3 properties 3 required
ForceConfig
object
API configuration parameters.
1 property 1 required
DateTimeVariable
object
3 properties 3 required
Entities
array
Array of all entities detected by the bot when processing this request. For a bot, "Entities" refer to the modifiers the customer uses to describe their issue…
EndSessionReason
string
ChoiceMessage
object
5 properties 2 required
InReplyToMessageId
string
Message ID of the previous response you are replying to.
Referrer
object
2 properties 2 required
Variables
arraynull
Array of custom and context variables passed to the bot when initiating a session (see [What’s a Variable?](https://help.salesforce.com/s/articleView?id=sf.bot…
TextVariable
object
3 properties 3 required
ChoicesResponseMessage
object
6 properties 4 required
NormalizedIntent
object
3 properties 3 required
MessageId
string
UUID that references this message.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

service-cloud-bot-api-openapi.yml Raw ↑

Other APIs Salesforce Service Cloud APIs publishes across the network.

Service Cloud REST API
AE Profile APIs.io
Service Cloud Case Management API
AE Profile APIs.io
Service Cloud Knowledge API
AE Profile APIs.io
Service Cloud Omni-Channel API
AE Profile APIs.io
Service Cloud Live Agent API
AE Profile APIs.io
Service Cloud Pub/Sub API
AE Profile APIs.io
Service Cloud Streaming API
AE Profile APIs.io
Service Cloud CTI API
AE Profile APIs.io
Salesforce Hosted MCP Servers
AE Profile APIs.io
Salesforce Service Cloud APIs Health API
AE Profile APIs.io
Salesforce Service Cloud APIs Versions API
AE Profile APIs.io
#Bot
← Back to S APIs
API Details
ID
service-cloud:service-cloud-bot-api
Server
https://runtime-api-na-west.prod.chatbots.sfdc.sh
Provider
Salesforce Service Cloud APIs
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=service-cloud-bot-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/service-cloud-bot-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Salesforce Service Cloud APIs Bot API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.