How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
NVIDIA Run:ai

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).

Documentation Provider Profile APIs.io OpenAPI GitHub

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.2.0, at version latest.

Requests are made against a single base URL, https://app.run.ai.

5 operations 2 paths 83 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
latest
Base URL
https://app.run.ai
Authentication
HTTP Bearer
License
NVIDIA Run:ai
Resource Areas
1

Authentication & Security 1

NVIDIA Run:ai Environment 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.

Environment 5

An environment resource designates the container image, the image pull policy, working directory, security parameters, and others.

GET
/api/v1/asset/environment
List environment assets
list_environment_assets 16 params → 200401403503
POST
/api/v1/asset/environment
Create an environment asset
create_environment_asset body → 202400401403409503
GET
/api/v1/asset/environment/{AssetId}
Get an environment asset
get_environment_asset_by_id 6 params → 200401403404503
PUT
/api/v1/asset/environment/{AssetId}
Update an environment asset
update_environment_asset_by_id 1 param body → 202401403404default
DELETE
/api/v1/asset/environment/{AssetId}
Delete an environment asset
delete_environment_asset_by_id 1 param → 202401403404503

Schemas 83

The contract defines 83 schemas that model the data the API accepts and returns. The most detailed are AssetReadOnlyFields (11 properties), AssetCreationFields (7 properties), EnvironmentVariableOfAsset (7 properties), OverridableSpecFields (6 properties). Each schema is shown below with its type and property counts.

