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 Templates. 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.2.0, at version latest.
Requests are made against a single base URL, https://app.run.ai.
The identity and technical contract details declared by the specification.
PriorityClass
stringnull
Specifies the priority class for the workload, which determines its scheduling behavior. Valid values are: very-low, low, medium-low, medium, medium-high, high…
ScaleDownDelayField
object
1 property
WorkloadTemplateListResponse
object
1 property
1 required
AssetUpdatableFields
object
2 properties
1 required
Tolerations
arraynull
Set of tolerations to apply to the workload.
AssetCreationFields
object
7 properties
1 required
ImagePullSecrets
arraynull
A list of references to Kubernetes secrets in the same namespace used for pulling container images.
Category
stringnull
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…
WorkloadTemplate
object
2 properties
2 required
HttpResponse
object
2 properties
2 required
SpecificRunServingPortAccess
objectnull
1 property
ActivationReplicasField
object
1 property
WorkloadTemplateCreationRequest
object
2 properties
2 required
AllowOverQuota
object
1 property
EnvironmentVariablePodFieldReference
objectnull
Details of the field-reference and key use to populate the environment variable
1 property
InitializationTimeoutField
object
1 property
Command
stringnull
A command to the server as the entry point of the container running the workload.
ImagePullSecret
objectnull
A reference to a secret in the same namespace used to pull container images.
3 properties
WorkloadSupportedTypes
objectnull
5 properties
TolerationOperator
stringnull
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…
EnvironmentVariableConfigMap
objectnull
Details of the configMap and key use to populate the environment variable
2 properties
NodePools
arraynull
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…
EnvironmentVariableOfAsset
objectnull
Details of an environment variable which is populated into the container.
7 properties
AssetsIds
object
Set of assets comprising a workspace or a workspace template.
4 properties
1 required
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
PodAffinity
objectnull
Pod affinity scheduling rules (e.g. co-locate this workload in the same node, zone, etc. as some other workloads).
2 properties
InfoDistributed
objectnull
Parameters which apply to distributed training.
AssetsRefOptional
objectnull
AssetDescription
stringnull
The description of the asset.
SpecificRunParams
objectnull
Parameters which apply to a specific workload. They complement the information gathered from the assets comprising the workload.
EnvironmentAssetRef
object
Reference information about environment asset.
3 properties
2 required
AssetId
string
Unique identifier of the asset.
AssetName
string
The name of the asset.
MetricThresholdPercentageField
object
1 property
AssetsRefCompute
objectnull
NodeSelectorTerm
objectnull
A null or empty node selector term matches no objects. The requirements of them are ANDed.
1 property
SupplementalGroups
stringnull
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…
SpecificRunMetricFields
objectnull
2 properties
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
TerminationGracePeriod
integernull
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…
EnvironmentVariableCredential
objectnull
Details of the secret and key use to populate the environment variable. (mutually exclusive with value)
2 properties
RestartPolicy
stringnull
Specify the restart policy of the workload pods. Default is empty, which is determine by the framework default
Scope
string
The scope in which an asset can be used. The highest scope, system, is intended for internal purposes only.
TerminateAfterPreemption
booleannull
Indicates if the job should be terminated by the system after it has been preempted.
InferencesMaxReplicasField
object
1 property
Error
object
3 properties
2 required
AssetReadOnlyFields
object
11 properties
6 required
Labels
arraynull
Set of labels to populate into the container running the workload.
Label
objectnull
Label details to be populated into the container.
3 properties
Annotations
arraynull
Set of annotations to populate into the container running the workload.
AutoScalingMetric
stringnull
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…
Args
stringnull
Arguments to the command that the container running the workload executes.
RunAsGid
integernull
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…
DatasourceRef
object
Reference information about a datasource asset.
4 properties
3 required
EnvironmentVariablesOfAsset
arraynull
Set of environment variables to populate into the container running the workspace.
AssetIdAndKind
object
Asset id and its kind.
3 properties
2 required
PodAffinityType
stringnull
The affinity type, required or preferred. (mandatory)
InitialReplicasField
object
1 property
DistributedFramework
stringnull
The distributed training framework used in the workload.
MatchExpression
objectnull
A selector that contains values, a key, and an operator that relates the key and values.
3 properties
2 required
Annotation
objectnull
Annotation details to be populated into the container.
3 properties
InferencesMinReplicasField
object
1 property
InfoDistMaster
objectnull
Parameters which apply to the master in a distributed training.
2 properties
Toleration
objectnull
Toleration details.
7 properties
ServingPortAccess
object
4 properties
DataSourceOverrides
objectnull
specific fields to override in the data source.
1 property
Preemptibility
stringnull
Specifies whether the workload can be preempted by higher-priority workloads. Valid values are preemptible and non-preemptible. If explicitly set, this value t…
AssetRef
object
Reference information about an asset.
2 properties
2 required
ScaleToZeroRetentionField
object
1 property
ToolType
string
Super set of Internal and External tool types.
ServingPortAccessAuthorizationTypeEnum
stringnull
Specifies who can send inference requests to the serving endpoint: Possible values: - public: No authorization is required. (Default) - authenticatedUsers: Any…
Parallelism
integernull
Used with Hyperparameter Optimization. Specifies the maximum number of pods the workload should run at any given time (applicable to standard training only).
NodeAffinityRequired
objectnull
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
RunAsUid
integernull
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…
ConcurrencyHardLimitField
object
1 property
SpecificRunConnections
objectnull
1 property
NodeType1
stringnull
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…
AutoScalingCommonFields
objectnull
UpdateCount
integer
the value of an update counter of a data in the system.
AssetKind
string
The kind of the asset.
Completions
integernull
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…
SpecificRunConnectionInfo
object
5 properties
1 required
TolerationEffect
stringnull
The taint effect to match. (mandatory)
WorkloadTemplateUpdateRequest
object
2 properties
2 required
AutoDeletionTimeAfterPreemption
integernull
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…
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
BackoffLimit
integernull
Specifies the number of retries before marking a workload as failed (not applicable to Inference workloads). The default value is 6.
MatchExpressionOperator
string
Represents a key's relationship to a set of values (mandatory).
SpecificRunAutoScaling
objectnull
1 property
ClusterIdOptional
stringnull
The id of the cluster.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs NVIDIA Run:ai publishes across the network.
