S3

Use an S3 simple storage service as a data source location for data sets that are relevant to the workload being submitted.

List S3 assets.

get

Retrieve a list of S3 compatible datasource assets.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

namestringOptional

Filter results by name.

scopestringOptional

Filters results by scope. Returns only assets that belong to the specified scope. Mutually exclusive with includeDescendants. Valid values: tenant, cluster, department, project.

projectIdinteger · int32Optional

Filter results by project id. If scope filter is project, only assets from the specific project will be included in the response. Otherwise, the response will include project, department, cluster, tenant and system assets.

departmentIdstringOptional

Filter results by department id. If scope filter is department, only assets from the specific department will be included in the response. Otherwise, the response will include department, cluster, tenant and system assets.

Example: 1

clusterIdstring · uuidOptional

Filter results by Universally Unique Identifier (UUID) of the cluster. If scope filter is cluster, only assets from the specific cluster will be included in the response. Otherwise, the response will include cluster, tenant and system assets.

Example: d73a738f-fab3-430a-8fa3-5241493d7128

usageInfobooleanOptional

Whether the query should include asset usage information as part of the response.

complyToProjectinteger · int32Optional

Include workload creation compliance information of an asset, for a given project, as part of the response. To check compliance, you need to provide both project id and workload type.

complyToWorkloadTypestring · enumOptional

Include workload creation compliance information of an asset, for a given workload type, as part of the response. To check compliance, you need to provide both project id and workload type.

Possible values:

statusInfobooleanOptional

Whether the query should include asset status information as part of the response.

assetIdsstringOptional

Filter results by the ids of the assets. Provided value should be a comma separated string of UUIDs.

Example: dbf4767e-2fa1-43b0-97a2-7c0cecda180b,550e8400-e29b-41d4-a716-44665544000aPattern: ^\b(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})(?:,(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}))*\b$

complyToReplicaTypestring · enumOptional

Include workload creation compliance information of an asset, for a given replica type, as part of the response. To check compliance, you need to provide both project id and workload type. For distributed, replica type should be provided as well.

Possible values:

Responses

200

Request completed successfully.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

/api/v1/asset/datasource/s3

HTTPcURLJavaScriptPython

GET /api/v1/asset/datasource/s3 HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "entries": []
}

Create an S3 asset.

post

Use to create an S3 compatible datasource asset.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

Responses

202

Request accepted successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

409

The specified resource already exists

application/json

503

unexpected error

application/json

post

/api/v1/asset/datasource/s3

HTTPcURLJavaScriptPython

POST /api/v1/asset/datasource/s3 HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 316

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "inference": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "bucket": "my-bucket",
    "path": "/container/my-bucket",
    "url": "https://s3.amazonaws.com",
    "accessKeyAssetId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "[email protected]",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "[email protected]",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "bucket": "my-bucket",
    "path": "/container/my-bucket",
    "url": "https://s3.amazonaws.com",
    "accessKeyAssetId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "usageTimes": {
    "lastUsedByWorkload": "2026-02-05T00:00:42.691Z"
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  }
}

Get an S3 asset.

get

Retrieve the details of S3 compatible datasource asset by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Query parameters

usageInfobooleanOptional

Whether the query should include asset usage information as part of the response.

complyToProjectinteger · int32Optional

Include workload creation compliance information of an asset, for a given project, as part of the response. To check compliance, you need to provide both project id and workload type.

complyToWorkloadTypestring · enumOptional

Include workload creation compliance information of an asset, for a given workload type, as part of the response. To check compliance, you need to provide both project id and workload type.

Possible values:

statusInfobooleanOptional

Whether the query should include asset status information as part of the response.

complyToReplicaTypestring · enumOptional

Include workload creation compliance information of an asset, for a given replica type, as part of the response. To check compliance, you need to provide both project id and workload type. For distributed, replica type should be provided as well.

Possible values:

Responses

200

Request completed successfully.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

get

/api/v1/asset/datasource/s3/{AssetId}

HTTPcURLJavaScriptPython

GET /api/v1/asset/datasource/s3/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "[email protected]",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "[email protected]",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "bucket": "my-bucket",
    "path": "/container/my-bucket",
    "url": "https://s3.amazonaws.com",
    "accessKeyAssetId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "usageTimes": {
    "lastUsedByWorkload": "2026-02-05T00:00:42.691Z"
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  }
}

Update an S3 asset.

put

Use to update the details of an S3 compatible datasource asset by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Body

application/json

Responses

202

Request accepted successfully.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

default

unexpected error

application/json

put

/api/v1/asset/datasource/s3/{AssetId}

HTTPcURLJavaScriptPython

PUT /api/v1/asset/datasource/s3/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 179

{
  "meta": {
    "name": "my-asset"
  },
  "spec": {
    "bucket": "my-bucket",
    "path": "/container/my-bucket",
    "url": "https://s3.amazonaws.com",
    "accessKeyAssetId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "[email protected]",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "[email protected]",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "bucket": "my-bucket",
    "path": "/container/my-bucket",
    "url": "https://s3.amazonaws.com",
    "accessKeyAssetId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "usedBy": {
    "workspaces": [],
    "trainings": [],
    "distributed": [],
    "inferences": [],
    "templates": [],
    "assets": {
      "environments": [],
      "computes": [],
      "datasources": []
    }
  },
  "usageTimes": {
    "lastUsedByWorkload": "2026-02-05T00:00:42.691Z"
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": []
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "text",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "text",
    "url": "text"
  }
}

Delete an S3 asset.

delete

Use to delete an S3 compatible datasource asset by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Responses

202

Accepted.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

delete

/api/v1/asset/datasource/s3/{AssetId}

HTTPcURLJavaScriptPython

DELETE /api/v1/asset/datasource/s3/{AssetId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "code": 202,
  "message": "Request has been accepted."
}