Salesforce Service Cloud APIs Health API

The health API from Salesforce Service Cloud APIs — 1 operation(s) for health.

Documentation GitHub OpenAPI

Operations 1

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /status Check whether the bots service is up · Check the health status #

Ask an LLM

“Is the Einstein Bots API up or down right now?”

“How can I tell if the bot service is healthy before routing chats to it?”

Tell an agent

Check the health status of the bots API.

Tell me whether the bot service is currently up.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/service-cloud-health-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Einstein Bots API (BETA) Health API
  version: v5.3.0
servers:
- url: https://runtime-api-na-west.prod.chatbots.sfdc.sh
  description: Einstein Bots API - NA West
- url: https://runtime-api-na-east.prod.chatbots.sfdc.sh
  description: Einstein Bots API - NA East
- url: https://runtime-api-eu-west.prod.chatbots.sfdc.sh
  description: Einstein Bots API - EU West
- url: https://runtime-api-eu-east.prod.chatbots.sfdc.sh
  description: Einstein Bots API - EU East
- url: https://runtime-api-ap-west.prod.chatbots.sfdc.sh
  description: Einstein Bots API - AP West
- url: https://runtime-api-ap-east.prod.chatbots.sfdc.sh
  description: Einstein Bots API - AP East
tags:
- name: Health
paths:
  /status:
    get:
      tags:
      - Health
      summary: Check the health status
      description: Returns whether the status of Einstein Bots API is up or down.
      operationId: checkHealthStatus
      responses:
        '200':
          $ref: '#/components/responses/StatusResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  schemas:
    Error:
      type: object
      properties:
        status:
          description: HTTP status.
          type: integer
          format: int32
        path:
          description: Request path.
          type: string
        requestId:
          description: Request ID. A UUID in string format to help with request tracking.
          type: string
        error:
          description: Error class name.
          type: string
        message:
          description: Exception message.
          type: string
        timestamp:
          description: Unix timestamp.
          type: integer
          format: int64
      required:
      - status
      - path
      - requestId
      - error
      - message
      - timestamp
      additionalProperties: false
    Status:
      type: object
      properties:
        status:
          type: string
          description: Health status of Einstein Bots API.
          enum:
          - UP
          - DOWN
          example: UP
      required:
      - status
      additionalProperties: false
  responses:
    ErrorResponse:
      description: Something went wrong
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      headers:
        X-Request-ID:
          description: Request ID. A UUID in string format to help with request tracking.
          example: 36a73651-a46d-4d16-9a8a-fd436ed62e1a
          schema:
            type: string
    StatusResponse:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Status'
  securitySchemes:
    chatbotAuth:
      type: oauth2
      description: chatbotAuth supports authorization code and implicit Oauth flows.
      flows:
        authorizationCode:
          authorizationUrl: https://login.salesforce.com/services/oauth2/authorize
          tokenUrl: https://login.salesforce.com/services/oauth2/token
          scopes:
            chatbot_api: Access bot APIs
        implicit:
          authorizationUrl: https://login.salesforce.com/services/oauth2/authorize
          scopes:
            chatbot_api: Access bot APIs
    jwtBearer:
      type: http
      scheme: bearer
      description: Salesforce OAuth access token obtained using the JWT Bearer flow. Use the `chatbot_api` scope with this flow to enable access to the Einstein Bots services.