Get Credentials

Get credentials

After signing in, you can create credentials that can be used to call the Platform APIs.

Sensei Machine Learning API (1.0)

Download OpenAPI specification:Download

Sensei Machine Learning API provides a mechanism for data scientists to organize and manage ML services from algorithm onboarding through experimentation and to service deployment.

Related documentation:

Visualize API calls with Postman (a free, third-party software):

API paths:

  • PLATFORM Gateway URL: https://platform.adobe.io/
  • Base path for this API: /data/sensei
  • Example of a complete path: https://platform.adobe.io/data/sensei/engines

Required headers:

  • All calls require the headers Authorization, x-gw-ims-org-id, and x-api-key. For more information on how to obtain these values, see the authentication tutorial.
  • All resources in Experience Platform are isolated to specific virtual sandboxes. All requests to Platform APIs require the header x-sandbox-name whose value is the all-lowercase name of the sandbox the operation will take place in (for example, "prod"). See the sandboxes overview for more information.
  • All requests with a payload in the request body (such as POST, PUT, and PATCH calls) must include the header Content-Type with a value of application/json.

API error handling:

Engines

Engines act as an umbrella entity holding all machine learning instances. This is tied to a Docker image, Java archive, or EGG file which contains machine learning logic to train and score a Model.

List all engines

Lists all engines providing mechanisms for pagination, filtering, and sorting.

Request
query Parameters
start
string

Start value for pagination. Indicates the starting index for the items to return.

limit
integer <int32> [ 0 .. 100 ]
Default: 25

Limit value for pagination. Indicates the requested number of items to return. The service may return a different number of items than requested.

orderby
Array of strings
Default: "[\"-updated\"]"

Sort order for pagination. Indicates the fields and direction to use for sorting in priority order.

property
Array of strings

Property matching expression for filtering paginated results. Indicates the comparison expression that items must match in order to be returned.

header Parameters
x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

get/engines
Response samples
application/vnd.adobe.platform.sensei+json;profile=engineListing.v1.json
{
  • "children": [
    ],
  • "_page": {
    },
  • "_links": {
    }
}

Create a new Engine

Creates a new Engine

Request
header Parameters
x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

Request Body schema: multipart/form-data
engine
string

Engine entity description

defaultArtifact
string <binary>

The binary Engine artifact (e.g. JAR, EGG) used for all operations by default

preprocessOverrideArtifact
string <binary>

The binary Engine artifact (e.g. JAR, EGG) used for the 'preprocess' operation

featurePipelineOverrideArtifact
string <binary>

The binary Engine artifact (e.g. JAR, EGG) used for the 'preprocess' operation

trainOverrideArtifact
string <binary>

The binary Engine artifact (e.g. JAR, EGG) used for the 'train' operation

batchScoreOverrideArtifact
string <binary>

The binary Engine artifact (e.g. JAR, EGG) used for the 'batchScore' operation

validateOverrideArtifact
string <binary>

The binary Engine artifact (e.g. JAR, EGG) used for the 'validate' operation

evaluateOverrideArtifact
string <binary>

The binary Engine artifact (e.g. JAR, EGG) used for the 'evaluate' operation

publishOverrideArtifact
string <binary>

The binary Engine artifact (e.g. JAR, EGG) used for the 'publish' operation

Responses
201

Success

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

415

Unsupported media type

422

Unprocessable entity

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

post/engines
Response samples
application/vnd.adobe.platform.sensei+json;profile=engine.v1.json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "documentationUrl": "string",
  • "type": "string",
  • "iconUrl": "string",
  • "gitRepo": "string",
  • "algorithm": "string",
  • "language": [
    ],
  • "mlLibrary": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": false,
  • "_links": {
    },
  • "artifacts": {
    },
  • "tags": {
    }
}

Get Docker registry information

Get Docker registry information

Request
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

get/engines/dockerRegistry
Response samples
application/vnd.adobe.platform.sensei+json;profile=enginesDockerRegistryInfo.v1.json
{
  • "host": "string",
  • "username": "string",
  • "password": "string"
}

