Salesforce

Salesforce Models API

The Salesforce Models API provides Apex classes and REST endpoints that connect applications to large language models (LLMs) from Salesforce partners including Anthropic, Google, and OpenAI. It supports chat conversations, text generation, embeddings, and feedback collection, with all requests going through the Einstein Trust Layer.

GitHub OpenAPI
Business capability
Artificial Intelligence Management BC-610.60

Operations 1

GET /data/v64.0/smartdatadiscovery/predictionDefinitions/{PREDICTION_DEFINITION_ID}/models Salesforce Prediction Models #

Documentation

📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/
📖
APIReference
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/get_job_info.htm
📖
Authentication
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/bulk_api_2_0_security.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/
📖
GettingStarted
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started.htm
📖
APIReference
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list.htm
📖
Documentation
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/rest-api.html
📖
GettingStarted
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/get-started-spec.html
📖
APIReference
https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_overview.html
📖
Authentication
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/access-token-s2s.html
📖
Documentation
https://developer.salesforce.com/
📖
Documentation
https://developer.salesforce.com/docs/ai/agentforce/guide/models-api.html
📖
GettingStarted
https://developer.salesforce.com/docs/ai/agentforce/guide/models-get-started.html
📖
APIReference
https://developer.salesforce.com/docs/ai/agentforce/guide/access-models-api-with-rest.html
📖
Documentation
https://developer.salesforce.com/docs/ai/agentforce/guide/supported-models.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/openapi/salesforce-models-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/json-schema/salesforce-bulk-job-schema.json

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/salesforce-models-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

salesforce-models-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Salesforce Models API
  description: Find the resources you need to start building.
  contact: {}
  version: '1.0'
servers:
- url: https://login.salesforce.com
  variables: {}
- url: https://id
  variables: {}
- url: https://services
  variables: {}
- url: '{{url}}{{site}}/services/oauth2'
  variables:
    url:
      default: DefaultParameterValue
    site:
      default: DefaultParameterValue
security:
- oauth2:
  - api
