NVIDIA Run:ai Template API
Templates are a pre-set configuration used to quickly configure and submit workloads using existing assets.
NVIDIA Run:ai Template API is one of 62 APIs that NVIDIA Run:ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Template. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 5 operations across 2 paths, and defines 93 schemas. It is described by OpenAPI 3.0.3, at version latest.
Requests are made against a single base URL, https://app.run.ai.
5 operations
2 paths
93 schemas
1 DELETE2 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
NVIDIA Run:ai Template API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
By default, every request must be authenticated.
bearerAuth— Bearer authentication
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Template 5
Templates are a pre-set configuration used to quickly configure and submit workloads using existing assets.
GET
/api/v1/asset/workload-templatedeprecated
List templates.
POST
/api/v1/asset/workload-templatedeprecated
Create a template.
GET
/api/v1/asset/workload-template/{AssetId}deprecated
Get a template.
PUT
/api/v1/asset/workload-template/{AssetId}deprecated
Update a template.
DELETE
/api/v1/asset/workload-template/{AssetId}deprecated
Delete a template.
Schemas 93
The contract defines 93 schemas that model the data the API accepts and returns. The most detailed are AssetReadOnlyFields (11 properties), EnvironmentVariableOfAsset (7 properties), Toleration (7 properties), AssetCreationFields (7 properties). Each schema is shown below with its type and property counts.
Category
string
Specify the workload category assigned to the workload. Categories are used to classify and monitor different types of workloads within the NVIDIA Run:ai platf…
DataSourceOverrides
object
specific fields to override in the data source.
1 property
NodeAffinityRequired
object
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements…
1 property
Labels
array
Set of labels to populate into the container running the workload.
InitializationTimeoutField
object
1 property
Error
object
3 properties
2 required
EnvironmentAssetRef
object
Reference information about environment asset.
3 properties
2 required
SpecificRunConnections
object
1 property
TerminationGracePeriod
integer
Duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the po…
AssetName
string
The name of the asset.
Toleration
object
Toleration details.
7 properties
AssetCreationRequest
WorkloadTemplate
object
2 properties
2 required
AssetsRefOptional
object
AssetMeta
InferencesMaxReplicasField
object
1 property
EnvironmentVariableCredential
object
Details of the secret and key use to populate the environment variable. (mutually exclusive with value)
2 properties
RunAsGid
integer
The group id to run the entrypoint of the container which executes the workspace. Default to the value specified in the environment asset runAsGid field (optio…
Annotations
array
Set of annotations to populate into the container running the workload.
AutoScalingMetric
string
The metric to use for autoscaling. Mandatory if minReplicas < maxReplicas, except for the special case where minReplicas is set to 0 and maxReplicas is set to…
SpecificRunParams
object
Parameters which apply to a specific workload. They complement the information gathered from the assets comprising the workload.
MatchExpressionOperator
string
Represents a key's relationship to a set of values (mandatory).
TolerationEffect
string
The taint effect to match. (mandatory)
AssetDescription
string
The description of the asset.
AllowOverQuota
object
1 property
SpecificRunInfoFields
object
Information about the set of assets which comprises a workspace, training or template, and an optional set of specific run parameters.
3 properties
1 required
AssetId
string
Unique identifier of the asset.
SpecificRunAutoScaling
object
1 property
AssetsIds
object
Set of assets comprising a workspace or a workspace template.
4 properties
1 required
Preemptibility
string
Specifies whether the workload can be preempted by higher-priority workloads. Valid values are preemptible and non-preemptible. If explicitly set, this value t…
SupplementalGroups
string
Comma separated list of groups that the user running the container belongs to, in addition to the group indicated by runAsGid. Use only when the source uid/gid…
NodeType1
string
Nodes (machines), or a group of nodes on which the workload will run. To use this feature, your Administrator will need to label nodes. For more information, s…
AssetReadOnlyFields
object
11 properties
6 required
UpdateCount
integer
the value of an update counter of a data in the system.
Completions
integer
Used with Hyperparameter Optimization. Specifies the number of successful pods the job should reach to be completed. The Job will be marked as successful once…
InitialReplicasField
object
1 property
AssetKind
string
The kind of the asset.
ImagePullSecrets
array
A list of references to Kubernetes secrets in the same namespace used for pulling container images.
Parallelism
integer
Used with Hyperparameter Optimization. Specifies the maximum number of pods the workload should run at any given time (applicable to standard training only).
Annotation
object
Annotation details to be populated into the container.
3 properties
AssetIdAndKind
object
Asset id and its kind.
3 properties
2 required
SpecificRunMetricFields
object
2 properties
EnvironmentVariableConfigMap
object
Details of the configMap and key use to populate the environment variable
2 properties
SpecificRunCreationFields
object
The information needed for creating az template - a set of assets and an optional set of specific environment parameters.
2 properties
1 required
AutoScalingCommonFields
object
DatasourceRef
object
Reference information about a datasource asset.
4 properties
3 required
NodePools
array
A prioritized list of node pools for the scheduler to run the workload on. The scheduler will always try to use the first node pool before moving to the next o…
InferencesMinReplicasField
object
1 property
MetricThresholdPercentageField
object
1 property
PodAffinity
object
Pod affinity scheduling rules (e.g. co-locate this workload in the same node, zone, etc. as some other workloads).
2 properties
ServingPortAccessAuthorizationTypeEnum
string
Specifies who can send inference requests to the serving endpoint: Possible values: - public: No authorization is required. (Default) - authenticatedUsers: Any…
EnvironmentVariablePodFieldReference
object
Details of the field-reference and key use to populate the environment variable
1 property
EnvironmentVariableOfAsset
object
Details of an environment variable which is populated into the container.
7 properties
MatchExpression
object
A selector that contains values, a key, and an operator that relates the key and values.
3 properties
2 required
PodAffinityType
string
The affinity type, required or preferred. (mandatory)
Scope
string
The scope in which an asset can be used. The highest scope, system, is intended for internal purposes only.
Command
string
A command to the server as the entry point of the container running the workload.
InfoDistMaster
object
Parameters which apply to the master in a distributed training.
2 properties
SpecificRunServingPortAccess
object
1 property
DistributedFramework
string
The distributed training framework used in the workload.
ActivationReplicasField
object
1 property
EnvironmentVariablesOfAsset
array
Set of environment variables to populate into the container running the workspace.
Args
string
Arguments to the command that the container running the workload executes.
PriorityClass
string
Specifies the priority class for the workload, which determines its scheduling behavior. Valid values are: very-low, low, medium-low, medium, medium-high, high…
NodeSelectorTerm
object
A null or empty node selector term matches no objects. The requirements of them are ANDed.
1 property
WorkloadTemplateListResponse
object
1 property
1 required
AssetRef
object
Reference information about an asset.
2 properties
2 required
Label
object
Label details to be populated into the container.
3 properties
AssetUpdateRequest
RestartPolicy
string
Specify the restart policy of the workload pods. Default is empty, which is determine by the framework default
Tolerations
array
Set of tolerations to apply to the workload.
SpecificRunConnectionInfo
object
5 properties
1 required
InfoDistributed
object
Parameters which apply to distributed training.
AutoDeletionTimeAfterPreemption
integer
Specifies the duration after which a finished workload (completed or failed) will be automatically deleted. The default is 30 days. Log retention is managed se…
HttpResponse
object
2 properties
2 required
TerminateAfterPreemption
boolean
Indicates if the job should be terminated by the system after it has been preempted.
WorkloadSupportedTypes
object
5 properties
ConcurrencyHardLimitField
object
1 property
AssetUpdatableFields
object
2 properties
1 required
ToolType
string
Super set of Internal and External tool types.
WorkloadTemplateUpdateRequest
object
2 properties
2 required
AssetCreationFields
object
7 properties
1 required
ScaleDownDelayField
object
1 property
AssetsRef
object
Reference information about a set of assets. used to describe - assets comprising a workspace - assets comprising a workspace template - assets that use other…
4 properties
1 required
AssetsRefCompute
object
ScaleToZeroRetentionField
object
1 property
ServingPortAccess
object
4 properties
BackoffLimit
integer
Specifies the number of retries before marking a workload as failed (not applicable to Inference workloads). The default value is 6.
ImagePullSecret
object
A reference to a secret in the same namespace used to pull container images.
3 properties
ClusterIdOptional
string
The id of the cluster.
TolerationOperator
string
A key's relationship to the value. Equal uses key and value. Exists is equivalent to wildcard for value, so that a workload can tolerate all taints of a partic…
WorkloadTemplateCreationRequest
object
2 properties
2 required
RunAsUid
integer
The user id to run the entrypoint of the container which executes the workspace. Default to the value specified in the environment asset runAsUid field (option…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from NVIDIA Run:ai 12
Other APIs NVIDIA Run:ai publishes across the network.
NVIDIA Run:ai Access Keys API
NVIDIA Run:ai Access rules API
NVIDIA Run:ai Administrator Command Line Interface API
NVIDIA Run:ai AI Applications API
NVIDIA Run:ai Applications API
NVIDIA Run:ai AuditLogs API
NVIDIA Run:ai Clusters API
NVIDIA Run:ai Compute API
NVIDIA Run:ai ConfigMap API
NVIDIA Run:ai Credentials API
NVIDIA Run:ai Datasources API
NVIDIA Run:ai Datavolumes API
#Template