Retrieve an Engine

Retrieves a specific Engine

Request
path Parameters
engineId
required
string

The identifier of the Sensei Engine

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

get/engines/{engineId}
Response samples
application/vnd.adobe.platform.sensei+json;profile=engine.v1.json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "documentationUrl": "string",
  • "type": "string",
  • "iconUrl": "string",
  • "gitRepo": "string",
  • "algorithm": "string",
  • "language": [
    ],
  • "mlLibrary": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": false,
  • "_links": {
    },
  • "artifacts": {
    },
  • "tags": {
    }
}

Update an Engine

Updates a specific Engine

Request
path Parameters
engineId
required
string

The identifier of the Sensei Engine

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

If-Match
string

Optional header field with ETag value provided by client

Content-Type
required
string

application/vnd.adobe.platform.sensei+json;profile=engine.v1.json

Request Body schema: application/vnd.adobe.platform.sensei+json;profile=engine.v1.json
required

Engine object to be updated

name
required
string
description
string
documentationUrl
string
type
string
iconUrl
string

Url of the thumbnail image

gitRepo
string
algorithm
string
language
Array of strings
Items Enum: "Python" "Java" "Scala" "R" "C++"
mlLibrary
string
object
deleted
boolean
Default: false
object
object
object
Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

put/engines/{engineId}
Request samples
application/vnd.adobe.platform.sensei+json;profile=engine.v1.json
{
  • "name": "string",
  • "description": "string",
  • "documentationUrl": "string",
  • "type": "string",
  • "iconUrl": "string",
  • "gitRepo": "string",
  • "algorithm": "string",
  • "language": [
    ],
  • "mlLibrary": "string",
  • "createdBy": {
    },
  • "deleted": false,
  • "_links": {
    },
  • "artifacts": {
    },
  • "tags": {
    }
}
Response samples
application/vnd.adobe.platform.sensei+json;profile=engine.v1.json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "documentationUrl": "string",
  • "type": "string",
  • "iconUrl": "string",
  • "gitRepo": "string",
  • "algorithm": "string",
  • "language": [
    ],
  • "mlLibrary": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": false,
  • "_links": {
    },
  • "artifacts": {
    },
  • "tags": {
    }
}

Delete an existing Engine

Deletes a specific Engine

Request
path Parameters
engineId
required
string

The identifier of the Sensei Engine

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

delete/engines/{engineId}
Response samples
application/vnd.adobe.platform.sensei+json;profile=api-response.v1.json
{}

MLInstances

MLInstances represent the combination of a specific Engine with particular set of configurations. An instance is often use-case specific for a customer or client.

List MLInstances

MLInstances may be searched by name or tags.

Request
query Parameters
start
string

Start value for pagination. Indicates the starting index for the items to return.

limit
integer <int32> [ 0 .. 100 ]
Default: 25

Limit value for pagination. Indicates the requested number of items to return. The service may return a different number of items than requested.

orderby
Array of strings
Default: "[\"-updated\"]"

Sort order for pagination. Indicates the fields and direction to use for sorting in priority order.

property
Array of strings

Property matching expression for filtering paginated results. Indicates the comparison expression that items must match in order to be returned.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

get/mlInstances
Response samples
application/vnd.adobe.platform.sensei+json;profile=mlInstanceListing.v1.json
{
  • "children": [
    ],
  • "_page": {
    },
  • "_links": {
    }
}

Add a new MLInstance.

Creates a new MLInstance of an Engine

Request
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Content-Type
required
string

application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json

Request Body schema: application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json
required

MLInstance object that needs to be added. Note that a valid engineId has to be listed in the object.

name
required
string
description
string
engineId
string
object
deleted
boolean
Default: false
object
object
Array of objects (MLInstanceTaskList)
Responses
201

Success

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

415

Unsupported media type

422

Unprocessable entity

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

