Run:ai

Workload Templates

Submit workloads using templates.

List templates.

Retrieve a list of templates with details.

SecuritybearerAuth
Request
query Parameters
offset
integer <int32>

The offset of the first item returned in the collection.

Example: offset=100
limit
integer <int32> [ 1 .. 500 ]
Default: 50

The maximum number of entries to return.

sortOrder
string
Default: "asc"

Sort results in descending or ascending order.

Enum: "asc" "desc"
sortBy
string

Sort results by parameter.

Enum: "name" "workloadType" "runnable" "scopeType" "clusterId" "projectId" "departmentId" "createdAt" "updatedAt" "createdBy" "updatedBy"
filterBy
Array of strings

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contain, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

Example: filterBy=name!=some-template-name,createdAt>=2021-01-01T00:00:00Z
search
string

Filter results by a free text search.

Example: search=test project
Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

get/api/v1/workloads/templates
Response samples
application/json
{
  • "entries": [
    ],
  • "pagination": {
    }
}

Count templates.

Retrieve the number of templates.

SecuritybearerAuth
Request
query Parameters
filterBy
Array of strings

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contain, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

Example: filterBy=name!=some-template-name,createdAt>=2021-01-01T00:00:00Z
search
string

Filter results by a free text search.

Example: search=test project
Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

get/api/v1/workloads/templates/count
Response samples
application/json
{
  • "count": 1
}

Create a workspace template.

Create a new workspace template.

SecuritybearerAuth
Request
Request Body schema: application/json
required
object (TemplateCreationMetaFields)
object or null (WorkspaceSpecSpec)

Container overrideable fields. In the context of assets,these are environment asset fields that can be overriden in the submit workload request.

Responses
202

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

post/api/v1/workloads/templates/workspaces
Request samples
application/json
{
  • "meta": {
    },
  • "spec": {
    }
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "runnable": {
    },
  • "combinedSpec": {
    }
}

List workspace templates.

Retrieve a list of workspace templates with details.

SecuritybearerAuth
Request
query Parameters
offset
integer <int32>

The offset of the first item returned in the collection.

Example: offset=100
limit
integer <int32> [ 1 .. 500 ]
Default: 50

The maximum number of entries to return.

sortOrder
string
Default: "asc"

Sort results in descending or ascending order.

Enum: "asc" "desc"
sortBy
string

Sort results by parameter.

Enum: "name" "workloadType" "runnable" "scopeType" "clusterId" "projectId" "departmentId" "createdAt" "updatedAt" "createdBy" "updatedBy"
filterBy
Array of strings

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contain, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

Example: filterBy=name!=some-template-name,createdAt>=2021-01-01T00:00:00Z
search
string

Filter results by a free text search.

Example: search=test project
Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

get/api/v1/workloads/templates/workspaces
Response samples
application/json
{
  • "entries": [
    ],
  • "pagination": {
    }
}

Get a workspace template.

Retrieve the details of a workspace template using its id.

SecuritybearerAuth
Request
path Parameters
templateId
required
string <uuid>

The Universally Unique Identifier (UUID) of the template.

Example: 550e8400-e29b-41d4-a716-446655440000
Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/workloads/templates/workspaces/{templateId}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "runnable": {
    },
  • "combinedSpec": {
    }
}

Delete a workspace template.

Delete a workspace using its id.

SecuritybearerAuth
Request
path Parameters
templateId
required
string <uuid>

The Universally Unique Identifier (UUID) of the template.

Example: 550e8400-e29b-41d4-a716-446655440000
Responses
204

No Content.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

delete/api/v1/workloads/templates/workspaces/{templateId}
Response samples
application/json
{
  • "code": 401,
  • "message": "Issuer is not familiar."
}

Patch a workspace template.

Patch a workspace template using its id.

SecuritybearerAuth
Request
path Parameters
templateId
required
string <uuid>

The Universally Unique Identifier (UUID) of the template.

Example: 550e8400-e29b-41d4-a716-446655440000
Request Body schema: application/json
object or null (TemplatePatchMetaFields)
object or null (WorkspaceSpecSpec)

Container overrideable fields. In the context of assets,these are environment asset fields that can be overriden in the submit workload request.

fieldsToClear
Array of strings
Responses
200

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

