NVIDIA Run:ai Environment API
An environment resource designates the container image, the image pull policy, working directory, security parameters, and others. It exposes all the necessary tools (open source, 3rd party, or custom tools) along with their connection interfaces including external node port and the container ports.You can also specify a standard, distributed, or inference workload architecture for the environment.An environment is a mandatory building block for the creation of a workload.For more information, see [Environments](https://run-ai-docs.nvidia.com/saas/workloads-in-nvidia-run-ai/assets/environments).
NVIDIA Run:ai Environment 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 Environment. 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 83 schemas.
It is described by OpenAPI 3.0.3, 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.
InternalConnectionType
string
The type of connection that exposes the container port.
EnvironmentCreationRequest
object
2 properties
2 required
Probe
object
6 properties
ExternalToolType
string
The type of external tool that is associated with the connection. External tool typically runs in the cloud and require external url for connecting to it.
DataSourceOverrides
object
specific fields to override in the data source.
1 property
AssetsUsageRefCompute
object
UidGidSource
string
Indicate the way to determine the user and group ids of the container. The options are a. fromTheImage - user and group ids are determined by the docker image…
Error
object
3 properties
2 required
InternalToolInfo
object
Information of the internal tool.
6 properties
3 required
EnvironmentAssetRef
object
Reference information about environment asset.
3 properties
2 required
ServingPortInfo
object
1 property
UsageTimesInfo
object
Details about times the asset has been used by workloads, etc.
1 property
AssetsUsageRef
object
Reference information about usage of assets by other assets, for example datasources that uses credentials.
5 properties
AssetName
string
The name of the asset.
Stdin
boolean
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in…
Capabilities
array
Add POSIX capabilities to running containers. Defaults to the default set of capabilities granted by the container runtime.
ComplianceInfoReason
object
An issue preventing the use of a template or asset for creating workloads in a given project.
3 properties
1 required
HostNetwork
boolean
Whether to enable host networking. Default to false.
AssetClusterStatusIssues
array
EnvironmentVariableCredential
object
Details of the secret and key use to populate the environment variable. (mutually exclusive with value)
2 properties
EnvironmentAsset
object
6 properties
2 required
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…
AssetClusterStatusIssue
object
3 properties
3 required
ProbeHandler
object
The action taken to determine the health of the container. (mandatory)
1 property
AssetDescription
string
The description of the asset.
AssetClusterStatusInfo
object
4 properties
ImagePullPolicy
string
Image pull policy. Defaults to Always if :latest tag is specified, otherwise it is IfNotPresent.
AllowPrivilegeEscalation
boolean
Allow the container running the workload and all launched processes to gain additional privileges after the workload starts. For more information consult the U…
WorkloadName
string
The name of the workload.
Connection
object
4 properties
1 required
AssetId
string
Unique identifier of the asset.
InternalToolType
string
The type of the internal tool. Internal tool runs within the container and exposes ports associated with the tool using NodePort, LoadBalancer or ExternalUrl.
EnvironmentListResponse
object
1 property
1 required
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…
PolicyRuleEnum
string
Indicates which validation rule (e.g., min, max, step, options, required, canEdit, canAdd) conflicted with policy restrictions, causing the asset or template t…
AssetReadOnlyFields
object
11 properties
6 required
UpdateCount
integer
the value of an update counter of a data in the system.
AssetKind
string
The kind of the asset.
AssetSyncStatusEnum
string
AssetDatasourceRef
object
Reference information about a datasource asset.
4 properties
3 required
Image
string
Docker image name. For more information, see [Images](https://kubernetes.io/docs/concepts/containers/images). The image name is mandatory for creating a worklo…
CreateHomeDir
boolean
When set to true, creates a home directory for the container.
EnvironmentVariableConfigMap
object
Details of the configMap and key use to populate the environment variable
2 properties
AssetClusterStatusIssueEnum
string
AssetUsageInfo
object
Details about resources that use the asset.
6 properties
ComplianceInfo
object
Compliance of an asset with creation of workloads in a given project.
3 properties
WorkloadRefAndStatus
object
Id, name and status of a workspace or training
3 properties
2 required
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
ReadOnlyRootFileSystem
boolean
If true, mounts the container's root filesystem as read-only.
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.
NodePortInfo
object
1 property
ProbeHandlerScheme
string
Scheme to use for connecting to the host, defaults to HTTP.
RunAsNonRoot
boolean
Force the container to run as a non-root user.
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.
WorkingDir
string
Container's working directory. If not specified, the container runtime default will be used. This may be configured in the container image.
AssetRef
object
Reference information about an asset.
2 properties
2 required
OverridableSpecFields
object
6 properties
ExternalToolInfo
object
Information of the external tool.
2 properties
2 required
SeccompProfileType
string
Indicates which kind of seccomp profile will be applied to the container. The options are a. RuntimeDefault - the container runtime default profile should be u…
HttpResponse
object
2 properties
2 required
ExternalUrlInfo
object
2 properties
WorkloadId1
string
A unique ID of the workload.
WorkloadSupportedTypes
object
5 properties
AssetUpdatableFields
object
2 properties
1 required
EnvironmentUpdateRequest
object
2 properties
2 required
ToolType
string
Super set of Internal and External tool types.
AssetCreationFields
object
7 properties
1 required
Probes
object
Probes are used to determine if the container is healthy and ready to accept traffic.
1 property
ScopeId
string
The id of the cluster, department or project, depending on the scope type.
ClusterIdOptional
string
The id of the cluster.
HostIpc
boolean
Whether to enable host IPC. Defaults to false.
Tty
boolean
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
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…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs NVIDIA Run:ai publishes across the network.