post/mlInstances
Request samples
application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json
{
  • "name": "string",
  • "description": "string",
  • "engineId": "string",
  • "createdBy": {
    },
  • "deleted": false,
  • "_links": {
    },
  • "tags": {
    },
  • "tasks": [
    ]
}
Response samples
application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "engineId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": false,
  • "_links": {
    },
  • "tags": {
    },
  • "tasks": [
    ]
}

Delete MLinstances by engineId

Deletes all MLinstances for provided engineId.

Request
query Parameters
engineId
required
string

The engineId for which MLinstances should be deleted

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

404

Not found

410

Resource gone

500

Internal server error

503

Service unavailable

delete/mlInstances
Response samples
application/vnd.adobe.platform.sensei+json;profile=api-response.v1.json
{}

Retrieve an MLInstance

Request
path Parameters
mlInstanceId
required
string

The identifier of the Sensei ML instance

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

get/mlInstances/{mlInstanceId}
Response samples
application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "engineId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": false,
  • "_links": {
    },
  • "tags": {
    },
  • "tasks": [
    ]
}

Update a MLInstance by ID.

Request
path Parameters
mlInstanceId
required
string

The identifier of the Sensei ML instance

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

If-Match
string

Optional header field with ETag value provided by client

Content-Type
required
string

application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json

Request Body schema: application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json
required

MLInstance object to be updated

name
required
string
description
string
engineId
string
object
deleted
boolean
Default: false
object
object
Array of objects (MLInstanceTaskList)
Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

put/mlInstances/{mlInstanceId}
Request samples
application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json
{
  • "name": "string",
  • "description": "string",
  • "engineId": "string",
  • "createdBy": {
    },
  • "deleted": false,
  • "_links": {
    },
  • "tags": {
    },
  • "tasks": [
    ]
}
Response samples
application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "engineId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": false,
  • "_links": {
    },
  • "tags": {
    },
  • "tasks": [
    ]
}

Delete an MLInstance

Request
path Parameters
mlInstanceId
required
string

The identifier of the Sensei ML instance

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

delete/mlInstances/{mlInstanceId}
Response samples
application/vnd.adobe.platform.sensei+json;profile=api-response.v1.json
{}

MLServices

An MLService is a published trained model that provides your organization with the ability to access and reuse previously developed models. A key feature of MLServices is the ability to automate training and scoring on a scheduled basis.

List all filtered MLServices

MLServices may be searched by name or tags.

Request
query Parameters
start
string

Start value for pagination. Indicates the starting index for the items to return.

limit
integer <int32> [ 0 .. 100 ]
Default: 25

Limit value for pagination. Indicates the requested number of items to return. The service may return a different number of items than requested.

orderby
Array of strings
Default: "[\"-updated\"]"

Sort order for pagination. Indicates the fields and direction to use for sorting in priority order.

property
Array of strings

Property matching expression for filtering paginated results. Indicates the comparison expression that items must match in order to be returned.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

get/mlServices
Response samples
application/vnd.adobe.platform.sensei+json;profile=mlServiceListing.v1.json
{
  • "children": [
    ],
  • "_page": {
    },
  • "_links": {
    }
}

Create an MLService

Creates a new MLService of an MLInstance

Request
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Request Body schema: application/vnd.adobe.platform.sensei+json;profile=mlService.v1.json
required

MLService object that needs to be added. Note that a valid mlInstanceId has to be listed in the object.

name
required
string
description
string
mlInstanceId
required
string
trainingExperimentId
string
trainingExperimentRunId
string
trainingDataSetId
string
trainingTimeframe
integer <int32>
scoringExperimentId
string
scoringDataSetId
required
string
scoringTimeframe
required
integer <int32>
object
required
object
object
deleted
boolean
Default: false
object
object
Responses
201

Success

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

415

Unsupported media type

422

Unprocessable entity

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