patch/api/v1/workloads/templates/workspaces/{templateId}
Request samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "fieldsToClear": [
    ]
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "runnable": {
    },
  • "combinedSpec": {
    }
}

Update a workspace template.

update a workspace template using its id.

SecuritybearerAuth
Request
path Parameters
templateId
required
string <uuid>

The Universally Unique Identifier (UUID) of the template.

Example: 550e8400-e29b-41d4-a716-446655440000
Request Body schema: application/json
required
object (TemplateUpdateMetaFields)
object or null (WorkspaceSpecSpec)

Container overrideable fields. In the context of assets,these are environment asset fields that can be overriden in the submit workload request.

Responses
200

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

put/api/v1/workloads/templates/workspaces/{templateId}
Request samples
application/json
{
  • "meta": {
    },
  • "spec": {
    }
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "runnable": {
    },
  • "combinedSpec": {
    }
}

Create a training template.

Create a new training template.

SecuritybearerAuth
Request
Request Body schema: application/json
required
object (TemplateCreationMetaFields)
object or null (TrainingSpecSpec)

Container overrideable fields. In the context of assets,these are environment asset fields that can be overriden in the submit workload request.

Responses
202

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

post/api/v1/workloads/templates/trainings
Request samples
application/json
{
  • "meta": {
    },
  • "spec": {
    }
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "runnable": {
    },
  • "combinedSpec": {
    }
}

List training templates.

Retrieve a list of training templates with details.

SecuritybearerAuth
Request
query Parameters
offset
integer <int32>

The offset of the first item returned in the collection.

Example: offset=100
limit
integer <int32> [ 1 .. 500 ]
Default: 50

The maximum number of entries to return.

sortOrder
string
Default: "asc"

Sort results in descending or ascending order.

Enum: "asc" "desc"
sortBy
string

Sort results by parameter.

Enum: "name" "workloadType" "runnable" "scopeType" "clusterId" "projectId" "departmentId" "createdAt" "updatedAt" "createdBy" "updatedBy"
filterBy
Array of strings

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contain, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

Example: filterBy=name!=some-template-name,createdAt>=2021-01-01T00:00:00Z
search
string

Filter results by a free text search.

Example: search=test project
Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

get/api/v1/workloads/templates/trainings
Response samples
application/json
{
  • "entries": [
    ],
  • "pagination": {
    }
}

Get a training template.

Retrieve the details of a training template using its id.

SecuritybearerAuth
Request
path Parameters
templateId
required
string <uuid>

The Universally Unique Identifier (UUID) of the template.

Example: 550e8400-e29b-41d4-a716-446655440000
Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/workloads/templates/trainings/{templateId}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "runnable": {
    },
  • "combinedSpec": {
    }
}

Delete a training template.

Delete a training using its id.

SecuritybearerAuth
Request
path Parameters
templateId
required
string <uuid>

The Universally Unique Identifier (UUID) of the template.

Example: 550e8400-e29b-41d4-a716-446655440000
Responses
204

No Content.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

delete/api/v1/workloads/templates/trainings/{templateId}
Response samples
application/json
{
  • "code": 401,
  • "message": "Issuer is not familiar."
}

Patch a training template.

Patch a training template using its id.

SecuritybearerAuth
Request
path Parameters
templateId
required
string <uuid>

The Universally Unique Identifier (UUID) of the template.

Example: 550e8400-e29b-41d4-a716-446655440000
Request Body schema: application/json
object or null (TemplatePatchMetaFields)
object or null (TrainingSpecSpec)

Container overrideable fields. In the context of assets,these are environment asset fields that can be overriden in the submit workload request.

fieldsToClear
Array of strings
Responses
200

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

patch/api/v1/workloads/templates/trainings/{templateId}
Request samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "fieldsToClear": [
    ]
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "runnable": {
    },
  • "combinedSpec": {
    }
}

Update a training template.

update a training template using its id.

SecuritybearerAuth
Request
path Parameters
templateId
required
string <uuid>

The Universally Unique Identifier (UUID) of the template.

Example: 550e8400-e29b-41d4-a716-446655440000
Request Body schema: application/json
required
object (TemplateUpdateMetaFields)
object or null (TrainingSpecSpec)

Container overrideable fields. In the context of assets,these are environment asset fields that can be overriden in the submit workload request.

Responses
200

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

