Salesforce Einstein

opencollection: 1.0.0
info:
  name: Salesforce Einstein Vision API
  version: 2.0.0
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Datasets
    type: folder
  items:
  - info:
      name: Salesforce Einstein List datasets
      type: http
    http:
      method: GET
      url: https://api.einstein.ai/v2/vision/datasets
      params:
      - name: offset
        value: ''
        type: query
        description: Zero-based offset of the first dataset to return.
      - name: count
        value: ''
        type: query
        description: Maximum number of datasets to return.
    docs: Returns a list of all datasets associated with the account.
  - info:
      name: Salesforce Einstein Create a dataset
      type: http
    http:
      method: POST
      url: https://api.einstein.ai/v2/vision/datasets
      body:
        type: multipart-form
        data:
        - name: name
          type: text
          value: ''
        - name: type
          type: text
          value: ''
        - name: path
          type: text
          value: ''
    docs: Creates a new dataset for image classification or object detection.
  - info:
      name: Salesforce Einstein Get a dataset
      type: http
    http:
      method: GET
      url: https://api.einstein.ai/v2/vision/datasets/:datasetId
      params:
      - name: datasetId
        value: ''
        type: path
        description: Unique identifier for the dataset.
    docs: Returns details of a specific dataset.
  - info:
      name: Salesforce Einstein Delete a dataset
      type: http
    http:
      method: DELETE
      url: https://api.einstein.ai/v2/vision/datasets/:datasetId
      params:
      - name: datasetId
        value: ''
        type: path
        description: Unique identifier for the dataset.
    docs: Deletes a dataset and all associated examples and models.
- info:
    name: Examples
    type: folder
  items:
  - info:
      name: Salesforce Einstein List examples in a dataset
      type: http
    http:
      method: GET
      url: https://api.einstein.ai/v2/vision/datasets/:datasetId/examples
      params:
      - name: datasetId
        value: ''
        type: path
        description: Unique identifier for the dataset.
      - name: offset
        value: ''
        type: query
      - name: count
        value: ''
        type: query
      - name: source
        value: ''
        type: query
        description: Filter by source type.
    docs: Returns a list of examples in the specified dataset.
  - info:
      name: Salesforce Einstein Add an example to a dataset
      type: http
    http:
      method: POST
      url: https://api.einstein.ai/v2/vision/datasets/:datasetId/examples
      params:
      - name: datasetId
        value: ''
        type: path
        description: Unique identifier for the dataset.
      body:
        type: multipart-form
        data:
        - name: name
          type: text
          value: ''
        - name: labelId
          type: text
          value: ''
        - name: data
          type: text
          value: ''
    docs: Adds a labeled image example to an existing dataset.
- info:
    name: Models
    type: folder
  items:
  - info:
      name: Salesforce Einstein List models for a dataset
      type: http
    http:
      method: GET
      url: https://api.einstein.ai/v2/vision/datasets/:datasetId/models
      params:
      - name: datasetId
        value: ''
        type: path
        description: Unique identifier for the dataset.
    docs: Returns all models trained on the specified dataset.
  - info:
      name: Salesforce Einstein Train a model
      type: http
    http:
      method: POST
      url: https://api.einstein.ai/v2/vision/train
      body:
        type: multipart-form
        data:
        - name: name
          type: text
          value: ''
        - name: datasetId
          type: text
          value: ''
        - name: trainParams
          type: text
          value: ''
        - name: algorithm
          type: text
          value: ''
        - name: epochs
          type: text
          value: ''
        - name: learningRate
          type: text
          value: ''
    docs: Trains a model on a dataset. Training is asynchronous.
  - info:
      name: Salesforce Einstein Retrain a model
      type: http
    http:
      method: POST
      url: https://api.einstein.ai/v2/vision/retrain
      body:
        type: multipart-form
        data:
        - name: modelId
          type: text
          value: ''
        - name: epochs
          type: text
          value: ''
        - name: learningRate
          type: text
          value: ''
    docs: Retrains an existing model with additional data.
  - info:
      name: Salesforce Einstein Get model details
      type: http
    http:
      method: GET
      url: https://api.einstein.ai/v2/vision/models/:modelId
      params:
      - name: modelId
        value: ''
        type: path
        description: Unique identifier for the model.
    docs: Returns the details and metrics of a trained model.
  - info:
      name: Salesforce Einstein Delete a model
      type: http
    http:
      method: DELETE
      url: https://api.einstein.ai/v2/vision/models/:modelId
      params:
      - name: modelId
        value: ''
        type: path
        description: Unique identifier for the model.
    docs: Deletes a trained model.
  - info:
      name: Salesforce Einstein Get model learning curve
      type: http
    http:
      method: GET
      url: https://api.einstein.ai/v2/vision/models/:modelId/lc
      params:
      - name: modelId
        value: ''
        type: path
        description: Unique identifier for the model.
    docs: Returns the learning curve data for a trained model.
- info:
    name: Predictions
    type: folder
  items:
  - info:
      name: Salesforce Einstein Make a prediction
      type: http
    http:
      method: POST
      url: https://api.einstein.ai/v2/vision/predict
      body:
        type: multipart-form
        data:
        - name: modelId
          type: text
          value: ''
        - name: sampleLocation
          type: text
          value: ''
        - name: sampleContent
          type: text
          value: ''
        - name: sampleBase64Content
          type: text
          value: ''
        - name: numResults
          type: text
          value: ''
    docs: Classifies an image using a trained model. Submit either an image file or a URL to an image.
  - info:
      name: Salesforce Einstein Detect objects in an image
      type: http
    http:
      method: POST
      url: https://api.einstein.ai/v2/vision/detect
      body:
        type: multipart-form
        data:
        - name: modelId
          type: text
          value: ''
        - name: sampleLocation
          type: text
          value: ''
        - name: sampleContent
          type: text
          value: ''
        - name: sampleBase64Content
          type: text
          value: ''
    docs: Detects objects and their bounding boxes in an image.
- info:
    name: API Usage
    type: folder
  items:
  - info:
      name: Salesforce Einstein Get API usage
      type: http
    http:
      method: GET
      url: https://api.einstein.ai/v2/vision/apiusage
    docs: Returns API usage data for the account.
bundled: true