post/mlServices
Request samples
application/vnd.adobe.platform.sensei+json;profile=mlService.v1.json
{
  • "name": "string",
  • "description": "string",
  • "mlInstanceId": "string",
  • "trainingExperimentId": "string",
  • "trainingExperimentRunId": "string",
  • "trainingDataSetId": "string",
  • "trainingTimeframe": 0,
  • "scoringExperimentId": "string",
  • "scoringDataSetId": "string",
  • "scoringTimeframe": 0,
  • "trainingSchedule": {
    },
  • "scoringSchedule": {
    },
  • "createdBy": {
    },
  • "deleted": false,
  • "_links": {
    },
  • "tags": {
    }
}
Response samples
application/vnd.adobe.platform.sensei+json;profile=mlService.v1.json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "mlInstanceId": "string",
  • "trainingExperimentId": "string",
  • "trainingExperimentRunId": "string",
  • "trainingDataSetId": "string",
  • "trainingTimeframe": 0,
  • "scoringExperimentId": "string",
  • "scoringDataSetId": "string",
  • "scoringTimeframe": 0,
  • "trainingSchedule": {
    },
  • "scoringSchedule": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": false,
  • "_links": {
    },
  • "tags": {
    }
}

Delete all MLServices

Deletes all MLServices for provided mlInstanceId

Request
query Parameters
mlInstanceId
required
string

The mlInstanceId for which MLServices should be deleted

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

404

Not found

410

Resource gone

500

Internal server error

503

Service unavailable

delete/mlServices
Response samples
application/vnd.adobe.platform.sensei+json;profile=api-response.v1.json
{}

Retrieve an MLService

Request
path Parameters
serviceId
required
string

The identifier of the Sensei Service

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

get/mlServices/{serviceId}
Response samples
No sample

Update an MLService

Request
path Parameters
serviceId
required
string

The identifier of the Sensei Service

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

If-Match
string

Optional header field with ETag value provided by client

Request Body schema: application/vnd.adobe.platform.sensei+json;profile=mlService.v1.json
required

MLService object to be updated

name
required
string
description
string
mlInstanceId
required
string
trainingExperimentId
string
trainingExperimentRunId
string
trainingDataSetId
string
trainingTimeframe
integer <int32>
scoringExperimentId
string
scoringDataSetId
required
string
scoringTimeframe
required
integer <int32>
object
required
object
object
deleted
boolean
Default: false
object
object
Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

put/mlServices/{serviceId}
Request samples
application/vnd.adobe.platform.sensei+json;profile=mlService.v1.json
{
  • "name": "string",
  • "description": "string",
  • "mlInstanceId": "string",
  • "trainingExperimentId": "string",
  • "trainingExperimentRunId": "string",
  • "trainingDataSetId": "string",
  • "trainingTimeframe": 0,
  • "scoringExperimentId": "string",
  • "scoringDataSetId": "string",
  • "scoringTimeframe": 0,
  • "trainingSchedule": {
    },
  • "scoringSchedule": {
    },
  • "createdBy": {
    },
  • "deleted": false,
  • "_links": {
    },
  • "tags": {
    }
}
Response samples
application/vnd.adobe.platform.sensei+json;profile=mlService.v1.json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "mlInstanceId": "string",
  • "trainingExperimentId": "string",
  • "trainingExperimentRunId": "string",
  • "trainingDataSetId": "string",
  • "trainingTimeframe": 0,
  • "scoringExperimentId": "string",
  • "scoringDataSetId": "string",
  • "scoringTimeframe": 0,
  • "trainingSchedule": {
    },
  • "scoringSchedule": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": false,
  • "_links": {
    },
  • "tags": {
    }
}

Delete an MLService

Request
path Parameters
serviceId
required
string

The identifier of the Sensei Service

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

delete/mlServices/{serviceId}
Response samples
application/vnd.adobe.platform.sensei+json;profile=api-response.v1.json
{}

Experiments

A data scientist conducts multiple experiments to arrive at a high-performing Model while training. This can include changing datasets, features, learning parameters, and hardware.

Retrieve an MLInstance's experiments

Request
query Parameters
start
string

Start value for pagination. Indicates the starting index for the items to return.

limit
integer <int32> [ 0 .. 100 ]
Default: 25

Limit value for pagination. Indicates the requested number of items to return. The service may return a different number of items than requested.