put/api/v1/workloads/templates/trainings/{templateId}
Request samples
application/json
{
  • "meta": {
    },
  • "spec": {
    }
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "runnable": {
    },
  • "combinedSpec": {
    }
}

Create a distributed template.

Create a new distributed template.

SecuritybearerAuth
Request
Request Body schema: application/json
required
object (TemplateCreationMetaFields)
object or null (DistributedSpecSpec)

The spec of the worker(s).

masterSpecSameAsWorker
boolean or null (MasterSpecSameAsWorker)

used for distributed workloads to indicate that the master spec should be the same as the worker spec. in this case, masterSpec should not be specified.

object or null (TemplateMasterSection)
Responses
202

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

post/api/v1/workloads/templates/distributed
Request samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "masterSpecSameAsWorker": true,
  • "master": {
    }
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "masterSpecSameAsWorker": true,
  • "master": {
    },
  • "runnable": {
    },
  • "combinedSpec": {
    },
  • "combinedMasterSpec": {
    }
}

List distributed templates.

Retrieve a list of distributed templates with details.

SecuritybearerAuth
Request
query Parameters
offset
integer <int32>

The offset of the first item returned in the collection.

Example: offset=100
limit
integer <int32> [ 1 .. 500 ]
Default: 50

The maximum number of entries to return.

sortOrder
string
Default: "asc"

Sort results in descending or ascending order.

Enum: "asc" "desc"
sortBy
string

Sort results by parameter.

Enum: "name" "workloadType" "runnable" "scopeType" "clusterId" "projectId" "departmentId" "createdAt" "updatedAt" "createdBy" "updatedBy"
filterBy
Array of strings

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contain, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

Example: filterBy=name!=some-template-name,createdAt>=2021-01-01T00:00:00Z
search
string

Filter results by a free text search.

Example: search=test project
Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

get/api/v1/workloads/templates/distributed
Response samples
application/json
{
  • "entries": [
    ],
  • "pagination": {
    }
}

Get a distributed template.

Retrieve the details of a distributed template using its id.

SecuritybearerAuth
Request
path Parameters
templateId
required
string <uuid>

The Universally Unique Identifier (UUID) of the template.

Example: 550e8400-e29b-41d4-a716-446655440000
Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/workloads/templates/distributed/{templateId}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "masterSpecSameAsWorker": true,
  • "master": {
    },
  • "runnable": {
    },
  • "combinedSpec": {
    },
  • "combinedMasterSpec": {
    }
}

Delete a distributed template.

Delete a distributed using its id.

SecuritybearerAuth
Request
path Parameters
templateId
required
string <uuid>

The Universally Unique Identifier (UUID) of the template.

Example: 550e8400-e29b-41d4-a716-446655440000
Responses
204

No Content.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

delete/api/v1/workloads/templates/distributed/{templateId}
Response samples
application/json
{
  • "code": 401,
  • "message": "Issuer is not familiar."
}

Patch a distributed template.

Patch a distributed template using its id.

SecuritybearerAuth
Request
path Parameters
templateId
required
string <uuid>

The Universally Unique Identifier (UUID) of the template.

Example: 550e8400-e29b-41d4-a716-446655440000
Request Body schema: application/json
object or null (TemplatePatchMetaFields)
object or null (DistributedSpecSpec)

The spec of the worker(s).

masterSpecSameAsWorker
boolean or null (MasterSpecSameAsWorker)

used for distributed workloads to indicate that the master spec should be the same as the worker spec. in this case, masterSpec should not be specified.

object or null (TemplateMasterSection)
fieldsToClear
Array of strings
Responses
200

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

patch/api/v1/workloads/templates/distributed/{templateId}
Request samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "masterSpecSameAsWorker": true,
  • "master": {
    },
  • "fieldsToClear": [
    ]
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "masterSpecSameAsWorker": true,
  • "master": {
    },
  • "runnable": {
    },
  • "combinedSpec": {
    },
  • "combinedMasterSpec": {
    }
}

Update a distributed template.

Update a distributed template using its id.

SecuritybearerAuth
Request
path Parameters
templateId
required
string <uuid>

The Universally Unique Identifier (UUID) of the template.

Example: 550e8400-e29b-41d4-a716-446655440000
Request Body schema: application/json
required
object (TemplateUpdateMetaFields)
object or null (DistributedSpecSpec)

