Salesforce Einstein AI Record Insights API

openapi: 3.1.0
info:
  title: Salesforce Einstein Bots AI Record Insights API
  description: Conversational AI API for building intelligent chatbots and virtual assistants. Einstein Bots provides REST endpoints to create, manage, and interact with AI-powered bots that can handle customer service conversations across channels.
  version: 58.0.0
  contact:
    name: Salesforce Developer Support
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Master Subscription Agreement
    url: https://www.salesforce.com/company/legal/agreements/
  termsOfService: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v58.0
  description: Salesforce Instance
  variables:
    instance:
      default: login
      description: Your Salesforce instance domain.
security:
- oauth2: []
tags:
- name: AI Record Insights
  description: Access AI-generated insights on records
paths:
  /einstein/ai-record-insights:
    post:
      operationId: getAIRecordInsights
      summary: Salesforce Einstein Get AI record insights
      description: Returns AI-generated insights for specified Salesforce records, including prediction factors and recommendations.
      tags:
      - AI Record Insights
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                predictionDefinition:
                  type: string
                  description: ID of the prediction definition.
                inputRecords:
                  type: array
                  description: List of record IDs to analyze.
                  items:
                    type: object
                    properties:
                      recordId:
                        type: string
                        description: Salesforce record ID.
              required:
              - predictionDefinition
              - inputRecords
      responses:
        '200':
          description: Successful response with record insights.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AIRecordInsightsResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    AIRecordInsightsResponse:
      type: object
      properties:
        recordInsights:
          type: array
          items:
            type: object
            properties:
              recordId:
                type: string
              insights:
                type: array
                items:
                  type: object
                  properties:
                    type:
                      type: string
                    label:
                      type: string
                    value:
                      type: number
                    factors:
                      type: array
                      items:
                        $ref: '#/components/schemas/PredictionFactor'
    Error:
      type: object
      properties:
        message:
          type: string
        errorCode:
          type: string
        fields:
          type: array
          items:
            type: string
    PredictionFactor:
      type: object
      properties:
        featureName:
          type: string
          description: Name of the feature contributing to the prediction.
        featureValue:
          type: string
          description: Value of the feature.
        importance:
          type: number
          description: Importance weight of the factor.
        direction:
          type: string
          enum:
          - Positive
          - Negative
          description: Whether the factor positively or negatively affects the prediction.
  responses:
    Unauthorized:
      description: Unauthorized.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      description: Salesforce OAuth 2.0 authentication.
      flows:
        authorizationCode:
          authorizationUrl: https://login.salesforce.com/services/oauth2/authorize
          tokenUrl: https://login.salesforce.com/services/oauth2/token
          scopes:
            api: Full access to Salesforce APIs
            einstein_gpt: Access to Einstein AI features