orderby
Array of strings
Default: "[\"-updated\"]"

Sort order for pagination. Indicates the fields and direction to use for sorting in priority order.

property
Array of strings

Property matching expression for filtering paginated results. Indicates the comparison expression that items must match in order to be returned.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

get/experiments
Response samples
application/vnd.adobe.platform.sensei+json;profile=experimentListing.v1.json
{
  • "children": [
    ],
  • "_page": {
    },
  • "_links": {
    }
}

Create an experiment

Request
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Content-Type
required
string

application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json

Request Body schema: application/vnd.adobe.platform.sensei+json;profile=experiment.v1.json
required

Experiment object that needs to be created

name
required
string
mlInstanceId
string
mlInstanceQuery
string
description
string
object
deleted
boolean
Default: false
createdByService
boolean
Default: false
workflowId
string
object
object
object (ExperimentTemplate)
Responses
201

Success

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

415

Unsupported media type

422

Unprocessable entity

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

post/experiments
Request samples
application/vnd.adobe.platform.sensei+json;profile=experiment.v1.json
{
  • "name": "string",
  • "mlInstanceId": "string",
  • "mlInstanceQuery": "string",
  • "description": "string",
  • "createdBy": {
    },
  • "deleted": false,
  • "createdByService": false,
  • "workflowId": "string",
  • "_links": {
    },
  • "tags": {
    },
  • "template": {
    }
}
Response samples
application/vnd.adobe.platform.sensei+json;profile=experiment.v1.json
{
  • "id": "string",
  • "name": "string",
  • "mlInstanceId": "string",
  • "mlInstanceQuery": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": false,
  • "createdByService": false,
  • "workflowId": "string",
  • "_links": {
    },
  • "tags": {
    },
  • "template": {
    }
}

Delete experiments by mlInstanceId

Deletes all experiments for the provided mlInstance.

Request
query Parameters
mlInstanceId
required
string

The mlInstanceId for which experiments should be deleted

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

404

Not found

410

Resource gone

500

Internal server error

503

Service unavailable

delete/experiments
Response samples
application/vnd.adobe.platform.sensei+json;profile=api-response.v1.json
{}

Retrieve an experiment

Request
path Parameters
experimentId
required
string

The identifier of the experiment

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

get/experiments/{experimentId}
Response samples
application/vnd.adobe.platform.sensei+json;profile=experiment.v1.json
{
  • "id": "string",
  • "name": "string",
  • "mlInstanceId": "string",
  • "mlInstanceQuery": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": false,
  • "createdByService": false,
  • "workflowId": "string",
  • "_links": {
    },
  • "tags": {
    },
  • "template": {
    }
}

Update an experiment

Request
path Parameters
experimentId
required
string

The identifier of the experiment

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

If-Match
string

Optional header field with ETag value provided by client

Content-Type
required
string

application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json

Request Body schema: application/vnd.adobe.platform.sensei+json;profile=experiment.v1.json
required

Experiment object to be updated

name
required
string
mlInstanceId
string
mlInstanceQuery
string
description
string
object
deleted
boolean
Default: false
createdByService
boolean
Default: false
workflowId
string
object
object
object (ExperimentTemplate)
Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

put/experiments/{experimentId}
Request samples
application/vnd.adobe.platform.sensei+json;profile=experiment.v1.json
{
  • "name": "string",
  • "mlInstanceId": "string",
  • "mlInstanceQuery": "string",
  • "description": "string",
  • "createdBy": {
    },
  • "deleted": false,
  • "createdByService": false,
  • "workflowId": "string",
  • "_links": {
    },
  • "tags": {
    },
  • "template": {
    }
}
Response samples
application/vnd.adobe.platform.sensei+json;profile=experiment.v1.json
{
  • "id": "string",
  • "name": "string",
  • "mlInstanceId": "string",
  • "mlInstanceQuery": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": false,
  • "createdByService": false,
  • "workflowId": "string",
  • "_links": {
    },
  • "tags": {
    },
  • "template": {
    }
}