The spec of the worker(s).

masterSpecSameAsWorker
boolean or null (MasterSpecSameAsWorker)

used for distributed workloads to indicate that the master spec should be the same as the worker spec. in this case, masterSpec should not be specified.

object or null (TemplateMasterSection)
Responses
200

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

put/api/v1/workloads/templates/distributed/{templateId}
Request samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "masterSpecSameAsWorker": true,
  • "master": {
    }
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "masterSpecSameAsWorker": true,
  • "master": {
    },
  • "runnable": {
    },
  • "combinedSpec": {
    },
  • "combinedMasterSpec": {
    }
}

Create a inference template.

Create a new inference template.

SecuritybearerAuth
Request
Request Body schema: application/json
required
object (TemplateCreationMetaFields)
object or null (InferenceSpecSpec)

Container overrideable fields. In the context of assets,these are environment asset fields that can be overriden in the submit workload request.

Responses
202

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

post/api/v1/workloads/templates/inferences
Request samples
application/json
{
  • "meta": {
    },
  • "spec": {
    }
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "runnable": {
    },
  • "combinedSpec": {
    }
}

List inference templates.

Retrieve a list of inference templates with details.

SecuritybearerAuth
Request
query Parameters
offset
integer <int32>

The offset of the first item returned in the collection.

Example: offset=100
limit
integer <int32> [ 1 .. 500 ]
Default: 50

The maximum number of entries to return.

sortOrder
string
Default: "asc"

Sort results in descending or ascending order.

Enum: "asc" "desc"
sortBy
string

Sort results by parameter.

Enum: "name" "workloadType" "runnable" "scopeType" "clusterId" "projectId" "departmentId" "createdAt" "updatedAt" "createdBy" "updatedBy"
filterBy
Array of strings

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contain, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

Example: filterBy=name!=some-template-name,createdAt>=2021-01-01T00:00:00Z
search
string

Filter results by a free text search.

Example: search=test project
Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

get/api/v1/workloads/templates/inferences
Response samples
application/json
{
  • "entries": [
    ],
  • "pagination": {
    }
}

Get a inference template.

Retrieve the details of a inference template using its id.

SecuritybearerAuth
Request
path Parameters
templateId
required
string <uuid>

The Universally Unique Identifier (UUID) of the template.

Example: 550e8400-e29b-41d4-a716-446655440000
Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/workloads/templates/inferences/{templateId}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "runnable": {
    },
  • "combinedSpec": {
    }
}

Delete a inference template.

Delete a inference using its id.

SecuritybearerAuth
Request
path Parameters
templateId
required
string <uuid>

The Universally Unique Identifier (UUID) of the template.

Example: 550e8400-e29b-41d4-a716-446655440000
Responses
204

No Content.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

delete/api/v1/workloads/templates/inferences/{templateId}
Response samples
application/json
{
  • "code": 401,
  • "message": "Issuer is not familiar."
}

Update a inference template.

Update a inference template using its id.

SecuritybearerAuth
Request
path Parameters
templateId
required
string <uuid>

The Universally Unique Identifier (UUID) of the template.

Example: 550e8400-e29b-41d4-a716-446655440000
Request Body schema: application/json
required
object (TemplateUpdateMetaFields)
object or null (InferenceSpecSpec)

Container overrideable fields. In the context of assets,these are environment asset fields that can be overriden in the submit workload request.

Responses
200

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

put/api/v1/workloads/templates/inferences/{templateId}
Request samples
application/json
{
  • "meta": {
    },
  • "spec": {
    }
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "runnable": {
    },
  • "combinedSpec": {
    }
}

Patch a inference template.

Patch a inference template using its id.

SecuritybearerAuth
Request
path Parameters
templateId
required
string <uuid>

The Universally Unique Identifier (UUID) of the template.

Example: 550e8400-e29b-41d4-a716-446655440000
Request Body schema: application/json
object or null (TemplatePatchMetaFields)
object or null (InferenceSpecSpec)

Container overrideable fields. In the context of assets,these are environment asset fields that can be overriden in the submit workload request.

fieldsToClear
Array of strings
Responses
200

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

patch/api/v1/workloads/templates/inferences/{templateId}
Request samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "fieldsToClear": [
    ]
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "runnable": {
    },
  • "combinedSpec": {
    }
}
➔ Next to Policy