AssetSyncStatusEnum
string
EnvironmentUpdateRequest
object
2 properties 2 required
EnvironmentCreationRequest
object
2 properties 2 required
AssetUpdatableFields
object
2 properties 1 required
AssetMeta
AssetCreationFields
object
7 properties 1 required
EnvironmentAssetSpec
InternalToolInfo
objectnull
Information of the internal tool.
6 properties 3 required
AssetUsageInfo
objectnull
Details about resources that use the asset.
6 properties
HostNetwork
booleannull
Whether to enable host networking. Default to false.
Image
stringnull
Docker image name. For more information, see [Images](https://kubernetes.io/docs/concepts/containers/images). The image name is mandatory for creating a worklo…
WorkingDir
stringnull
Container's working directory. If not specified, the container runtime default will be used. This may be configured in the container image.
HttpResponse
object
2 properties 2 required
ProbeHandler
objectnull
The action taken to determine the health of the container. (mandatory)
1 property
EnvironmentVariablePodFieldReference
objectnull
Details of the field-reference and key use to populate the environment variable
1 property
Probe
objectnull
6 properties
ServingPortInfo
objectnull
1 property
Command
stringnull
A command to the server as the entry point of the container running the workload.
WorkloadSupportedTypes
objectnull
5 properties
EnvironmentAsset
object
6 properties 2 required
EnvironmentVariableConfigMap
objectnull
Details of the configMap and key use to populate the environment variable
2 properties
OverridableSpecFields
objectnull
6 properties
EnvironmentVariableOfAsset
objectnull
Details of an environment variable which is populated into the container.
7 properties
AssetDescription
stringnull
The description of the asset.
EnvironmentListResponse
object
1 property 1 required
EnvironmentAssetRef
object
Reference information about environment asset.
3 properties 2 required
AssetId
string
Unique identifier of the asset.
AssetClusterStatusInfo
objectnull
4 properties
AssetName
string
The name of the asset.
AllowPrivilegeEscalation
booleannull
Allow the container running the workload and all launched processes to gain additional privileges after the workload starts. For more information consult the U…
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.
AssetUpdateRequest
InternalConnectionType
string
The type of connection that exposes the container port.
AssetClusterStatusIssue
object
3 properties 3 required
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…
CreateHomeDir
booleannull
When set to true, creates a home directory for the container.
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.
ExternalUrlInfo
objectnull
2 properties
ScopeId
string
The id of the cluster, department or project, depending on the scope type.
EnvironmentVariableCredential
objectnull
Details of the secret and key use to populate the environment variable. (mutually exclusive with value)
2 properties
ProbeHandlerScheme
stringnull
Scheme to use for connecting to the host, defaults to HTTP.
Scope
string
The scope in which an asset can be used. The highest scope, system, is intended for internal purposes only.
Error
object
3 properties 2 required
RunAsNonRoot
booleannull
Force the container to run as a non-root user.
Probes
objectnull
Probes are used to determine if the container is healthy and ready to accept traffic.
1 property
AssetReadOnlyFields
object
11 properties 6 required
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…
AssetDatasourceRef
object
Reference information about a datasource asset.
4 properties 3 required
Tty
booleannull
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
EnvironmentVariablesOfAsset
arraynull
Set of environment variables to populate into the container running the workspace.
PolicyRuleEnum
stringnull
Indicates which validation rule (e.g., min, max, step, options, required, canEdit, canAdd) conflicted with policy restrictions, causing the asset or template t…
Capability
string
ReadOnlyRootFileSystem
booleannull
If true, mounts the container's root filesystem as read-only.
NonOverridableSpecFields
Stdin
booleannull
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…
UidGidSource
stringnull
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…
NodePortInfo
objectnull
1 property
ImagePullPolicy
stringnull
Image pull policy. Defaults to Always if :latest tag is specified, otherwise it is IfNotPresent.
AssetsUsageRef
object
Reference information about usage of assets by other assets, for example datasources that uses credentials.
5 properties
WorkloadId1
string
A unique ID of the workload.
DataSourceOverrides
objectnull
specific fields to override in the data source.
1 property
Capabilities
arraynull
Add POSIX capabilities to running containers. Defaults to the default set of capabilities granted by the container runtime.
AssetRef
object
Reference information about an asset.
2 properties 2 required
ToolType
string
Super set of Internal and External tool types.
WorkloadRefAndStatus
object
Id, name and status of a workspace or training
3 properties 2 required
ComplianceInfoReason
object
An issue preventing the use of a template or asset for creating workloads in a given project.
3 properties 1 required
AssetCreationRequest
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…
UpdateCount
integer
the value of an update counter of a data in the system.
AssetClusterStatusIssueEnum
string
AssetKind
string
The kind of the asset.
Connection
object
4 properties 1 required
AssetsUsageRefCompute
objectnull
UsageTimesInfo
objectnull
Details about times the asset has been used by workloads, etc.
1 property
ExternalToolInfo
objectnull
Information of the external tool.
2 properties 2 required
ComplianceInfo
objectnull
Compliance of an asset with creation of workloads in a given project.
3 properties
SeccompProfileType
stringnull
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…
HostIpc
booleannull
Whether to enable host IPC. Defaults to false.
AssetClusterStatusIssues
array
ScopeType
string
WorkloadName
string
The name of the workload.
ClusterIdOptional
stringnull
The id of the cluster.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-environment-api-openapi.yml Raw ↑

Other APIs NVIDIA Run:ai publishes across the network.

NVIDIA Run:ai Access Keys API
AE Profile APIs.io
NVIDIA Run:ai Access rules API
AE Profile APIs.io
NVIDIA Run:ai Administrator Command Line Interface API
AE Profile APIs.io
NVIDIA Run:ai AI Applications API
AE Profile APIs.io
NVIDIA Run:ai Applications API
AE Profile APIs.io
NVIDIA Run:ai Clusters API
AE Profile APIs.io
NVIDIA Run:ai Compute API
AE Profile APIs.io
NVIDIA Run:ai ConfigMap API
AE Profile APIs.io
NVIDIA Run:ai Credentials API
AE Profile APIs.io
NVIDIA Run:ai Departments API
AE Profile APIs.io
NVIDIA Run:ai Distributed API
AE Profile APIs.io
NVIDIA Run:ai Distributed Inferences API
AE Profile APIs.io
#Environment
← Back to N APIs
API Details
ID
runai:runai-environment-api
Base URL
https://app.run.ai
Docs
https://run-ai-docs.nvidia.com/api/readme.md
Provider
NVIDIA Run:ai
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=runai-environment-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/runai-environment-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of NVIDIA Run:ai Environment API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.