Delete an experiment

Request
path Parameters
experimentId
required
string

The identifier of the experiment

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

delete/experiments/{experimentId}
Response samples
application/vnd.adobe.platform.sensei+json;profile=api-response.v1.json
{}

List experiment runs

Request
path Parameters
experimentId
required
string

The identifier of the experiment

query Parameters
start
string

Start value for pagination. Indicates the starting index for the items to return.

limit
integer <int32> [ 0 .. 100 ]
Default: 25

Limit value for pagination. Indicates the requested number of items to return. The service may return a different number of items than requested.

orderby
Array of strings
Default: "[\"-updated\"]"

Sort order for pagination. Indicates the fields and direction to use for sorting in priority order.

property
Array of strings

Property matching expression for filtering paginated results. Indicates the comparison expression that items must match in order to be returned.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

get/experiments/{experimentId}/runs
Response samples
application/vnd.adobe.platform.sensei+json;profile=experimentRunListing.v1.json
{
  • "children": [
    ],
  • "_page": {
    },
  • "_links": {
    }
}

Create an experiment run

Request
path Parameters
experimentId
required
string

The identifier of the experiment

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Content-Type
required
string

application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json

Request Body schema: application/vnd.adobe.platform.sensei+json;profile=experimentRun.v1.json
required

Run object that needs to be added

id
string
mode
string
description
string
experimentId
required
string
object
deleted
boolean
Default: false
object
Array of objects (MLInstanceTaskList)
object
Responses
201

Success

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

415

Unsupported media type

422

Unprocessable entity

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

post/experiments/{experimentId}/runs
Request samples
application/vnd.adobe.platform.sensei+json;profile=experimentRun.v1.json
{
  • "id": "string",
  • "mode": "string",
  • "description": "string",
  • "experimentId": "string",
  • "createdBy": {
    },
  • "deleted": false,
  • "_links": {
    },
  • "tasks": [
    ],
  • "runChain": {
    }
}
Response samples
application/vnd.adobe.platform.sensei+json;profile=experimentRun.v1.json
{
  • "id": "string",
  • "mode": "string",
  • "description": "string",
  • "experimentId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": false,
  • "_links": {
    },
  • "tasks": [
    ],
  • "runChain": {
    }
}

Retrieve experiment run information

Request
path Parameters
experimentId
required
string

The identifier of the experiment

experimentRunId
required
string

The identifier of the experiment run

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

get/experiments/{experimentId}/runs/{experimentRunId}
Response samples
application/vnd.adobe.platform.sensei+json;profile=experimentRun.v1.json
{
  • "id": "string",
  • "mode": "string",
  • "description": "string",
  • "experimentId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": false,
  • "_links": {
    },
  • "tasks": [
    ],
  • "runChain": {
    }
}

Retrieve an experiment run status

Request
path Parameters
experimentId
required
string

The identifier of the experiment

experimentRunId
required
string

The identifier of the experiment run

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

get/experiments/{experimentId}/runs/{experimentRunId}/status
Response samples
application/vnd.adobe.platform.sensei+json;profile=experimentRunStatus.v1.json
{
  • "id": "string",
  • "name": "string",
  • "experimentRunId": "string",
  • "description": "string",
  • "deleted": false,
  • "status": {
    }
}

Models

Allows machine learning Model management and registration (Model artifact that is created by the training process).

List all Models.

List all Models providing mechanisms for pagination, filtering, and sorting.

Request
query Parameters
start
string

Start value for pagination. Indicates the starting index for the items to return.

limit
integer <int32> [ 0 .. 100 ]
Default: 25

Limit value for pagination. Indicates the requested number of items to return. The service may return a different number of items than requested.

orderby
Array of strings
Default: "[\"-updated\"]"

Sort order for pagination. Indicates the fields and direction to use for sorting in priority order.

property
Array of strings

Property matching expression for filtering paginated results. Indicates the comparison expression that items must match in order to be returned.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