tags:
- name: Models
paths:
  /data/v64.0/smartdatadiscovery/predictionDefinitions/{PREDICTION_DEFINITION_ID}/models:
    parameters: []
    get:
      tags:
      - Models
      summary: Salesforce Prediction Models
      description: Get available prediction definitions.
      operationId: Predictionmodels
      parameters:
      - name: PREDICTION_DEFINITION_ID
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Thu, 04 Mar 2021 13:48:31 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=31536002; includeSubDomains
            Expect-CT:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=86400, report-uri="https://a.forcesslreports.com/Expect-CT-report/00D5Y000001crJvm"
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/Predictionmodels'
                - examples:
                  - models:
                    - createdBy:
                        id: 0055Y00000DWwAIQA1
                        name: Philippe Ozil
                        profilePhotoUrl: https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T
                      createdDate: '2021-03-04T13:37:03.000Z'
                      fieldMappingList:
                      - modelField:
                          label: Category
                          name: Category
                          type: Text
                      - modelField:
                          label: Sales
                          name: Sales
                          type: Number
                      - modelField:
                          label: Profit per Order
                          name: Profit_per_Order
                          type: Number
                      - modelField:
                          label: Sub-Category
                          name: Sub_Category
                          type: Text
                      - modelField:
                          label: Quantity
                          name: Quantity
                          type: Number
                      filters: []
                      historyUrl: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models/1Ot5Y0000010wzNSAQ/histories
                      id: 1Ot5Y0000010wzNSAQ
                      isRefreshEnabled: false
                      label: superstore-orders
                      lastModifiedBy:
                        id: 0055Y00000DWwAIQA1
                        name: Philippe Ozil
                        profilePhotoUrl: https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T
                      lastModifiedDate: '2021-03-04T13:37:03.000Z'
                      model:
                        id: 1OT5Y0000010zlzWAA
                      modelType: Regression
                      name: superstore_orders
                      predictionDefinitionUrl: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA
                      prescribableFields:
                      - customDefinitions: []
                        field:
                          label: Quantity
                          name: Quantity
                          type: Number
                      sortOrder: 0
                      status: Enabled
                      url: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models/1Ot5Y0000010wzNSAQ
                    totalSize: 1
                    url: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models
                contentMediaType: application/json;charset=UTF-8
              example:
                models:
                - createdBy:
                    id: 0055Y00000DWwAIQA1
                    name: Philippe Ozil
                    profilePhotoUrl: https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T
                  createdDate: '2021-03-04T13:37:03.000Z'
                  fieldMappingList:
                  - modelField:
                      label: Category
                      name: Category
                      type: Text
                  - modelField:
                      label: Sales
                      name: Sales
                      type: Number
                  - modelField:
                      label: Profit per Order
                      name: Profit_per_Order
                      type: Number
                  - modelField:
                      label: Sub-Category
                      name: Sub_Category
                      type: Text
                  - modelField:
                      label: Quantity
                      name: Quantity
                      type: Number
                  filters: []
                  historyUrl: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models/1Ot5Y0000010wzNSAQ/histories
                  id: 1Ot5Y0000010wzNSAQ
                  isRefreshEnabled: false
                  label: superstore-orders
                  lastModifiedBy:
                    id: 0055Y00000DWwAIQA1
                    name: Philippe Ozil
                    profilePhotoUrl: https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T
                  lastModifiedDate: '2021-03-04T13:37:03.000Z'
                  model:
                    id: 1OT5Y0000010zlzWAA
                  modelType: Regression
                  name: superstore_orders
                  predictionDefinitionUrl: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA
                  prescribableFields:
                  - customDefinitions: []
                    field:
                      label: Quantity
                      name: Quantity
                      type: Number
                  sortOrder: 0
                  status: Enabled
                  url: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models/1Ot5Y0000010wzNSAQ
                totalSize: 1
                url: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ModelField:
      title: ModelField
      required:
      - label
      - name
      - type
      type: object
      properties:
        label:
          type: string
          example: Example Title
        name:
          type: string
          example: Example Title
        type:
          type: string
          example: example_value
      examples:
      - label: Category
        name: Category
        type: Text
    PrescribableField:
      title: PrescribableField
      required:
      - customDefinitions
      - field
      type: object
      properties:
        customDefinitions:
          type: array
          items:
            type: string
          description: ''
          example: []
        field:
          $ref: '#/components/schemas/Field'
      examples:
      - customDefinitions: []
        field:
          label: Quantity
          name: Quantity
          type: Number
    FieldMappingList:
      title: FieldMappingList
      required:
      - modelField
      type: object
      properties:
        modelField:
          $ref: '#/components/schemas/ModelField'
      examples:
      - modelField:
          label: Category
          name: Category
          type: Text
    Model:
      title: Model
      required:
      - id
      type: object
      properties:
        id:
          type: string
          example: abc123
      examples:
      - id: 1Ot5Y0000010wzNSAQ
    CreatedBy:
      title: CreatedBy
      required:
      - id
      - name
      - profilePhotoUrl
      type: object
      properties:
        id:
          type: string
          example: abc123
        name:
          type: string
          example: Example Title
        profilePhotoUrl:
          type: string
          example: https://www.example.com
      examples:
      - id: 0055Y00000DWwAIQA1
        name: Philippe Ozil
        profilePhotoUrl: https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T
    Model1:
      title: Model1
      required:
      - createdBy
      - createdDate
      - fieldMappingList
      - filters
      - historyUrl
      - id
      - isRefreshEnabled
      - label
      - lastModifiedBy
      - lastModifiedDate
      - model
      - modelType
      - name
      - predictionDefinitionUrl
      - prescribableFields
      - sortOrder
      - status
      - url
      type: object
      properties:
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        createdDate:
          type: string
          example: example_value
        fieldMappingList:
          type: array
          items:
            $ref: '#/components/schemas/FieldMappingList'
          description: ''
          example: []
        filters:
          type: array
          items:
            type: string
          description: ''
          example: []
        historyUrl:
          type: string
          example: https://www.example.com
        id:
          type: string
          example: abc123
        isRefreshEnabled:
          type: boolean
          example: true
        label:
          type: string
          example: Example Title
        lastModifiedBy:
          $ref: '#/components/schemas/LastModifiedBy'
        lastModifiedDate:
          type: string
          example: example_value
        model:
          $ref: '#/components/schemas/Model'
        modelType:
          type: string
          example: example_value
        name:
          type: string
          example: Example Title
        predictionDefinitionUrl:
          type: string
          example: https://www.example.com
        prescribableFields:
          type: array
          items:
            $ref: '#/components/schemas/PrescribableField'
          description: ''
          example: []
        sortOrder:
          type: integer
          contentEncoding: int32
          example: 10
        status:
          type: string
          example: example_value
        url:
          type: string
          example: https://www.example.com
      examples:
      - createdBy:
          id: 0055Y00000DWwAIQA1
          name: Philippe Ozil
          profilePhotoUrl: https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T
        createdDate: '2021-03-04T13:37:03.000Z'
        fieldMappingList:
        - modelField:
            label: Category
            name: Category
            type: Text
        - modelField:
            label: Sales
            name: Sales
            type: Number
        - modelField:
            label: Profit per Order
            name: Profit_per_Order
            type: Number
        - modelField:
            label: Sub-Category
            name: Sub_Category
            type: Text
        - modelField:
            label: Quantity
            name: Quantity
            type: Number
        filters: []
        historyUrl: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models/1Ot5Y0000010wzNSAQ/histories
        id: 1Ot5Y0000010wzNSAQ
        isRefreshEnabled: false
        label: superstore-orders
        lastModifiedBy:
          id: 0055Y00000DWwAIQA1
          name: Philippe Ozil
          profilePhotoUrl: https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T
        lastModifiedDate: '2021-03-04T13:37:03.000Z'
        model:
          id: 1OT5Y0000010zlzWAA
        modelType: Regression
        name: superstore_orders
        predictionDefinitionUrl: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA
        prescribableFields:
        - customDefinitions: []
          field:
            label: Quantity
            name: Quantity
            type: Number
        sortOrder: 0
        status: Enabled
        url: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models/1Ot5Y0000010wzNSAQ
    Predictionmodels:
      title: Predictionmodels
      required:
      - models
      - totalSize
      - url
      type: object
      properties:
        models:
          type: array
          items:
            $ref: '#/components/schemas/Model1'
          description: ''
          example: []
        totalSize:
          type: integer
          contentEncoding: int32
          example: 42
        url:
          type: string
          example: https://www.example.com
      examples:
      - models:
        - createdBy:
            id: 0055Y00000DWwAIQA1
            name: Philippe Ozil
            profilePhotoUrl: https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T
          createdDate: '2021-03-04T13:37:03.000Z'
          fieldMappingList:
          - modelField:
              label: Category
              name: Category
              type: Text
          - modelField:
              label: Sales
              name: Sales
              type: Number
          - modelField:
              label: Profit per Order
              name: Profit_per_Order
              type: Number
          - modelField:
              label: Sub-Category
              name: Sub_Category
              type: Text
          - modelField:
              label: Quantity
              name: Quantity
              type: Number
          filters: []
          historyUrl: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models/1Ot5Y0000010wzNSAQ/histories
          id: 1Ot5Y0000010wzNSAQ
          isRefreshEnabled: false
          label: superstore-orders
          lastModifiedBy:
            id: 0055Y00000DWwAIQA1
            name: Philippe Ozil
            profilePhotoUrl: https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T
          lastModifiedDate: '2021-03-04T13:37:03.000Z'
          model:
            id: 1OT5Y0000010zlzWAA
          modelType: Regression
          name: superstore_orders
          predictionDefinitionUrl: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA
          prescribableFields:
          - customDefinitions: []
            field:
              label: Quantity
              name: Quantity
              type: Number
          sortOrder: 0
          status: Enabled
          url: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models/1Ot5Y0000010wzNSAQ
        totalSize: 1
        url: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models
    LastModifiedBy:
      title: LastModifiedBy
      required:
      - id
      - name
      - profilePhotoUrl
      type: object
      properties:
        id:
          type: string
          example: abc123
        name:
          type: string
          example: Example Title
        profilePhotoUrl:
          type: string
          example: https://www.example.com
      examples:
      - id: 0055Y00000DWwAIQA1
        name: Philippe Ozil
        profilePhotoUrl: https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T
    Field:
      title: Field
      required:
      - label
      - name
      - type
      type: object
      properties:
        label:
          type: string
          example: Example Title
        name:
          type: string
          example: Example Title
        type:
          type: string
          example: example_value
      examples:
      - label: Quantity
        name: Quantity
        type: Number
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: '{DefaultParameterValue}{DefaultParameterValue}/services/oauth2/authorize'
          scopes:
            api: ''