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