get/models
Response samples
application/vnd.adobe.platform.sensei+json;profile=modelListing.v1.json
{
  • "children": [
    ],
  • "_page": {
    },
  • "_links": {
    }
}

Create a Model.

Creates a Model for a particular Engine and MLinstance

Request
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Request Body schema: multipart/form-data
modelArtifact
string <binary>

The artifact containing the Model

model
string

Model object that needs to be created

Responses
201

Success

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

415

Unsupported media type

422

Unprocessable entity

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

post/models
Response samples
application/vnd.adobe.platform.sensei+json;profile=model.v1.json
{
  • "id": "string",
  • "name": "string",
  • "experimentId": "string",
  • "experimentRunId": "string",
  • "description": "string",
  • "modelArtifactUri": "string",
  • "state": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": false,
  • "_links": {
    },
  • "tags": {
    }
}

Retrieve a Model

Retrieves a specific Model

Request
path Parameters
modelId
required
string

The identifier of the trained or published Model

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

get/models/{modelId}
Response samples
application/vnd.adobe.platform.sensei+json;profile=model.v1.json
{
  • "id": "string",
  • "name": "string",
  • "experimentId": "string",
  • "experimentRunId": "string",
  • "description": "string",
  • "modelArtifactUri": "string",
  • "state": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": false,
  • "_links": {
    },
  • "tags": {
    }
}

Update a Model

Update an existing Model

Request
path Parameters
modelId
required
string

The identifier of the trained or published Model

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

If-Match
string

Optional header field with ETag value provided by client

Content-Type
required
string

application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json

Request Body schema: application/vnd.adobe.platform.sensei+json;profile=model.v1.json
required

Model object to be updated

id
string
name
string
experimentId
string
experimentRunId
required
string
description
string
modelArtifactUri
string
state
Array of strings
Items Enum: "trained" "published" "transcoded"
object
deleted
boolean
Default: false
object
object
Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

put/models/{modelId}
Request samples
application/vnd.adobe.platform.sensei+json;profile=model.v1.json
{
  • "id": "string",
  • "name": "string",
  • "experimentId": "string",
  • "experimentRunId": "string",
  • "description": "string",
  • "modelArtifactUri": "string",
  • "state": [
    ],
  • "createdBy": {
    },
  • "deleted": false,
  • "_links": {
    },
  • "tags": {
    }
}
Response samples
application/vnd.adobe.platform.sensei+json;profile=model.v1.json
{
  • "id": "string",
  • "name": "string",
  • "experimentId": "string",
  • "experimentRunId": "string",
  • "description": "string",
  • "modelArtifactUri": "string",
  • "state": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": false,
  • "_links": {
    },
  • "tags": {
    }
}

Delete a Model

Deletes a specific Model

Request
path Parameters
modelId
required
string

The identifier of the trained or published Model

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

delete/models/{modelId}
Response samples
application/vnd.adobe.platform.sensei+json;profile=api-response.v1.json
{}

Retrieve a binary Model artifact

Request
path Parameters
modelId
required
string

The identifier of the trained or published Model

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

get/models/{modelId}/artifact

List a model's transcodings

Request
path Parameters
modelId
required
string

The identifier of the trained or published Model

query Parameters
start
string

Start value for pagination. Indicates the starting index for the items to return.

limit
integer <int32> [ 0 .. 100 ]
Default: 25

Limit value for pagination. Indicates the requested number of items to return. The service may return a different number of items than requested.

orderby
Array of strings
Default: "[\"-updated\"]"

Sort order for pagination. Indicates the fields and direction to use for sorting in priority order.

property
Array of strings

Property matching expression for filtering paginated results. Indicates the comparison expression that items must match in order to be returned.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

get/models/{modelId}/transcodings
Response samples
application/vnd.adobe.platform.sensei+json;profile=modelTranscodingListing.v1.json
{
  • "children": [
    ],
  • "_page": {
    },
  • "_links": {
    }
}

Create a new transcoding

Request
path Parameters
modelId
required
string

The identifier of the trained or published Model

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Content-Type
required
string

application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json

Request Body schema: application/vnd.adobe.platform.sensei+json;profile=modelTranscoding.v1.json
required

Model transcoding to be created

id
string
modelId
required
string
targetFormat
string
Enum: "CoreML" "TF" "K2" "Deepnet"
object
deleted
boolean
Default: false
object
Responses
201

Success

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

415

Unsupported media type

422

Unprocessable entity

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

post/models/{modelId}/transcodings
Request samples
application/vnd.adobe.platform.sensei+json;profile=modelTranscoding.v1.json
{
  • "id": "string",
  • "modelId": "string",
  • "targetFormat": "CoreML",
  • "createdBy": {
    },
  • "deleted": false,
  • "_links": {
    }
}
Response samples
application/vnd.adobe.platform.sensei+json;profile=modelTranscoding.v1.json
{
  • "id": "string",
  • "modelId": "string",
  • "targetFormat": "CoreML",
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": false,
  • "_links": {
    }
}

Retrieve a Model transcoding

Request
path Parameters
modelId
required
string

The identifier of the trained or published Model

modelTranscodingId
required
string

The identifier of the transcoded Model artifact

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

get/models/{modelId}/transcodings/{modelTranscodingId}
Response samples
application/vnd.adobe.platform.sensei+json;profile=modelTranscoding.v1.json
{
  • "id": "string",
  • "modelId": "string",
  • "targetFormat": "CoreML",
  • "created": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "deleted": false,
  • "_links": {
    }
}

Insights

Insights contain metrics which are used to empower a data scientist to evaluate and choose optimal ML Models by displaying relevant evaluation metrics.

List all insights

Lists all insights for all experiment runs

Request
query Parameters
start
string

Start value for pagination. Indicates the starting index for the items to return.

limit
integer <int32> [ 0 .. 100 ]
Default: 25

Limit value for pagination. Indicates the requested number of items to return. The service may return a different number of items than requested.

orderby
Array of strings
Default: "[\"-updated\"]"

Sort order for pagination. Indicates the fields and direction to use for sorting in priority order.

property
Array of strings

Property matching expression for filtering paginated results. Indicates the comparison expression that items must match in order to be returned.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

get/insights
Response samples
application/vnd.adobe.platform.sensei+json;profile=insightListing.v1.json
{
  • "children": [
    ],
  • "_page": {
    },
  • "_links": {
    }
}

Create a new Model insight

Creates a new Model insight

Request
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Content-Type
required
string

application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json

Request Body schema: application/vnd.adobe.platform.sensei+json;profile=insight.v1.json
required

Insight object that needs to be added

id
string
object (InsightContext)
object (InsightEvent)
Array of objects (InsightMetricList)
object
Responses
201

Success

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

415

Unsupported media type

422

Unprocessable entity

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

post/insights
Request samples
application/vnd.adobe.platform.sensei+json;profile=insight.v1.json
{
  • "id": "string",
  • "context": {
    },
  • "events": {
    },
  • "metrics": [
    ],
  • "_links": {
    }
}
Response samples
application/vnd.adobe.platform.sensei+json;profile=insight.v1.json
{
  • "id": "string",
  • "context": {
    },
  • "events": {
    },
  • "metrics": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Retrieve an insight

Retrieves a specific insight

Request
path Parameters
insightId
required
string

The identifier of the Sensei Insight

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

get/insights/{insightId}
Response samples
application/vnd.adobe.platform.sensei+json;profile=insight.v1.json
{
  • "id": "string",
  • "context": {
    },
  • "events": {
    },
  • "metrics": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

List default metrics for algorithms

Lists all default metrics available for algorithms

Request
query Parameters
algorithm
string

The identifier of the algorithm type

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, Bearer {ACCESS_TOKEN}). For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

500

Internal server error

502

Bad gateway

503

Service unavailable

504

Gateway timeout

get/insights/metrics
Response samples
application/vnd.adobe.platform.sensei+json;profile=defaultMetricsListing.v1.json
{
  • "children": [
    ]
}